API reference

GitHub Repository Dossier API

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

Read as Markdown Use with an AI agent

Endpoint

GET/v1/github/repo/dossierlive · proven5 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`url`	yes	Repository URL	`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.	`1`

Examples

Make the request

curl

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"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/github/repo/dossier?url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/github/repo/dossier?url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "github",
  "endpoint": "/v1/github/repo/dossier",
  "data": {
    "_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": {}
  },
  "credits_used": 5,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`_warnings`	`array \| null`	Optional warnings supplied by this operation. Null means unknown.
`contributors`	`array \| null`	Optional contributors supplied by this operation. Null means unknown.
`contributors[].contributions`	`number \| null`	Optional contributions supplied by this operation. Null means unknown.
`contributors[].handle`	`string \| null`	Optional handle supplied by this operation. Null means unknown.
`contributors[].id`	`number \| null`	Source identifier. Preserve the supplied type and exact value.
`contributors[].type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`contributors[].url`	`string \| null`	Original source URL when supplied.
`readme`	`object \| null`	Optional readme supplied by this operation. Null means unknown.
`readme.markdown`	`string \| null`	Optional markdown supplied by this operation. Null means unknown.
`readme.truncated`	`boolean \| null`	Optional truncated supplied by this operation. Null means unknown.
`releases`	`array \| null`	Optional releases supplied by this operation. Null means unknown.
`releases[].assets`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`releases[].author`	`string \| null`	Public author information supplied with this record.
`releases[].created_at`	`string \| null`	Source creation time, not the API retrieval time.
`releases[].id`	`number \| null`	Source identifier. Preserve the supplied type and exact value.
`releases[].is_draft`	`boolean \| null`	Optional is draft supplied by this operation. Null means unknown.
`releases[].is_prerelease`	`boolean \| null`	Optional is prerelease supplied by this operation. Null means unknown.
`releases[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`releases[].notes`	`string \| null`	Optional notes supplied by this operation. Null means unknown.
`releases[].published_at`	`string \| null`	Source publication time when available.
`releases[].tag`	`string \| null`	Optional tag supplied by this operation. Null means unknown.
`releases[].url`	`string \| null`	Original source URL when supplied.
`repo`	`object \| null`	Optional repo supplied by this operation. Null means unknown.
`repo.created_at`	`string \| null`	Source creation time, not the API retrieval time.
`repo.default_branch`	`string \| null`	Optional default branch supplied by this operation. Null means unknown.
`repo.description`	`string \| null`	Source description; null or absent means not supplied.
`repo.forks`	`number \| null`	Optional forks supplied by this operation. Null means unknown.
`repo.full_name`	`string \| null`	Optional full name supplied by this operation. Null means unknown.
`repo.homepage`	`string \| null`	Optional homepage supplied by this operation. Null means unknown.
`repo.id`	`number \| null`	Source identifier. Preserve the supplied type and exact value.
`repo.is_archived`	`boolean \| null`	Optional is archived supplied by this operation. Null means unknown.
`repo.is_fork`	`boolean \| null`	Optional is fork supplied by this operation. Null means unknown.
`repo.language`	`string \| null`	Optional language supplied by this operation. Null means unknown.
`repo.license`	`string \| null`	Optional license supplied by this operation. Null means unknown.
`repo.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`repo.open_issues`	`number \| null`	Optional open issues supplied by this operation. Null means unknown.
`repo.owner`	`string \| null`	Optional owner supplied by this operation. Null means unknown.
`repo.pushed_at`	`string \| null`	Optional pushed at supplied by this operation. Null means unknown.
`repo.size_kb`	`number \| null`	Optional size kb supplied by this operation. Null means unknown.
`repo.stars`	`number \| null`	Optional stars supplied by this operation. Null means unknown.
`repo.topics`	`array \| null`	Optional topics supplied by this operation. Null means unknown.
`repo.updated_at`	`string \| null`	Optional updated at supplied by this operation. Null means unknown.
`repo.url`	`string \| null`	Original source URL when supplied.
`repo.watchers`	`number \| null`	Optional watchers supplied by this operation. Null means unknown.
`sources`	`array \| null`	Optional sources supplied by this operation. Null means unknown.
`sources[].error`	`string \| null`	Optional error supplied by this operation. Null means unknown.
`sources[].ok`	`boolean \| null`	Optional ok supplied by this operation. Null means unknown.
`sources[].source`	`string \| null`	Optional source supplied by this operation. Null means unknown.
`top_issues`	`object \| null`	Optional top issues supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

GitHub Repository Dossier API

Query parameters

Make the request

Response fields and example

More GitHub reference

First call in under a minute