# 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.

[Get API key](https://socialtap.dev/signup/?next=%2Fplayground%2F%3Fendpoint%3Dgithub.readme)

[In your agent: **GitHub MCP server** →](https://socialtap.dev/mcp/github/index.md)

## 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](https://socialtap.dev/docs/reference/github/readme/index.md)

- **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`

[Open in playground](https://socialtap.dev/playground/?endpoint=github.readme)

cURL:

```shell
curl -G 'https://socialtap.dev/v1/github/readme' \
  --data-urlencode 'url=https://github.com/cli/cli' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.github.readme.get({ url: "https://github.com/cli/cli" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
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);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/github/readme",
    params={"url": "https://github.com/cli/cli"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("url", "https://github.com/cli/cli")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/github/readme?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [],
    "format": "markdown",
    "path": "README.md",
    "platform": "github",
    "platform_specific": {},
    "raw_url": "https://raw.githubusercontent.com/cli/cli/trunk/README.md",
    "ref": "trunk",
    "repository": {
      "full_name": "cli/cli",
      "id": null,
      "url": "https://github.com/cli/cli"
    },
    "text": "# GitHub CLI\n\nGitHub CLI, or the gh CLI, is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working with `git` and your code.\n\n> [!IMPORTANT]\n> GitHub CLI's PGP signing key rotation for Linux pac…",
    "unknown_fields": [],
    "url": "https://github.com/cli/cli/blob/trunk/README.md"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "github",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 1000,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "repository",
      "id": null,
      "url": "https://github.com/cli/cli"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

Long arrays and strings are shortened here. Real responses are complete.

## What you send and what comes back.

The [response reference](https://socialtap.dev/docs/reference/github/readme/index.md#response) lists every field, its type and when it is `null`. [See the full schema](https://socialtap.dev/resources/readme/index.md).

- ### 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.

- **`platform`string**: Platform that hosts the repository.
- **`repository`object**: The repository the README belongs to: its full name and page, and its ID when the platform's answer gives it.
- **`url`string**: The README's page on the platform: the file's own page, or the repository's page where the README has none.
- **`raw_url`string**: Link to the file itself, unrendered, that works without a login; null when the platform serves none.
- **`path`string**: 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.
- **`ref`string**: The branch or tag the README was read at (GitHub: the default branch, master or main); null when the platform does not say.
- **`format`string**: 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.
- **`text`string**: The README's full text as written, in its markup (not rendered to HTML), front matter included; null when the file is empty.

Live data from 35 platforms.

[TikTok](https://socialtap.dev/apis/tiktok/index.md) · [Instagram](https://socialtap.dev/apis/instagram/index.md) · [Facebook](https://socialtap.dev/apis/facebook/index.md) · [YouTube](https://socialtap.dev/apis/youtube/index.md) · [Reddit](https://socialtap.dev/apis/reddit/index.md) · [Threads](https://socialtap.dev/apis/threads/index.md) · [GitHub](https://socialtap.dev/apis/github/index.md) · [LinkedIn](https://socialtap.dev/apis/linkedin/index.md) · [X](https://socialtap.dev/apis/x/index.md) · [Spotify](https://socialtap.dev/apis/spotify/index.md) · [Hacker News](https://socialtap.dev/apis/hackernews/index.md) · [Amazon](https://socialtap.dev/apis/amazon/index.md) · [Apple Music](https://socialtap.dev/apis/applemusic/index.md) · [Pinterest](https://socialtap.dev/apis/pinterest/index.md) · [Rumble](https://socialtap.dev/apis/rumble/index.md) · [Bluesky](https://socialtap.dev/apis/bluesky/index.md) · [Twitch](https://socialtap.dev/apis/twitch/index.md) · [Telegram](https://socialtap.dev/apis/telegram/index.md) · [TikTok Shop](https://socialtap.dev/apis/tiktokshop/index.md) · [Kwai](https://socialtap.dev/apis/kwai/index.md) · [Snapchat](https://socialtap.dev/apis/snapchat/index.md) · [SoundCloud](https://socialtap.dev/apis/soundcloud/index.md) · [Truth Social](https://socialtap.dev/apis/truthsocial/index.md) · [Kick](https://socialtap.dev/apis/kick/index.md) · [Komi](https://socialtap.dev/apis/komi/page/index.md) · [Lnk.Bio](https://socialtap.dev/apis/linkbio/profile/index.md) · [Linkme](https://socialtap.dev/apis/linkme/profile/index.md) · [Linktree](https://socialtap.dev/apis/linktree/profile/index.md) · [Pillar](https://socialtap.dev/apis/pillar/page/index.md) · [TikTok Ad Library](https://socialtap.dev/apis/tiktok-ad-library/index.md) · [Facebook Ad Library](https://socialtap.dev/apis/facebook-ad-library/index.md) · [Facebook Events](https://socialtap.dev/apis/facebook-events/index.md) · [Facebook Marketplace](https://socialtap.dev/apis/facebook-marketplace/index.md) · [Google Ads Transparency Center](https://socialtap.dev/apis/google-ads-transparency/index.md) · [LinkedIn Ad Library](https://socialtap.dev/apis/linkedin-ad-library/index.md)

## 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.

[Plans and packs](https://socialtap.dev/pricing/index.md) · [How this endpoint is priced](https://socialtap.dev/docs/reference/github/readme/index.md#pricing) · [How credits work](https://socialtap.dev/docs/credits/index.md)

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Platform API `api` | 1 credit | $0.75–$1.97 |
| Public page `page` | 1 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](https://socialtap.dev/docs/reference/github/readme/index.md).

**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.

More GitHub

## GitHub API. 20 endpoints, one key.

- [GitHub Profile API](https://socialtap.dev/apis/github/profile/index.md) (1 credit · `GET /v1/github/profile`)
- [GitHub Followers API](https://socialtap.dev/apis/github/followers/index.md) (1 credit / page · `GET /v1/github/followers`)
- [GitHub Following API](https://socialtap.dev/apis/github/following/index.md) (1 credit / page · `GET /v1/github/following`)
- [GitHub User Search API](https://socialtap.dev/apis/github/search-profiles/index.md) (1 credit / page · `GET /v1/github/search_profiles`)
- [GitHub Contributors API](https://socialtap.dev/apis/github/repository-contributors/index.md) (1 credit / page · `GET /v1/github/repository_contributors`)
- [GitHub Trending Developers API](https://socialtap.dev/apis/github/trending-profiles/index.md) (1 credit / page · `GET /v1/github/trending_profiles`)
- [GitHub Issue Comments API](https://socialtap.dev/apis/github/issue-comments/index.md) (1 credit / page · `GET /v1/github/issue_comments`)
- [GitHub Repository API](https://socialtap.dev/apis/github/repository/index.md) (1 credit · `GET /v1/github/repository`)
- [GitHub Repositories API](https://socialtap.dev/apis/github/repositories/index.md) (1 credit / page · `GET /v1/github/repositories`)
- [GitHub Repository Search API](https://socialtap.dev/apis/github/search-repositories/index.md) (1 credit / page · `GET /v1/github/search_repositories`)
- [GitHub Pinned Repositories API](https://socialtap.dev/apis/github/pinned-repositories/index.md) (1 credit / page · `GET /v1/github/pinned_repositories`)
- [GitHub Trending Repositories API](https://socialtap.dev/apis/github/trending-repositories/index.md) (1 credit / page · `GET /v1/github/trending_repositories`)
- [GitHub Issue API](https://socialtap.dev/apis/github/issue/index.md) (1 credit · `GET /v1/github/issue`)
- [GitHub Issues API](https://socialtap.dev/apis/github/issues/index.md) (1 credit / page · `GET /v1/github/issues`)
- [GitHub Issue Search API](https://socialtap.dev/apis/github/search-issues/index.md) (1 credit / page · `GET /v1/github/search_issues`)
- [GitHub Pull Requests API](https://socialtap.dev/apis/github/profile-pull-requests/index.md) (1 credit / page · `GET /v1/github/profile_pull_requests`)
- [GitHub Activity API](https://socialtap.dev/apis/github/activity/index.md) (1 credit / page · `GET /v1/github/activity`)
- [GitHub Contributions API](https://socialtap.dev/apis/github/contributions/index.md) (1 credit · `GET /v1/github/contributions`)
- [GitHub Releases API](https://socialtap.dev/apis/github/releases/index.md) (1 credit / page · `GET /v1/github/releases`)

## 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](https://socialtap.dev/signup/) [Read the docs](https://socialtap.dev/docs/index.md)

---

[HTML version](https://socialtap.dev/apis/github/readme/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)
