Skip to main content
GET
Get auto earn allocations

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Path Parameters

account_id
string
required

ID of the account to retrieve allocations for. Refers to one of the accounts held by the user the request is acting on behalf of.

Pattern: ^[A-Z0-9]{16}$

Query Parameters

quote_symbol
string

Ticker symbol of the quote asset for converted amounts (e.g. "USD", "EUR"). Defaults to "USD".

Maximum string length: 10
quote_type
string

Type of the quote asset. Only "fiat" is supported. Defaults to "fiat".

Maximum string length: 16
page_token
string

Opaque page token returned by a previous response. Omit to start from the beginning.

Required string length: 1 - 256
page_size
integer<int32>
default:20

Maximum number of results to return.

Required range: 1 <= x <= 25

Response

Successful response

data
object[]
required

Per-asset allocation entries for the requested page.

total_allocated_in_quote
string

Total of all allocations expressed in the quote currency.

next_page_token
string

Opaque token for the next page of results. Absent if there are no more results.

Required string length: 1 - 256
quote_symbol
string

Symbol of the quote asset used for converted amounts (e.g. "USD", "EUR").

quote_type
string

Type of the quote asset (e.g. "fiat").