API Reference
Starboard API Reference
Track Twitter influence rankings and social metrics
Overview
The Starboard API provides access to Twitter influence rankings, social metrics, and engagement analytics.
Core Queries
Get Starboard Information
Get Starboard Leaderboard
Search Specific User
Variables:
Field Reference
Starboard Types
Type | Description |
---|---|
TWITTER | Twitter influence tracking |
ONCHAIN | On-chain activity tracking |
Verification Types
Type | Description |
---|---|
blue | Twitter Blue verification |
business | Business account verification |
government | Government account verification |
none | No verification |
StarboardMetricValue Structure
All metrics include comprehensive tracking data:
Field | Type | Description |
---|---|---|
value | String! | Current metric value |
delta | Int! | Absolute change from previous period |
deltaRate | Float! | Percentage change rate |
percentage | Float! | Relative percentage score |
Key Fields
Field | Type | Description |
---|---|---|
basicInfo | StarboardBasicInfo! | Starboard metadata |
leaderboard | StarboardLeaderboard | Rankings and metrics |
xUserProfile | XUserProfile | Twitter user information |
rank | StarboardMetricValue | User’s ranking position |
influenceScore | StarboardMetricValue | User’s influence score |
Integration Patterns
Basic Leaderboard Query
Pagination Pattern
Starboards use nested pagination structure:
User Search
To find a specific Twitter user, use the twitterId
parameter with their Twitter username.
Trend Analysis
Use the change metrics to analyze user performance:
change24H
- 24-hour trendschange7D
- 7-day trendschange30D
- 30-day trends
Each includes value
(current metric) and deltaRate
(percentage change).
Best Practices
- Rate Limiting: Limit monitoring requests to once every 5 minutes
- Pagination: Use forward pagination for efficient data retrieval
- Caching: Cache influence data for 60-300 seconds
- Error Handling: Handle cases where users are not tracked
- Trend Monitoring: Set alerts for significant score changes (±10%)
- User Verification: Check
verifiedType
for account authenticity
Common Errors
Error | Cause | Solution |
---|---|---|
Starboard not found | Invalid starboard ID | Verify starboard ID exists |
Twitter user not found | User not tracked | Check if user is in starboard |
Invalid pagination | Malformed pagination input | Use proper PaginationInput structure |
Rate limit exceeded | Too many requests | Implement retry logic |
Next Steps
- Starboard Integration Guide - Complete implementation patterns
- Authentication - Access token setup
- Common Patterns - Reusable patterns