GitHub Scraper
Get GitHub Activity
Retrieves GitHub profile contribution activity for a user from the public profile activity timeline. Defaults to the current year when year is not provided. Results come back one month at a time in the activity array. Pass cursor from the previous response to page backward through the year.
1 creditNo API key neededEndpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| urlstring · optional | string | optional | GitHub user URL, e.g. https://github.com/kentcdodds. Example: |
| yearnumber · optional | number | optional | When provided, returns profile contribution activity for that year. Defaults to the current year. |
| limitnumber · optional | number | optional | Maximum number of results to return from this request. Leave empty for everything this request returns. This trims the response — it does not fetch more; use the returned cursor for the next batch. The price is the same either way. |
| cursornumber · optional | number | optional | Cursor from the previous response. Pages backward by month through the selected year. |
| handlestring · optional | string | optional | GitHub handle |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"year": {
"type": "number"
},
"month": {
"type": "string"
},
"cursor": {
"type": "number"
},
"message": {},
"activity": {
"type": "array"
},
"username": {
"type": "string"
},
"no_activity": {
"type": "boolean"
},
"limitApplied": {
"type": "boolean",
"description": "True when a Limit trimmed the results; there were more in this response."
}
},
"additionalProperties": true
}
