Anton.Docs
Dashboard (opens in a new tab)
How it works

Pagination

Lists page forward with an opaque cursor. There are no page numbers, offsets or totals.

Pass each response's next_cursor back as cursor until has_more is false.

Parameters

ParameterTypeDefaultRangeDescription
limitinteger251 to 100Items per page. A value outside the range, or not an integer, is 400 invalid_limit.
cursorstringnoneThe next_cursor from the previous response. Omit it to start from the first page. A bad or expired cursor is 400 cursor_invalid.
created_afterRFC 3339 UTC timestamp, such as 2026-11-01T00:00:00.000ZnoneOnly items created at or after this time (inclusive). Offered where the endpoint documents it.
created_beforeRFC 3339 UTC timestamp, such as 2026-11-01T00:00:00.000ZnoneOnly items created before this time (exclusive). Offered where the endpoint documents it.

Other filters (status and so on) are documented with their allowed values on each endpoint. An unknown filter value is a 400, and an unknown query parameter is 400 unknown_parameter, never an empty list. A timestamp filter accepts only RFC 3339 in UTC with milliseconds and a Z suffix. Any other form, such as an offset like +02:00 or no milliseconds, is 400 invalid_request with param set to the filter.

Lists are newest first.

Response

Every list has the same envelope, including short ones such as currencies. A list is never a bare array. A few short lists, such as currencies and event types, are complete and not paged: they return everything with has_more false.

JSON
{
  "object": "list",
  "data": [
    { "id": "pay_01JD3X9K2M7Q", "object": "payout", "status": "completed" },
    { "id": "pay_01JD3X8H4N5R", "object": "payout", "status": "processing" }
  ],
  "has_more": true,
  "next_cursor": "eyJpZCI6InBheV8wMUpEM1g4SDRONVIifQ"
}
FieldDescription
objectAlways "list".
dataThe items on this page. An empty page is [].
has_moretrue when more items exist after this page.
next_cursorThe cursor for the next page, or null on the last page. The key is always present.

The last page:

JSON
{
  "object": "list",
  "data": [{ "id": "pay_01JD3X7G3M4Q", "object": "payout", "status": "completed" }],
  "has_more": false,
  "next_cursor": null
}

Iterating through pages

# First page
curl "https://api.antonpayments.dev/v1/payouts?limit=100" \
  -H "Authorization: DPoP $ANTON_ACCESS_TOKEN" \
  -H "DPoP: $DPOP_PROOF"

# Next page: pass the previous response's next_cursor as cursor
curl "https://api.antonpayments.dev/v1/payouts?limit=100&cursor=eyJpZCI6InBheV8wMUpEM1g4SDRONVIifQ" \
  -H "Authorization: DPoP $ANTON_ACCESS_TOKEN" \
  -H "DPoP: $DPOP_PROOF"

Rules

Use the maximum page size

Set limit=100 to cut round trips on large result sets.

Stop when has_more is false

has_more is the termination signal. Do not compare len(data) to limit: the last page can be full.

Cursors are opaque

Pass the exact next_cursor you were given. Do not parse, modify or build one: the format is not part of the API and can change.

Do not keep cursors for long

A bad or expired cursor is 400 cursor_invalid. Start again from the first page.

Something wrong or missing here? Open an issue (opens GitHub in a new tab) ↗