Contributors
Access GitHub contributors and repository statistics.
The Contributors API provides access to GitHub contributor information and repository statistics for our organization. This API helps showcase community involvement and track project contributions.
Overview
The Contributors API aggregates data from GitHub to provide insights into:
- Organization-wide contributor statistics
- Individual repository contributors
- Contribution metrics and activity
- Repository health and engagement
This API is particularly useful for:
- Displaying contributor acknowledgments
- Building community dashboards
- Tracking project activity
- Generating contribution reports
Base URL
Authentication
The Contributors API is public and doesn't require authentication. Data is refreshed periodically from GitHub.
Endpoints
GET /api/contributors
Retrieves contributor information across the ByteBrushStudios organization.
Query Parameters
Parameter | Type | Description | Default |
---|---|---|---|
repo | string | Filter by specific repository name | All repositories |
limit | number | Maximum number of contributors (max 100) | 50 |
sort | string | Sort by (contributions , name , recent ) | contributions |
order | string | Sort order (asc or desc ) | desc |
minContributions | number | Minimum contribution count | 1 |
since | string | Include only contributions since date (ISO format) | No limit |
includeStats | boolean | Include detailed statistics | false |
Response Format
Example Usage
Use Cases
Community Dashboard
Repository Analytics
Contribution Recognition
Data Freshness
- Contributor data is refreshed every 6 hours
- Statistics are calculated in real-time
- GitHub API rate limits may affect update frequency
- Cache headers indicate last update time
Rate Limiting
- 100 requests per minute per IP address
- Burst allowance of 20 requests
- No authentication required
Error Handling
Standard HTTP status codes:
200
: Success400
: Bad Request - Invalid parameters404
: Not Found - Repository not found429
: Too Many Requests - Rate limit exceeded503
: Service Unavailable - GitHub API issues
Example error response:
Best Practices
-
Caching
- Cache contributor data locally for frequently accessed information
- Respect the API's cache headers
- Implement proper cache invalidation
-
Performance
- Use pagination for large contributor lists
- Request only necessary data with query parameters
- Implement proper error handling
-
Recognition
- Display contributor information prominently
- Link back to GitHub profiles
- Update contributor displays regularly
-
Privacy
- Respect contributor privacy preferences
- Only display publicly available information
- Provide opt-out mechanisms where appropriate
Support
For questions about the Contributors API, please join our Discord. We can help with:
- API integration
- Data interpretation
- Custom analytics
- Recognition programs
The Contributors API helps build community engagement by recognizing valuable contributions across our projects.
Contribution data is sourced from public GitHub activity and may not reflect all forms of contribution to our projects.