Skip to main content
GET
Get Auto Earn assets

Authorizations

API-Key
string
header
required

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

API-Sign
string
header
required

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

API-Timestamp
string
header
required

Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.

Query Parameters

country
string
required

ISO 3166-1 alpha-2 country code to filter eligible assets (e.g., "US", "GB"). Required.

Pattern: ^[A-Z]{2}$
page_token
string

Opaque token returned as next_page_token in the previous response. Omit to request the first page.

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

Maximum number of results to return. Ignored when page_token is present.

Required range: 1 <= x <= 25
yield_source
enum<string>[]

Returns only assets backed by the selected yield sources.

Yield source that backs this asset (e.g., "staking").

Available options:
staking,
base_rewards,
opt_in_rewards

Response

Successful response

data
AutoEarnAsset · object[]
required

Auto Earn asset entries for the requested country and page, sorted by APY (highest first), then by symbol, A-Z.

next_page_token
string

Opaque token for retrieving the next page. Absent when there are no more results.

Required string length: 1 - 256