Skip to main content
GET
Get repository
Representative request: GET /v1/github/repositories/cli/cli. Pass owner and repository name separately; no query options are supported. Read repository fields and availability for native README, latest commit, count precision, root previews and unbilled failures. Every successful uncached response costs 10 credits.

Authorizations

X-API-Key
string
header
required

Path Parameters

owner
string
required
Required string length: 1 - 39
Pattern: ^[A-Za-z0-9-]+$
repo
string
required
Required string length: 1 - 100
Pattern: ^[A-Za-z0-9_.-]+$

Response

Successful Response

Default-branch repository detail and native website sections.

repository
GitHubRepositoryIdentity · object
required
latest_commit
GitHubLatestCommit · object | null
readme
GitHubRepositoryReadme · object | null
files
GitHubRepositoryFile · object[] | null
languages
GitHubRepositoryLanguage · object[] | null
latest_release
GitHubRepositoryRelease · object | null
contributors
GitHubRepositoryAccount · object[] | null
contributors_truncated
boolean | null
dependents
GitHubRepositoryAccount · object[] | null

Dependent owner account preview; not a repository or dependency tree.

dependents_truncated
boolean | null
funding
GitHubRepositoryFunding · object | null
community_files
GitHubCommunityFile · object[] | null
metadata_available
boolean | null

Whether supplemental public REST metadata was available.