# GitHub Repository README (`github.repository_readme`)

The README of a repository as raw Markdown.

- **Route:** `POST /v1/run/github.repository_readme`
- **Price:** $0.0012 per request ($1.20 per 1,000) · `cost_usd` on every response
- **Source:** GitHub REST API (`github`) · failover: no
- **Measured latency:** not enough calls measured yet
- **Heavy response:** no

## Input

| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
| `owner` | string | yes |  |  |
| `repo` | string | yes |  |  |

## Output (`output` in the run envelope)

| Field | Meaning |
|---|---|
| `readme` | Raw README text (max 300 kB). |

## Example

```bash
curl -s -X POST https://getallapis.com/v1/run/github.repository_readme \
  -H "Authorization: Bearer $GETALLAPIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"owner":"fastapi","repo":"fastapi"}'
```

```python
from getallapis_client import Client
client = Client()  # reads GETALLAPIS_API_KEY
result = client.run('github.repository_readme', {'owner': 'fastapi', 'repo': 'fastapi'})
print(result['cost_usd'], result['output'])
```

```bash
getallapis run github.repository_readme '{"owner":"fastapi","repo":"fastapi"}'
```

Quote first (free, validates input): `POST /v1/quote/github.repository_readme` with the same body.
