Read as Markdown · Use with an AI agent
Endpoint
GET/v1/github/repolive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
url | no | Repository URL - or pass owner + repo instead | https://github.com/vercel/next.js |
owner | no | Repository owner (used with repo when url is not given) | vercel |
repo | no | Repository name (used with owner when url is not given) | 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 "https://www.monocrawl.com/v1/github/repo" \ -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",
{ 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",
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",
"data": {
"id": 43,
"full_name": "example/project",
"stars": 42,
"watchers": null,
"is_fork": false
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example uses fictional values 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.
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 |
|---|---|---|
id | number | string | null | Source ID. Preserve its original representation; do not coerce a large string ID to a JavaScript number. |
name | string | null | Repository name. |
full_name | string | null | Owner/name identity. |
owner | string | null | Owner login. |
url | string | null | Original source URL when supplied. |
description | string | null | Repository description. |
language | string | null | Primary source language. |
stars | number | null | Stargazers reported by the source; null or absent is unknown, not zero. |
forks | number | null | Forks reported by the source; null or absent is unknown, not zero. |
watchers | number | null | Subscribers, when supplied; not stargazers reported by the source; null or absent is unknown, not zero. |
open_issues | number | null | Source open-issue count, which can include pull requests reported by the source; null or absent is unknown, not zero. |
default_branch | string | null | Default branch name. |
is_fork | boolean | null | Whether this is a fork. |
is_archived | boolean | null | Whether archived. |
pushed_at | string | null | Source publication time, normalized to an ISO date-time when available. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
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