Skip to main content

REST API Settings - Get margin assets

Get margin assets

Written by Albert
Updated over 2 weeks ago

Get margin assets

GET /frontoffice/api/v4/account-margin-settings/assets

Summary

Use this method to retrieve a list of assets that can be used as collateral for margin trading.

Request

No request parameters.

Request example

GET /frontoffice/api/v4/account-margin-settings/assets HTTP/1.1
Host: {host}
Authorization: Bearer JWT
Accept: */*

Response

In case of success, an object will be returned.

Each object contains the following information:

assets array

A list of assets that can be used as a collateral for margin trading.

Each array item contains:

assetId string

The asset identifier.

assetName string

The asset display name.

available decimal string

The available asset balance.

This value is calculated as Total balance – Locked balance.

total decimal string

The overall amount of the asset, including locked funds.

marginRatio decimal string

The percentage of the asset value used as a collateral.

Supports values in the range [0, 1], where 1 represents 100.00%.

isSelected boolean

Indicates whether the asset is selected to be used as collateral.

Can be true only for assets with the marginRatio more than 0.

Response example β€” 200: OK

{
"assets": [
{
"assetId": "btc",
"assetName": "btc",
"available": "0.031",
"total": "0.031",
"marginRatio": "1",
"isSelected": true
},
{
"assetId": "eth",
"assetName": "eth",
"available": "0",
"total": "0",
"marginRatio": "1",
"isSelected": false
}
]
}

Did this answer your question?