Skip to main content
GET
Get earn offer by ID

Authorizations

Authorization
string
header
default:criffy_live_your_api_key_here
required

Bearer API key for authenticated /api/v1/* access.

Path Parameters

id
integer
required

Numeric offer identifier.

Response

Earn offer.

id
integer
required
compositeKey
string
required
platform
object | null
required
chain
object | null
required
asset
object | null
required
reward_assets
object[]
required
product_type
string
required
product_name
string
required
duration_days
integer | null
required
apy
string
required

APY percentage serialized as a decimal string. For example, 4.25 means 4.25%.

estimated_apy
string
required

Provider-estimated APY percentage serialized as a decimal string.

estimated_apy_updated_at
string<date-time>
required
tvl
string | null
required

Total value locked in USD when available, serialized as a decimal string.

min_amount
string | null
required
max_amount
string | null
required
available
boolean
required

Runtime availability status for the earn offer. Published offers can be returned when this is false.

available_updated_at
string<date-time>
required

When the earn offer availability status was last refreshed.

updated_at
string<date-time>
required