HomeDocumentationAPI Reference
Log In
API Reference

Get Currency

Method Name

public/get_currency

Get currency related risk params, spot price 24hrs ago and lending details for a specific currency.

Parameters

currency  string required
Underlying currency of asset (ETH, BTC, etc)

Response

id  string or integer required

result  object required

result. borrow_apy  string required
Borrow APY (only for USDC)

result. currency  string required
Underlying currency of asset (ETH, BTC, etc)

result. market_type  string required
Market type of the currency
enum ALL SRM_BASE_ONLY SRM_OPTION_ONLY SRM_PERP_ONLY CASH

result. spot_price  string required
Spot price of the currency

result. srm_im_discount  string required
Initial Margin discount for given collateral in Standard Manager (e.g. LTV). Only the Standard Manager supports non-USDC collateral

result. srm_mm_discount  string required
Maintenance Margin discount for given collateral in Standard Manager (e.g. liquidation threshold). Only the Standard Manager supports non-USDC collateral

result. supply_apy  string required
Supply APY (only for USDC)

result. total_borrow  string required
Total collateral borrowed in the protocol (only USDC is borrowable)

result. total_supply  string required
Total collateral supplied in the protocol

result. asset_cap_and_supply_per_manager  object required
Current open interest and open interest cap by manager and asset type

result. instrument_types  array of strings required
Instrument types supported for the currency

result. managers  array of objects required
Managers supported for the currency

result.managers[]. address  string required
Address of the manager

result.managers[]. margin_type  string required
Margin type of the manager
enum PM SM PM2

result.managers[]. currency  string or null
Currency of the manager (only applies to portfolio managers)

result. pm2_collateral_discounts  array of objects required
Initial and Maintenance Margin discounts for given collateral in PM2

result.pm2_collateral_discounts[]. im_discount  string required
Initial Margin discount for given collateral in PM2

result.pm2_collateral_discounts[]. manager_currency  string required
Currency of the manager

result.pm2_collateral_discounts[]. mm_discount  string required
Maintenance Margin discount for given collateral in PM2

result. protocol_asset_addresses  object required
Asset addressses of the derive protocol for given currency

result.protocol_asset_addresses. option  string or null
Address of the Derive protocol option contract (none if not supported)

result.protocol_asset_addresses. perp  string or null
Address of the Derive protocol perp contract (none if not supported)

result.protocol_asset_addresses. spot  string or null
Address of the Derive protocol spot contract (none if not supported)

result.protocol_asset_addresses. underlying_erc20  string or null
Address of the erc20 asset on Derive chain. This is the asset that is deposited into the spot asset

result. erc20_details  object or null
Details of the erc20 asset (if applicable)

result. spot_price_24h  string or null
Spot price of the currency 24 hours ago

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}