GitHub API

GitHub issue search

Search GitHub issues and pull requests with full advanced-search query syntax.

Endpoint

GET/v1/github/searchlive · proven3 credits
Try in Playground

Parameters

Query parameters

NameRequiredDescriptionExample
queryyesGitHub advanced search query, passed through verbatimrepo:vercel/next.js is:issue is:open label:bug
sortnoSort key, e.g. comments, reactions, created, updatedreactions
ordernoSort direction: asc or descdesc
limitnoItems per page, max 10025
cursornoOpaque page cursor from a previous response2
dry_runnoRead 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/search?query=repo%3Avercel%2Fnext.js%20is%3Aissue%20is%3Aopen%20label%3Abug" \
  -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/search?query=repo%3Avercel%2Fnext.js%20is%3Aissue%20is%3Aopen%20label%3Abug",
  { 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/search?query=repo%3Avercel%2Fnext.js%20is%3Aissue%20is%3Aopen%20label%3Abug",
    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/search",
  "data": {
    "_warnings": [
      "example"
    ],
    "count": 0,
    "cursor": null,
    "dropped": 0,
    "items": [
      {
        "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"
      }
    ],
    "query": "example",
    "total_count": 0
  },
  "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 dataTypeMeaning
_warningsarray | nullOptional warnings supplied by this operation. Null means unknown.
countnumber | nullNumber of records in this response, not lifetime or total matches.
cursorstring | nullOpaque next-page token; pass it back unchanged. Null does not prove complete history.
droppednumber | nullOptional dropped supplied by this operation. Null means unknown.
itemsarray | nullReturned records. Source coverage and completeness vary.
items[].authorstring | nullPublic author information supplied with this record.
items[].author_associationstring | nullOptional author association supplied by this operation. Null means unknown.
items[].bodystring | nullOptional body supplied by this operation. Null means unknown.
items[].commentsnumber | nullOptional comments supplied by this operation. Null means unknown.
items[].created_atstring | nullSource creation time, not the API retrieval time.
items[].idnumber | nullSource identifier. Preserve the supplied type and exact value.
items[].is_pull_requestboolean | nullOptional is pull request supplied by this operation. Null means unknown.
items[].labelsarray | nullOptional labels supplied by this operation. Null means unknown.
items[].numbernumber | nullOptional number supplied by this operation. Null means unknown.
items[].reactionsnumber | nullOptional reactions supplied by this operation. Null means unknown.
items[].statestring | nullOptional state supplied by this operation. Null means unknown.
items[].titlestring | nullSource title when supplied.
items[].updated_atstring | nullOptional updated at supplied by this operation. Null means unknown.
items[].urlstring | nullOriginal source URL when supplied.
querystring | nullOptional query supplied by this operation. Null means unknown.
total_countnumber | nullOptional total count 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

First call in under a minute

1,000 monthly free credits and a ready-made key the moment you sign up. No card.