List Earn Assets

List Earn Assets.

Filters: by asset/s, by user. Modifiers: user-preferred currency (quote).

The user can optionally be passed in the request, which shows active asset allocations of the user in the response.

GET /b2b/earn/assets

List Earn Assets

cURL

curl --request GET \
  --url https://nexus.kraken.com/b2b/earn/assets \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>'

200

{
  "result": {
    "assets": {}
  }
}

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.

Headers

Payward-Version · enum<string> · default: 2025-04-15

The target version of the Embed API to use. The API version name is based on the date when the API version was released. For example, the API version 2025-04-15 was released on April 15, 2025.

Available options: 2025-04-15

Query Parameters

assets · string[]

Filter specific assets by asset name. Empty filter returns all assets.

Maximum string length: 16

user · string | null

Filter assets by a specific user. Setting the user has two effects:

1. Active non-zero per-asset allocations of the user are included in the response
2. The list of returned assets is filtered by the user's country/eligibility.

Required string length: 14 - 42

currency · string | null

The user-preferred currency. This field is ignored if user is not set, and it must be set if user is set.

Maximum string length: 16

Response

200

application/json

Response

result · object

Show child attributes