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-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.

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 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

Auto-earn asset entries for the requested country and page.

next_page_token
string

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

Required string length: 1 - 256