Skip to main content

List activities

POST 
https://api.kraken.com/0/private/ListCustodyActivities

Retrieve all activities that match the specified filter criteria.

Request​

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    filters object

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

    oneOf
    and object[]required
  • Array [
    • oneOf
    or object[]required
  • Array [
    • oneOf
    oneOf
    type stringrequired

    Possible values: [equals]

    values string[]required

    Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^A[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

    Exact values to match against

    by stringrequired

    Possible values: [id]

  • ]
  • ]
    • pagination object

    Define which items will get returned

    limit uint32required

    Possible values: >= 1 and <= 1000

    Number of records to retrieve

    offset uint32required

    Result Offset

    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.

  • Array [
    • by required

    Possible values: [activity_created_at]

    Column to order by

    • activity_created_at: Order by event creation date
    direction orderDirection (string)

    Possible values: [asc, desc]

    Default value: desc

    Ordering direction

    • asc: Return items in ascending order (first to last)
    • desc: Return items in descending order (last to first)
  • ]

Responses​

Schema
    result object[]nullable
  • Array [
    • task object required

    Task information

    oneOf
    type stringrequired

    Possible values: [update_group_users]

    operations object[]required

    Possible values: >= 1, <= 50

  • Array [
    • oneOf
    type stringrequired

    Possible values: [add]

    item objectrequired

    User operation with extra fields

    user objectrequired

    User to be updated

    iiban stringrequired

    Possible values: >= 14 characters and <= 42 characters

    The IIBAN of the user.

    full_name stringnullable

    The user full name.

    email stringnullable

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$

    The e-mail of the user.

    role object required

    Role that the user holds in the organization.

    oneOf

    string

    Possible values: [admin]

    reason stringnullable

    Possible values: <= 1024 characters

    User facing Reason

    group_id stringrequired

    Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

  • ]
    • oneOf
    state stringrequired

    Possible values: [pending]

    id stringrequired

    Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^A[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

    Id of the activity

    created_at UnixTimestamp (string)required

    Possible values: <= 13 characters

    Time the activity occurred

  • ]
    • errors object[]required
  • Array [
    • severity stringrequired

    Possible values: [E, W]

    API error severity.

    errorClass stringrequired
    type stringrequired
    errorMessage stringnullable
  • ]
    • start uint64required
    total uint64required

Authorization: API-Key

name: API-Keytype: apiKeydescription: The "API-Key" header should contain your API key.in: header
name: API-Signtype: apiKeydescription: Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.in: header
curl -L 'https://api.kraken.com/0/private/ListCustodyActivities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'API-Key: <API_KEY_VALUE>' \
-H 'API-Sign: <API_KEY_VALUE>' \
-d '{
  "nonce": 0,
  "filters": {
    "and": [
      {
        "or": [
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "id"
          },
          {
            "type": "equals",
            "values": [
              "domain",
              "vault"
            ],
            "by": "scope"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "vault_id"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "task_id"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "approval_id"
          },
          {
            "type": "equals",
            "values": [
              "update_withdrawal_addresses",
              "request_withdrawal",
              "create_vault",
              "update_group_users",
              "update_role_users",
              "update_vault_users",
              "update_domain_policies",
              "update_vault_policies",
              "create_users",
              "update_vault",
              "update_status_users",
              "request_transfer_to_spot",
              "create_group",
              "update_permission_users",
              "create_api_users",
              "update_api_users",
              "update_vaults_users",
              "request_allocation",
              "request_deallocation"
            ],
            "by": "task_action"
          },
          {
            "type": "equals",
            "values": [
              "created",
              "review_approved",
              "review_denied",
              "canceled",
              "executed",
              "failed",
              "expired"
            ],
            "by": "activity_action"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "created_at"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "user"
          }
        ]
      }
    ]
  },
  "pagination": {
    "limit": 0,
    "offset": 0
  },
  "orderings": [
    {
      "by": "activity_created_at",
      "direction": "desc"
    }
  ]
}'
Request Collapse all
Base URL
https://api.kraken.com
Auth
Body required
{
  "nonce": 0,
  "filters": {
    "and": [
      {
        "or": [
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "id"
          },
          {
            "type": "equals",
            "values": [
              "domain",
              "vault"
            ],
            "by": "scope"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "vault_id"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "task_id"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "approval_id"
          },
          {
            "type": "equals",
            "values": [
              "update_withdrawal_addresses",
              "request_withdrawal",
              "create_vault",
              "update_group_users",
              "update_role_users",
              "update_vault_users",
              "update_domain_policies",
              "update_vault_policies",
              "create_users",
              "update_vault",
              "update_status_users",
              "request_transfer_to_spot",
              "create_group",
              "update_permission_users",
              "create_api_users",
              "update_api_users",
              "update_vaults_users",
              "request_allocation",
              "request_deallocation"
            ],
            "by": "task_action"
          },
          {
            "type": "equals",
            "values": [
              "created",
              "review_approved",
              "review_denied",
              "canceled",
              "executed",
              "failed",
              "expired"
            ],
            "by": "activity_action"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "created_at"
          },
          {
            "type": "equals",
            "values": [
              "string"
            ],
            "by": "user"
          }
        ]
      }
    ]
  },
  "pagination": {
    "limit": 0,
    "offset": 0
  },
  "orderings": [
    {
      "by": "activity_created_at",
      "direction": "desc"
    }
  ]
}