Skip to main content
GET
/
v1
/
earn
/
auto
/
assets
Get auto earn assets
curl --request GET \
  --url https://api.services.payward.com/v1/earn/auto/assets \
  --header 'api-key: <api-key>' \
  --header 'api-nonce: <api-key>' \
  --header 'api-otp: <api-key>' \
  --header 'api-sign: <api-key>'
{
  "data": [
    {
      "symbol": "ETH",
      "type": "crypto",
      "name": "Ethereum",
      "yield_source": "staking",
      "apy": "3.41",
      "user_cap": "1000"
    },
    {
      "symbol": "DOT",
      "type": "crypto",
      "name": "Polkadot",
      "yield_source": "staking",
      "apy": "12.50"
    }
  ]
}

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
string
header
required
api-otp
string
header
required

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 - 64
page_size
integer<int32>

Maximum number of results to return.

Required range: 1 <= x <= 200

Response

Successful response

data
object[]

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