Skip to main content
GET
List APYs

Authorizations

Authorization
string
header
required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

  • clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Response

200 - application/json

Successful Response

asset
string

Asset symbol.

apy
string<decimal>
deprecated

Deprecated: use apy_percentage instead. Annual Percentage Yield (APY) for the asset, expressed as a fraction (e.g. 0.0475 = 4.75%). This represents the gross yield and does not account for any applicable fee discounts.

daily_fee
string<decimal>
deprecated

Deprecated: use daily_fee_percentage instead. Daily fee for the asset, expressed as a percentage string including the % symbol (e.g. 0.00894%).

apy_percentage
string<decimal> | null

Annual Percentage Yield (APY) for the asset expressed as a percentage, without the % symbol (e.g. 4.75 = 4.75%). Same value as apy but multiplied by 100. Null when no APY is available for the asset. This represents the gross yield and does not account for any applicable fee discounts.

daily_fee_percentage
string<decimal>

Daily fee for the asset expressed as a percentage, without the % symbol (e.g. 0.00894). Same value as daily_fee without the trailing %.

protocols
Yield Protocol · object[]

Protocols and networks in which the asset's yield is invested, and the percentage of the asset allocated to each.