# Credits API guide



## Choose a Credits operation



Start with the object your task needs. The groups below use the current catalogue; open an endpoint to check accepted identifiers, filters, price and availability before retrieving.



### Other operations



- [Credit balance](https://www.monocrawl.com/docs/endpoints/credits/balance) — Your current credit balance: credits remaining, lifetime credits, and when the balance last changed. Free to call.

- [Credit transactions](https://www.monocrawl.com/docs/endpoints/credits/transactions) — Your credit ledger, newest first: grants, purchases, spends and refunds with the balance after each. Cursor-paginated; free to call.



## Check fields and collection limits



Use the endpoint’s declared parameters and returned continuation. Filters from another platform do not automatically apply here. Preserve source identifiers, URLs and warnings; a successful page does not establish complete history. Published response schemas identify whether they come from a reviewed shaper or observed response shapes.



Agents can use `get_endpoint` for the current contract and `get_docs` with topic `platforms/credits` to read this page. The [coverage guide](https://www.monocrawl.com/docs/data-availability) explains nulls and partial results, and the [production guide](https://www.monocrawl.com/docs/production-checklist) covers budgets and recovery.



## Endpoint reference

## credits/balance

`GET /v1/credits/balance`

Your current credit balance: credits remaining, lifetime credits, and when the balance last changed. Free to call.

*Credit balance*

| Parameter | Required | Description |
| --- | --- | --- |
| `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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** free — 0 credits.

```bash
curl "https://www.monocrawl.com/v1/credits/balance" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "credits_remaining": 0,
  "credits_lifetime": 0,
  "updated_at": null,
  "connection": {}
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/credits/balance#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/credits/balance.json)


## credits/transactions

`GET /v1/credits/transactions`

Your credit ledger, newest first: grants, purchases, spends and refunds with the balance after each. Cursor-paginated; free to call.

*Credit transactions*

| Parameter | Required | Description |
| --- | --- | --- |
| `limit` | no | Rows per page (default 25, max 100) — e.g. `25` |
| `cursor` | no | Opaque cursor from the previous page — e.g. `18432` |
| `request_id` | no | Only ledger rows tied to this API request id — e.g. `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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `limit`: Bound the returned rows to what your task needs. A smaller limit does not necessarily reduce source calls or price; inspect the quote.
- `cursor`: Continue the same source traversal with the complete returned cursor. Saved-result retrieval and a new source page can have different prices; quote the next call.
- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** free — 0 credits.

```bash
curl "https://www.monocrawl.com/v1/credits/transactions" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "items": [],
  "count": 0,
  "cursor": null,
  "has_more": false
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/credits/transactions#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/credits/transactions.json)