GitHub API
GitHub repository releases
Release history for a repository: tags, notes and downloadable assets.
Endpoint
/v1/github/repo/releaseslive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
url | yes | Repository URL | https://github.com/vercel/next.js |
limit | no | Items per page, max 100 | 25 |
cursor | no | Opaque page cursor from a previous response | 2 |
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 "https://www.monocrawl.com/v1/github/repo/releases?url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js" \ -H "x-api-key: mn_your_key_here"
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/releases?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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/github/repo/releases?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.
{
"success": true,
"platform": "github",
"endpoint": "/v1/github/repo/releases",
"data": {
"_warnings": [],
"count": 0,
"cursor": null,
"dropped": 0,
"items": [
{
"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"
}
]
},
"credits_used": 1,
"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 | Source array was empty in the reviewed captures; item fields remain unspecified. |
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
dropped | number | null | Optional dropped supplied by this operation. Null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].assets | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].author | string | null | Public author information supplied with this record. |
items[].created_at | string | null | Source creation time, not the API retrieval time. |
items[].id | number | null | Source identifier. Preserve the supplied type and exact value. |
items[].is_draft | boolean | null | Optional is draft supplied by this operation. Null means unknown. |
items[].is_prerelease | boolean | null | Optional is prerelease supplied by this operation. Null means unknown. |
items[].name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].notes | string | null | Optional notes supplied by this operation. Null means unknown. |
items[].published_at | string | null | Source publication time when available. |
items[].tag | string | null | Optional tag supplied by this operation. Null means unknown. |
items[].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