AnyMetaGitHubRepository

Get a repository README

Returns the original GitHub README response. JSON content remains Base64-encoded; raw and HTML media types are also supported.

GET/github/repos/{owner}/{repo}/readmeNo authentication required

Path parameters2

Path parameters
Name	Type	Description
`owner`*	`string`	The repository owner login. The value is case-insensitive.
`repo`*	`string`	The repository name without the .git suffix. The value is case-insensitive.

Query parameters
Name	Type	Description
`ref`	`string`	A commit, branch, or tag. Defaults to the repository default branch.

Headers
Name	Type	Description
`Accept`	`string`	Use application/vnd.github+json for metadata, application/vnd.github.raw+json for raw text, or application/vnd.github.html+json for HTML. Default:`"application/vnd.github+json"`
`If-None-Match`	`string`	An ETag for conditional requests.
`If-Modified-Since`	`string`	An HTTP date for conditional requests.

Schemaobject

Additional properties are allowed

typestring

encodingstring

sizeinteger

namestring

pathstring

contentstring

shastring

urlstring

Format: uri

html_urlstring

Format: uri

download_urlstring | nullNullable

Format: uri

The original README response in the requested media type.

Request code examples

curl --globoff 'https://anymeta.top/github/repos/unjs/ungh/readme' \
  --request GET \
  --header 'Accept: application/vnd.github+json'

—

Send a request to see the status code, response time, and body here.