docs / github

GitHub Developer Data

GitHub Developer Data

base /github/v124 endpoints
post/github/v1/user1 credit

GitHub user profile

ParameterAllowed / rangeDescription
usernamerequiredGitHub user login (the @handle, without the @).
Try in playground →
post/github/v1/user_repos1 credit

repositories owned by a user

ParameterAllowed / rangeDescription
usernamerequiredGitHub user login (the @handle, without the @).
typeoptionalall · owner · member · public · private · forks · sourcesFilter the repository list by relationship/visibility (accepted values vary slightly between user and org endpoints).
sortoptionalcreated · updated · pushed · full_nameField to sort repositories by.
directionoptionalasc · descSort direction.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/user_followers1 credit

followers for a user

ParameterAllowed / rangeDescription
usernamerequiredGitHub user login (the @handle, without the @).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/user_following1 credit

accounts followed by a user

ParameterAllowed / rangeDescription
usernamerequiredGitHub user login (the @handle, without the @).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/user_gists1 credit

public gists for a user

ParameterAllowed / rangeDescription
usernamerequiredGitHub user login (the @handle, without the @).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo1 credit

repository metadata

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
Try in playground →
post/github/v1/repo_issues1 credit

repository issues

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
stateoptionalopen · closed · allFilter issues/pull requests by state.
sinceoptionalOnly records updated at/after this ISO-8601 timestamp.
sortoptionalcreated · updated · commentsField to sort issues by.
directionoptionalasc · descSort direction.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_pulls1 credit

repository pull requests

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
stateoptionalopen · closed · allFilter issues/pull requests by state.
sortoptionalcreated · updated · popularity · long-runningField to sort pull requests by.
directionoptionalasc · descSort direction.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_commits1 credit

repository commits

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
shaoptionalCommit listing: branch name or commit SHA to start from (defaults to the repository's default branch).
pathoptionalOnly commits that touch this file path.
authoroptionalOnly commits by this GitHub login or email.
sinceoptionalOnly records updated at/after this ISO-8601 timestamp.
untiloptionalOnly commits before this ISO-8601 timestamp.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_contributors1 credit

repository contributors

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
anonoptional1 · trueSet to 1/true to also include anonymous contributors.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_releases1 credit

repository releases

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_stargazers1 credit

repository stargazers

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_forks1 credit

repository forks

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
sortoptionalnewest · oldest · stargazers · watchersField to sort forks by.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/repo_languagesfree

repository language byte counts

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
Try in playground →
post/github/v1/repo_contents1 credit

repository content metadata for a path

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
pathoptionalPath to a file or directory inside the repository (omit or '/' for the repository root).
refoptionalBranch, tag, or commit SHA to read from (defaults to the default branch).
Try in playground →
post/github/v1/repo_readme1 credit

repository README metadata/content URL

ParameterAllowed / rangeDescription
ownerrequiredRepository owner — the user or organization login (the part before the slash in owner/repo).
reporequiredRepository name (the part after the slash in owner/repo).
refoptionalBranch, tag, or commit SHA to read from (defaults to the default branch).
Try in playground →
post/github/v1/org1 credit

organization profile

ParameterAllowed / rangeDescription
orgrequiredGitHub organization login.
Try in playground →
post/github/v1/org_repos1 credit

organization repositories

ParameterAllowed / rangeDescription
orgrequiredGitHub organization login.
typeoptionalall · owner · member · public · private · forks · sourcesFilter the repository list by relationship/visibility (accepted values vary slightly between user and org endpoints).
sortoptionalcreated · updated · pushed · full_nameField to sort repositories by.
directionoptionalasc · descSort direction.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/org_members1 credit

public organization members

ParameterAllowed / rangeDescription
orgrequiredGitHub organization login.
filteroptionalall · 2fa_disabledFilter organization members.
roleoptionalall · admin · memberFilter organization members by role.
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
cursoroptionalOpaque pagination cursor (forwarded as ?after=). Use the value from meta.next_cursor; ignored by the search_* actions.
Try in playground →
post/github/v1/search_repos2 credits

search repositories

ParameterAllowed / rangeDescription
qrequiredGitHub search query, including qualifiers (e.g. 'language:python stars:>1000', 'author:torvalds').
sortoptionalstars · forks · help-wanted-issues · updatedField to sort search results by (omit for best-match relevance).
orderoptionaldesc · ascSort direction for search results (only applies when sort is set).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
Try in playground →
post/github/v1/search_users2 credits

search users

ParameterAllowed / rangeDescription
qrequiredGitHub search query, including qualifiers (e.g. 'language:python stars:>1000', 'author:torvalds').
sortoptionalfollowers · repositories · joinedField to sort search results by (omit for best-match relevance).
orderoptionaldesc · ascSort direction for search results (only applies when sort is set).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
Try in playground →
post/github/v1/search_code3 credits

search code (token required by GitHub)

ParameterAllowed / rangeDescription
qrequiredGitHub search query, including qualifiers (e.g. 'language:python stars:>1000', 'author:torvalds').
sortoptionalindexedField to sort search results by (omit for best-match relevance).
orderoptionaldesc · ascSort direction for search results (only applies when sort is set).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
Try in playground →
post/github/v1/search_issues2 credits

search issues and pull requests

ParameterAllowed / rangeDescription
qrequiredGitHub search query, including qualifiers (e.g. 'language:python stars:>1000', 'author:torvalds').
sortoptionalcomments · created · updated · reactionsField to sort search results by (omit for best-match relevance).
orderoptionaldesc · ascSort direction for search results (only applies when sort is set).
page = 1optional1–1-based page number. Page forward with meta.next_page.
per_page = 100optional1–100Results per page (1-100, default 100). Larger values are clamped.
Try in playground →
post/github/v1/rate_limitfree

current token/IP rate-limit status

Try in playground →