Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Deposit Addresses

List Deposit Addresses

List all deposit addresses, optionally filtering and paging the results.

get/transfer/deposit-addresses

Query parameters

profile_idsstring[]

Optionally filter by the profile IDs associated with the deposit addresses. Limit 100.

identity_idsstring[]

Optionally filter by the Identities associated with the deposit addresses. Limit 100.

idsstring[]

Optionally filter by the UUIDs of the deposit addresses. Limit 100.

ref_idsstring[]

The client-specified IDs provided during transfer creation. Limit 100.

created_at.ltstring date-time

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.ltestring date-time

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.eqstring date-time

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtestring date-time

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtstring date-time

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

limitinteger

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

order'DESC' | 'ASC'

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

order_by'CREATED_AT'

The specific method by which the returned results will be ordered.

page_cursorstring

Optional: Cursor for getting the next page of results.

account_idsstring[]

Optionally filter by the Accounts associated with the deposit address. Limit 100.

networksstring[]

Optionally filter by the networks of the deposit addresses. Limit 100.

Response

A successful response.

next_page_cursorstring

Example response

{
  "items": [
    {
      "id": "34bd61ed-cf0a-4012-8be4-d347667b6154",
      "profile_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
      "customer_id": "9b8c9cba-801e-4418-adc0-ede709df6339",
      "identity_id": "54385e67-d7ef-40d1-b488-ceda6dd9b264",
      "ref_id": "deposit_address_0",
      "crypto_network": "ETHEREUM",
      "address": "0x89205A3A3b2A69De6Dbf7f01ED13B2108B2c43e7",
      "conversion_target_asset": "USD",
      "compatible_crypto_networks": [
        "ETHEREUM"
      ],
      "metadata": {
        "my_id": "4024ee50-eefb-4f2e-85c7-e7899c0b7da5"
      },
      "created_at": "2020-01-17T18:36:08.737Z"
    }
  ]
}