Credits API
Credit transactions
Your credit ledger, newest first: grants, purchases, spends and refunds with the balance after each. Cursor-paginated; free to call.
Endpoint
GET/v1/credits/transactionslive · provenfreeParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
limit | no | Rows per page (default 25, max 100) | 25 |
cursor | no | Opaque cursor from the previous page | 18432 |
request_id | no | Only ledger rows tied to this API request id | req_1a2b3c |
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/credits/transactions" \ -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/credits/transactions",
{ 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/credits/transactions",
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": "credits",
"endpoint": "/v1/credits/transactions",
"data": {
"items": [],
"count": 0,
"cursor": null,
"has_more": false
},
"credits_used": 0,
"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: reviewed response shaper. 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 |
|---|---|---|
items | array | null | Nested response fields; optional unless explicitly documented. |
items[].id | string | null | id |
items[].reason | string | null | reason |
items[].ref_type | string | null | ref type |
items[].ref_id | string | null | ref id |
items[].note | string | null | note |
items[].created_at | string | null | created at |
items[].delta | number | null | delta |
items[].balance_after | number | null | balance after |
count | number | null | Nested response fields; optional unless explicitly documented. |
cursor | string | null | Nested response fields; optional unless explicitly documented. |
has_more | boolean | null | Nested response fields; optional unless explicitly documented. |
Core response fields reviewed from the public response shaper. Fields vary by requested options; additive fields remain allowed.
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