List activities

Retrieve all activities that match the specified filter criteria.

POST /0/private/ListCustodyActivities

List activities

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/ListCustodyActivities \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "filters": {
    "and": []
  },
  "pagination": {
    "limit": 100,
    "offset": 0
  },
  "orderings": [
    {
      "by": "activity_created_at",
      "direction": "desc"
    }
  ]
}
'

import requests

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

payload = {
    "nonce": 123,
    "filters": { "and": [] },
    "pagination": {
        "limit": 100,
        "offset": 0
    },
    "orderings": [
        {
            "by": "activity_created_at",
            "direction": "desc"
        }
    ]
}
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,
    filters: {and: []},
    pagination: {limit: 100, offset: 0},
    orderings: [{by: 'activity_created_at', direction: 'desc'}]
  })
};

fetch('https://api.kraken.com/0/private/ListCustodyActivities', 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/ListCustodyActivities"

	payload := strings.NewReader("{\n  \"nonce\": 123,\n  \"filters\": {\n    \"and\": []\n  },\n  \"pagination\": {\n    \"limit\": 100,\n    \"offset\": 0\n  },\n  \"orderings\": [\n    {\n      \"by\": \"activity_created_at\",\n      \"direction\": \"desc\"\n    }\n  ]\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))

}

200

{
  "errors": [
    {
      "errorClass": "<string>",
      "type": "<string>",
      "errorMessage": "<string>"
    }
  ],
  "start": 1,
  "total": 1,
  "result": [
    {
      "task": {
        "id": "TDO2CDW6GMSZHC",
        "approval_id": "550e8400-e29b-41d4-a716-446655440000",
        "type": "update_vault",
        "state": "pending",
        "vault_info": {
          "id": "VW44KPQC4C62K6",
          "name": "My Vault",
          "status": "created"
        },
        "payload": {
          "name": "Example Vault name",
          "description": "Example vault description"
        },
        "created_at": "1710877421",
        "updated_at": "1710877421",
        "expires_at": "1710877421",
        "initiator": {
          "full_name": "John Doe",
          "role": "initiator",
          "ip_address": "127.0.0.1",
          "iiban": "AA88 N84G AET3 RAOA"
        }
      },
      "id": "AW44KPQC4C62K6",
      "created_at": "1710877421",
      "type": "created",
      "comment": "My comment",
      "user": {
        "full_name": "John Doe",
        "role": "initiator",
        "ip_address": "127.0.0.1",
        "iiban": "AA88 N84G AET3 RAOA"
      }
    }
  ]
}

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

filters · and · object

Specify a subset of filter items. All filter objects are AND combined. Inside a filter object all properties are OR combined.

Show child attributes

Example:

{ "and": [] }

pagination · object

Define which items will get returned

Show child attributes

orderings · object[]

Specify how to order the returned items. If a column in the orderings list contains null values, these are always sorted to the end.

Show child attributes

Example:

[
  {
    "by": "activity_created_at",
    "direction": "desc"
  }
]

Response

200 - application/json

errors · object[] · required

Show child attributes

start · integer<uint64> · required

Required range: x >= 0

total · integer<uint64> · required

Required range: x >= 0

result · (created · object | review_approved · object | review_denied · object | canceled · object | executed · object | failed · object | expired · object)[] | null

An activity represents an event on a task.

created

review_approved

review_denied

canceled

executed

failed

expired

Show child attributes

Example:

[
  {
    "task": {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "update_vault",
      "state": "pending",
      "vault_info": {
        "id": "VW44KPQC4C62K6",
        "name": "My Vault",
        "status": "created"
      },
      "payload": {
        "name": "Example Vault name",
        "description": "Example vault description"
      },
      "created_at": "1710877421",
      "updated_at": "1710877421",
      "expires_at": "1710877421",
      "initiator": {
        "full_name": "John Doe",
        "role": "initiator",
        "ip_address": "127.0.0.1",
        "iiban": "AA88 N84G AET3 RAOA"
      }
    },
    "id": "AW44KPQC4C62K6",
    "created_at": "1710877421",
    "type": "created",
    "comment": "My comment",
    "user": {
      "full_name": "John Doe",
      "role": "initiator",
      "ip_address": "127.0.0.1",
      "iiban": "AA88 N84G AET3 RAOA"
    }
  }
]