Skip to content

Margin Data

poloniex-sdk edited this page Jan 10, 2023 · 1 revision

Collateral Info

get_collateral_info_all

get_collateral_info_all()

Get collateral information for all currencies.

Returns:

List of json objects with currency collateral information:

[
    {
        'currency': (str) Currency name,
        'collateralRate': (str) Collateral rate of the currency in cross margin,
        'initialMarginRate': (str) Initial margin rate of this currency,
        'maintenanceMarginRate': (str) Maintenance margin rate of this currency
    },
    {...},
    ...
]

Raises:

  • RequestError: An error occurred communicating with trade engine.

Example:

response = client.markets().get_collateral_info_all()
print(response)

get_collateral_info

get_collateral_info(currency)

Get collateral information for a single currency.

Returns:

Json objects with currency collateral information:

{
    'currency': (str) Currency name,
    'collateralRate': (str) Collateral rate of the currency in cross margin,
    'initialMarginRate': (str) Initial margin rate of this currency,
    'maintenanceMarginRate': (str) Maintenance margin rate of this currency
}

Raises:

  • RequestError: An error occurred communicating with trade engine.

Example:

response = client.markets().get_collateral_info('BTC')
print(response)

Borrow Rates Info

get_borrow_rates

get_borrow_rates()

Get borrow rates information for all tiers and currencies.

Returns:

Json objects with borrow rates for currencies:

[
    {
        'tier': (str) Tier for borrow rates,
        'rates': {
            'currency': (str) Currency name,
            'dailyBorrowRate': (str) Borrow rate per day,
            'hourlyBorrowRate': (str) Borrow rate per hour,
            'borrowLimit': (str) Borrow limit amount for the currency
        }
    }
]

Raises:

  • RequestError: An error occurred communicating with trade engine.

Example:

response = client.markets().get_borrow_rates()
print(response)