## github/repo/readme

`GET /v1/github/repo/readme`

The repository's README decoded to markdown, with file metadata.

*GitHub repository README*

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | Repository URL — e.g. `https://github.com/vercel/next.js` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. — e.g. `1` |

**Cost:** 1 credit at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/github/repo/readme?url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "_warnings": [],
  "download_url": "https://example.com/example",
  "markdown": "example",
  "markdown_truncated": false,
  "name": "example",
  "path": "example",
  "repo": "example",
  "sha": "example",
  "size": 0,
  "url": "https://example.com/example"
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/github/repo/readme#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/github/repo/readme.json)