## github/repo/dossier

`GET /v1/github/repo/dossier`

One-call project dossier: repo stats, README excerpt, latest releases, top issues and top contributors.

*GitHub repository dossier*

| 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:** 5 credits 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/dossier?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": [
    "example"
  ],
  "contributors": [
    {
      "contributions": 0,
      "handle": "example",
      "id": 0,
      "type": "example",
      "url": "https://example.com/example"
    }
  ],
  "readme": {
    "markdown": "example",
    "truncated": false
  },
  "releases": [
    {
      "assets": [],
      "author": "example",
      "created_at": "2026-09-01T12:00:00Z",
      "id": 0,
      "is_draft": false,
      "is_prerelease": false,
      "name": "example",
      "notes": "example",
      "published_at": "2026-09-01T12:00:00Z",
      "tag": "example",
      "url": "https://example.com/example"
    }
  ],
  "repo": {
    "created_at": "2026-09-01T12:00:00Z",
    "default_branch": "example",
    "description": "example",
    "forks": 0,
    "full_name": "example",
    "homepage": "example",
    "id": 0,
    "is_archived": false,
    "is_fork": false,
    "language": "example",
    "license": "example",
    "name": "example",
    "open_issues": 0,
    "owner": "example",
    "pushed_at": "2026-09-01T12:00:00Z",
    "size_kb": 0,
    "stars": 0,
    "topics": [
      "example"
    ],
    "updated_at": "2026-09-01T12:00:00Z",
    "url": "https://example.com/example",
    "watchers": 0
  },
  "sources": [
    {
      "error": "example",
      "ok": false,
      "source": "example"
    }
  ],
  "top_issues": {}
}
```

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