Introducing the Instagram APIRead more →

GitHub README API. Send a repository or its link.

A repository's README text, format and branch. We handle the proxies, blocks and platform changes.

In your agent: GitHub MCP server →

GitHub README API at a glance

Returns the README of a public GitHub repository from its link or owner/name. You get the full text as written (markdown, reStructuredText, AsciiDoc or plain text), its format, its path in the repository, the branch it was read at, and links to its page and the raw file. A repository without a README answers no_readme, so you can tell it from one that doesn't exist.

GET /v1/github/readme

Read the API reference
  • 1 credit per request, $0.75–$1.97 per 1,000 requests
  • 10 typed fields null when unknown
  • url is all it needs, e.g. https://github.com/cli/cli
  • 100 credits free when you sign up, no card, so you can build before you spend

Send one request. Get 10 fields back.

Copy the request in your language, or hand it to your agent. Sign up for an API key and your first 100 credits are free.

$ npm install socialtap
url = https://github.com/cli/cli
GET /v1/github/readmeTry in
const params = new URLSearchParams({
  url: "https://github.com/cli/cli",
});
const res = await fetch(`https://socialtap.dev/v1/github/readme?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);
200 OK · GET https://socialtap.dev/v1/github/readmeLong arrays and strings are shortened here. Real responses are complete.Docs

What you send and what comes back.

The response reference lists every field, its type and when it is null. See the full schema.

  • Null means unknown

    A field GitHub doesn't show is null, never zero or an empty string, so a real zero always means zero.

  • What it accepts

    The repository: its link (github.com/torvalds/linux, or any page under it: its README's page, a file, a folder), owner/name alone (torvalds/linux), a clone link (https://github.com/torvalds/linux.git, git@github.com:torvalds/linux.git), a file on raw.githubusercontent.com, or the API's link (api.github.com/repos/torvalds/linux, api.github.com/repositories/2325298, by the repository's ID).

  • What comes back

    A repository's README as its author wrote it: the markdown (or other markup) text, its format, path and links.

platformstring
Platform that hosts the repository.
repositoryobject
The repository the README belongs to: its full name and page, and its ID when the platform's answer gives it.
urlstring
The README's page on the platform: the file's own page, or the repository's page where the README has none.
raw_urlstring
Link to the file itself, unrendered, that works without a login; null when the platform serves none.
pathstring
The file's path from the repository's root (README.md, docs/README.rst); its last segment is the file's name. Null when the platform does not say which file it is.
refstring
The branch or tag the README was read at (GitHub: the default branch, master or main); null when the platform does not say.
formatstring
The markup the text is written in, which decides how to render it: markdown, rst (reStructuredText), asciidoc, org, text (plain), other. Null when the platform does not say. New values may be added.
textstring
The README's full text as written, in its markup (not rendered to HTML), front matter included; null when the file is empty.

What teams build with the GitHub README API.

  • Feed project documentation to an LLM or search index

  • Summarize what a repository does

  • Check which projects document installation and usage

  • Track README changes on the default branch

Good to know before you build.

  • The README is the file GitHub shows on the repository's page: README.md, README.rst, README or another name, in the root, docs or .github folder. path says which.
  • text is the file as written, not rendered to HTML. Images and links keep the relative paths the author wrote.
  • If GitHub's API refuses, README.md is read from the default branch's raw file. A README by another name is then unavailable, ref is null, and repository.full_name is spelled as you sent it, in lower case.

1 credit per request. Failed requests are free.

Buy credits once and spend them on any endpoint, on any platform.

SourcePrice per successful requestPer 1,000 requests
Platform API api1 credit$0.75–$1.97
Public page page1 credit$0.75–$1.97
  • Cache hits are free.
  • Credits from packs and top-ups never expire.
  • A monthly plan's credits are spent first, and what is left of them ends at each renewal.
  • Prices exclude tax: sales tax is added at checkout where it applies.
  • Outside the US, plans and packs are sold to businesses: checkout asks for your VAT, GST or other business tax ID.

Questions about the GitHub README API.

More in the API reference.

How much does the GitHub README API cost?
A request costs 1 credit. SocialTap credits cost $0.75–$1.97 per 1,000, depending on the plan or pack.

Try it on a link you already have.

Paste it in the playground, or copy the request into your code.

100free credits
  • No credit card
  • Failed requests are free
  • Works on all 276 endpoints
Start for free Read the docs