Skip to main content
POST
/
0
/
private
/
ListPrimeSettlementBatches
List Prime Settlement Batches
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
}
'
import requests

url = "https://api.kraken.com/0/private/ListPrimeSettlementBatches"

payload = {
    "nonce": 123,
    "statuses": ["unsettled", "partially_settled"],
    "from": 1700000000000,
    "until": 1700100000000,
    "limit": 20,
    "offset": 0
}
headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    nonce: 123,
    statuses: ['unsettled', 'partially_settled'],
    from: 1700000000000,
    until: 1700100000000,
    limit: 20,
    offset: 0
  })
};

fetch('https://api.kraken.com/0/private/ListPrimeSettlementBatches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kraken.com/0/private/ListPrimeSettlementBatches"

	payload := strings.NewReader("{\n  \"nonce\": 123,\n  \"statuses\": [\n    \"unsettled\",\n    \"partially_settled\"\n  ],\n  \"from\": 1700000000000,\n  \"until\": 1700100000000,\n  \"limit\": 20,\n  \"offset\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
{
  "result": {
    "data": [
      {
        "id": "B_Y7T2LPVX",
        "attributes": {
          "status": "unsettled",
          "confirmed": false,
          "created_at": 1700000000000,
          "trade_count": 5,
          "asset_kind": "currency",
          "updated_at": 1700000100000
        },
        "legs": [
          {
            "status": "unsettled",
            "asset": "BTC",
            "amount": "1.5",
            "can_settle": true,
            "settled_at": 123,
            "latest_spot_transfer": {}
          }
        ],
        "trade_ids": [
          "3f435d6b-62fd-4f26-b1c5-68ef573d93ef",
          "7f6a6d75-6470-4f65-8b24-9858f28ede83"
        ]
      }
    ],
    "pagination": {
      "has_more": true,
      "limit": 123,
      "offset": 123
    }
  },
  "error": [
    "EGeneral:Invalid arguments"
  ]
}
{
  "error": [
    "<string>"
  ]
}

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

Settlement batches retrieved.

Response containing a paginated list of Prime settlement batches.

result
object
required
error
string[]
required

Kraken API error