Skip to main content
POST
List Prime Settlement Batches

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

statuses
enum<string>[]

Filter batches by status. If omitted, all statuses are returned.

Available options:
unsettled,
partially_settled,
settled,
completed
Example:
from
integer<int64>

Unix timestamp in milliseconds. Only return batches created after this time (exclusive).

Example:

1700000000000

until
integer<int64>

Unix timestamp in milliseconds. Only return batches created before or at this time (inclusive).

Example:

1700100000000

limit
integer<int64>
default:50

Maximum number of batches to return. Defaults to 50, maximum 200.

Required range: x <= 200
Example:

20

offset
integer<int64>

Number of batches to skip, for pagination.

Example:

0

Response

Settlement batches retrieved.

Response containing a paginated list of Prime settlement batches.

result
object
required
error
string[]
required

Kraken API error