List Prime Settlement Batches

Retrieves a list of Prime settlement batches, optionally filtered by status and time range. Results are sorted by creation time, most recent first.

API Key Permissions Required: Orders and trades - Query open orders & trades

POST /0/private/ListPrimeSettlementBatches

List Prime Settlement Batches

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/ListPrimeSettlementBatches \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "statuses": [
    "unsettled",
    "partially_settled"
  ],
  "from": 1700000000000,
  "until": 1700100000000,
  "limit": 20,
  "offset": 0
}
'

200

{
  "result": {
    "data": [
      {
        "id": "B_Y7T2LPVX",
        "attributes": {
          "status": "unsettled",
          "confirmed": false,
          "created_at": 1700000000000,
          "trade_count": 5,
          "updated_at": 1700000100000
        },
        "legs": [
          {
            "status": "unsettled",
            "asset": "BTC",
            "amount": "1.5",
            "direction": "incoming",
            "can_settle": true,
            "settled_at": 123,
            "latest_spot_transfer": {}
          }
        ]
      }
    ],
    "pagination": {
      "has_more": true,
      "limit": 123,
      "offset": 123
    }
  },
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

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:

["unsettled", "partially_settled"]

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

200

application/json

Settlement batches retrieved.

Response containing a paginated list of Prime settlement batches.

result · object · required

Show child attributes

error · string[] · required

Kraken API error