API reference

GitHub Repository Top Issues API

The most-reacted open feature request and the most-reacted open complaint for a repository.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/github/repo/top-issueslive · proven3 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/top-issues?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/top-issues?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/top-issues?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/top-issues",
  "data": {
    "_warnings": [
      "example"
    ],
    "repo": "example",
    "sources": [
      {
        "ok": false,
        "source": "example"
      }
    ],
    "top_complaint": {
      "author": "example",
      "author_association": "example",
      "body": "example",
      "comments": 0,
      "created_at": "2026-09-01T12:00:00Z",
      "id": 0,
      "is_pull_request": false,
      "labels": [
        "example"
      ],
      "number": 0,
      "reactions": 0,
      "state": "example",
      "title": "example",
      "updated_at": "2026-09-01T12:00:00Z",
      "url": "https://example.com/example"
    },
    "top_feature_request": {
      "author": "example",
      "author_association": "example",
      "body": "example",
      "comments": 0,
      "created_at": "2026-09-01T12:00:00Z",
      "id": 0,
      "is_pull_request": false,
      "labels": [
        "example"
      ],
      "number": 0,
      "reactions": 0,
      "state": "example",
      "title": "example",
      "updated_at": "2026-09-01T12:00:00Z",
      "url": "https://example.com/example"
    }
  },
  "credits_used": 3,
  "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.
`repo`	`string \| null`	Optional repo supplied by this operation. Null means unknown.
`sources`	`array \| null`	Optional sources 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_complaint`	`object \| null`	Optional top complaint supplied by this operation. Null means unknown.
`top_complaint.author`	`string \| null`	Public author information supplied with this record.
`top_complaint.author_association`	`string \| null`	Optional author association supplied by this operation. Null means unknown.
`top_complaint.body`	`string \| null`	Optional body supplied by this operation. Null means unknown.
`top_complaint.comments`	`number \| null`	Optional comments supplied by this operation. Null means unknown.
`top_complaint.created_at`	`string \| null`	Source creation time, not the API retrieval time.
`top_complaint.id`	`number \| null`	Source identifier. Preserve the supplied type and exact value.
`top_complaint.is_pull_request`	`boolean \| null`	Optional is pull request supplied by this operation. Null means unknown.
`top_complaint.labels`	`array \| null`	Optional labels supplied by this operation. Null means unknown.
`top_complaint.number`	`number \| null`	Optional number supplied by this operation. Null means unknown.
`top_complaint.reactions`	`number \| null`	Optional reactions supplied by this operation. Null means unknown.
`top_complaint.state`	`string \| null`	Optional state supplied by this operation. Null means unknown.
`top_complaint.title`	`string \| null`	Source title when supplied.
`top_complaint.updated_at`	`string \| null`	Optional updated at supplied by this operation. Null means unknown.
`top_complaint.url`	`string \| null`	Original source URL when supplied.
`top_feature_request`	`object \| null`	Optional top feature request supplied by this operation. Null means unknown.
`top_feature_request.author`	`string \| null`	Public author information supplied with this record.
`top_feature_request.author_association`	`string \| null`	Optional author association supplied by this operation. Null means unknown.
`top_feature_request.body`	`string \| null`	Optional body supplied by this operation. Null means unknown.
`top_feature_request.comments`	`number \| null`	Optional comments supplied by this operation. Null means unknown.
`top_feature_request.created_at`	`string \| null`	Source creation time, not the API retrieval time.
`top_feature_request.id`	`number \| null`	Source identifier. Preserve the supplied type and exact value.
`top_feature_request.is_pull_request`	`boolean \| null`	Optional is pull request supplied by this operation. Null means unknown.
`top_feature_request.labels`	`array \| null`	Optional labels supplied by this operation. Null means unknown.
`top_feature_request.number`	`number \| null`	Optional number supplied by this operation. Null means unknown.
`top_feature_request.reactions`	`number \| null`	Optional reactions supplied by this operation. Null means unknown.
`top_feature_request.state`	`string \| null`	Optional state supplied by this operation. Null means unknown.
`top_feature_request.title`	`string \| null`	Source title when supplied.
`top_feature_request.updated_at`	`string \| null`	Optional updated at supplied by this operation. Null means unknown.
`top_feature_request.url`	`string \| null`	Original source URL when supplied.

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 Top Issues API

Query parameters

Make the request

Response fields and example

More GitHub reference

First call in under a minute