# GitHub Repository Readme

Returns the README of a repository at an optional ref: its name, path, html url, raw url, size and encoding, plus the decoded content as plain text. A repository without a README returns 404.

- **Documentation:** [https://scrappa.co/docs/github-api/github_repository_readme](https://scrappa.co/docs/github-api/github_repository_readme)
- **API group:** GitHub API
- **Endpoint:** `GET https://scrappa.co/api/github/repository/readme`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `owner` | string | Yes | Repository owner login or organization, e.g. laravel. |
| `repo` | string | Yes | Repository name without the owner, e.g. framework. |
| `ref` | string | No | Branch, tag or commit sha. Defaults to the repository default branch where GitHub allows it. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/github/repository/readme?owner=laravel&repo=framework"
```

## Example response

```json
{
    "search_parameters": {
        "engine": "github_repository_readme",
        "owner": "laravel",
        "repo": "framework"
    },
    "name": "README.md",
    "path": "README.md",
    "html_url": "https://github.com/laravel/framework/blob/13.x/README.md",
    "size": 4096,
    "content": "# Laravel\n\nThe Laravel Framework."
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter failed validation. |
| 404 | Not Found | GitHub has no public resource at that address. For a repository this also covers a private or renamed repository, which is indistinguishable anonymously. |
| 503 | GitHub Upstream Unavailable | The upstream service is temporarily unavailable. Please retry shortly. |
| 500 | Parser Drift | GitHub returned a response shape this parser does not recognise. The incident has been reported; retrying will return the same result. |
| 406 | Not Acceptable Upstream | GitHub has no JSON representation for this route, or rejected the request headers. Never charged. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)