Endpoints
1 endpoint returns contribution calendars on GitHub.
Schema
Every endpoint above returns this object as data. The standard meta comes with every response.
platformstringPlatform ID (github, …).
urlstring uriThe public page that shows this calendar: the account's page, with the period selected where the platform links one (GitHub's year links).
accountobjectThe account whose contributions these are; at least its username.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
yearintegernullableThe calendar year the period is, when it is one (January 1 to December 31, cut at today for the current year); null when the period is the trailing twelve months.
start_datestring dateFirst day of the period, YYYY-MM-DD (days[0].date).
end_datestring dateLast day of the period, inclusive, YYYY-MM-DD (the last of days[]); today when the period runs to now: days to come are never listed.
daysobject[]Every day of the period, oldest first, one per date from start_date to end_date: days without contributions included, with a count of 0.
ShowHide 3 child fields
datestring dateThe day, YYYY-MM-DD, as the platform buckets contributions (GitHub: UTC).
levelintegernullableThe shade the platform paints the day, 0 (no contributions) to 4 (its busiest), as it computes it; null when it shows none.
metricsobjectThe day's counts; null = the platform did not say, 0 = none.
ShowHide 1 child field
contribution_countintegernullableContributions that day as the platform counts them (GitHub: commits, issues, pull requests, reviews, and private ones when the account shows them); 0 when none.
metricsobjectThe period's totals; null = the platform did not say.
ShowHide 1 child field
contribution_countintegernullableContributions over the whole period, the sum of days[].metrics.contribution_count.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
githubobjectnullableA GitHub calendar's own fields: its activity overview.
ShowHide 4 child fields
commit_percentintegernullableShare of the period's contributions that are commits, 0 to 100, as GitHub's activity overview rounds it; null when the account hides its overview.
issue_percentintegernullableShare that are issues opened, 0 to 100; null when the account hides its overview.
pull_request_percentintegernullableShare that are pull requests opened, 0 to 100; null when the account hides its overview.
code_review_percentintegernullableShare that are pull request reviews, 0 to 100; null when the account hides its overview.
approximate_fieldsstring[]JSON paths of values rounded or capped by the platform. [] when all exact (every platform's counts are exact today).
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none; days always lists the period, so always [].
Item errors
Besides the request-level errors every endpoint can return, contribution calendar endpoints return:
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
not_found | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |
private_or_unavailable | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |