Skip to main content
GET
List upcoming Auto Earn rewards

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-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42

Query Parameters

quote_symbol
string
default:USD

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

Maximum string length: 10
quote_type
string
default:fiat

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

Maximum string length: 16
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

Response

Successful response

data
AutoEarnUpcomingReward · object[]
required

Upcoming reward per asset for the requested page, sorted by symbol, A-Z.

quote_symbol
string
required

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

quote_type
string
required

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

next_reward_date
string<date-time>

Earliest payout date among the assets with a pending reward. Covers every asset, not just this page, so it reads the same on every page. An asset can pay later than this date, and its amount is for that later payout. Absent if no reward is pending.

next_page_token
string

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

Required string length: 1 - 256