# GitHub README Fetcher

> GitHub README Fetcher is a paid API for AI agents from intel.rallylive.ca, paid per call via x402, $0.01/call, status unknown (last checked 2026-09-14).

Fetches the raw README text of any GitHub repository, returning the markdown content (up to 20k chars), matched filename, branch, headings list, content length, and raw URL.

## Facts

- Endpoint: GET https://intel.rallylive.ca/dev/github-readme
- Price: $0.01/call
- Payment: x402
- Status: unknown
- Last checked: 2026-09-14
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/github-readme-fetcher-2f38929b
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_9F5xh1bNi24GUe48MBbgU

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability github-readme-fetcher-2f38929b
```

Example prompt: Can you fetch the README from the GitHub repository at https://github.com/openai/openai-python and show me the headings and the full markdown text?

## When to prefer this

Use this endpoint when an agent needs fast, structured comprehension of a GitHub repository's README without cloning the repo or calling the GitHub API directly. Ideal for coding agents, documentation scanners, or dependency analyzers that need the project description, setup instructions, and documentation structure in a single lightweight call. Prefer this over generic web scrapers when the target is specifically a GitHub README, as it handles branch detection and common filename variants automatically.

## Known failure modes

- Repository not found or is private — returns an error indicating the repo could not be accessed
- No recognized README file exists in the repository — returns an error with no match
- Repository has a README but it exceeds 20k characters — content is truncated at 20,000 chars
- Invalid or malformed repository URL provided — returns a validation error
- GitHub rate limits or network issues — returns a timeout or upstream error

## How this service works

README of a GitHub repository as plain text (markdown kept, up to 20k chars): tries the default branch and common README filenames, reports which file and branch matched, length, headings list, and the raw URL. Fast repo comprehension for coding agents. $0.01 per repo.

## Output

Returns the repository's README as plain markdown text (up to 20,000 characters), along with the matched branch name, README filename (e.g. README.md), a list of headings extracted from the content, total character length, and the raw file URL on GitHub.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "required": [
  "input"
 ],
 "properties": {
  "input": {
   "type": "object",
   "required": [
    "type",
    "method"
   ],
   "properties": {
    "type": {
     "type": "string",
     "const": "http"
    },
    "method": {
     "enum": [
      "GET"
     ],
     "type": "string"
    },
    "queryParams": {
     "type": "object",
     "properties": {}
    }
   },
   "additionalProperties": false
  },
  "output": {
   "type": "object",
   "required": [
    "type"
   ],
   "properties": {
    "type": {
     "type": "string"
    },
    "example": {
     "type": "object"
    }
   }
  }
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/github-readme-fetcher-2f38929b/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from intel.rallylive.ca](https://www.zero.xyz/host/intel.rallylive.ca/llms.txt)