HomeDocumentationAPI Reference
Log In
API Reference

Get Assets

Method Name

public/get_assets

Get all assets for a given currency and type

Parameters

asset_type  string required
Asset type
enum erc20 option perp

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

expired  boolean required
If True: include expired assets

Response

id  string or integer required

result  array of objects required

result[]. address  string required
On-chain address of Asset.sol contract

result[]. asset_id  string required
Asset ID of the created asset

result[]. asset_name  string required
Asset name

result[]. asset_type  string required
erc20, option, or perp
enum erc20 option perp

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

result[]. erc20_details  object or null required
ERC20-specific details

result[].erc20_details. decimals  integer required
Number of decimals of the underlying on-chain ERC20 token

result[].erc20_details. borrow_index  string
Latest borrow index as per CashAsset.sol implementation

result[].erc20_details. supply_index  string
Latest supply index as per CashAsset.sol implementation

result[].erc20_details. underlying_erc20_address  string
Address of underlying on-chain ERC20 (not V2 asset)

result[]. is_collateral  boolean required
If True: use as collateral in margin calculations

result[]. is_position  boolean required
If True: treat as position in margin calculations

result[]. option_details  object or null required
Option-specific details

result[].option_details. expiry  integer required
Unix timestamp of expiry date (in seconds)

result[].option_details. index  string required
Underlying settlement price index

result[].option_details. option_type  string required
enum C P

result[].option_details. strike  string required

result[].option_details. settlement_price  string or null
Settlement price of the option

result[]. perp_details  object or null required
Perp-specific details

result[].perp_details. aggregate_funding  string required
Latest aggregated funding as per PerpAsset.sol

result[].perp_details. funding_rate  string required
Current hourly funding rate as per PerpAsset.sol

result[].perp_details. index  string required
Underlying spot price index for funding rate

result[].perp_details. max_rate_per_hour  string required
Max rate per hour as per PerpAsset.sol

result[].perp_details. min_rate_per_hour  string required
Min rate per hour as per PerpAsset.sol

result[].perp_details. static_interest_rate  string required
Static interest rate as per PerpAsset.sol

result[]. sub_id  string required
SubId identifier used in Asset.sol

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}