Skip to main content

Get Margin Requirements of All Instrument

API Description​

This endpoint allows querying the tier-wise margin requirements for all symbols, including initial margin, maintenance margin, and maximum leverage.

Note: Margin Requirements of All Instruments data is only available via RESTful API.

Precautions​

  1. This endpoint provides public market information and requires authentication.

Authentication​

This is a public interface and requires authentication. For details on using the RESTful API, please refer to Common > Authentication & Code Snippet > Futures > RESTful Private Interface.

Request Method​

GET

Endpoint​

/v1/perpum/ladders

Frequency limit​

The frequency limit for this interface is 10 requests/2s per user ID and IP. In addition to this per-interface limit, a global rate limit is also enforced.

For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section at click here

Request Parameters​

This interface does not require any request parameter.

Response Parameters​

ParameterTypeDescription
idStringThe unique ID for this margin tier (tier ID).
instrumentStringThe base currency of the instrument. (e.g., BTC, ETH)
ladderIntegerThe tier level, e.g., 1, 2, 3, etc.
lastLadderbooleanTrue : if this is the final tier, false otherwise.
marginKeepRateBigDecimalMaintenance margin rate
maxLeverageIntegerMaximum leverage allowed
marginStartRateBigDecimalInitial margin rate required to open a position.
maxPieceIntegerMaximum contract size

Request Example​

The following Python code shows how to get the tier-wise margin requirements of all instruments.

Note: For a complete code example, please refer to Common > Authentication & Code Snippet > Futures > RRESTful Private Interface.

params = {}
api_url = "/v1/perpum/ladders"
method = "GET"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key) # function FuturesRestfulPrivate() is defined in section (Common > Authentication & Code Snippet > Futures > RESTful Private Interface.)

Note: For a complete Java code example, please refer to Common > Authentication & Code Snippet > Futures > RESTful Private Interface.

Response Example​

The actual response for above Python request included tier-wise margin requirements for all instruments. For brevity, only BTC margin requirements are shown below:

{
'code': 0,
'data': {
'ladderConfig':
[{'ladderList': [{'id': 276,
'instrument': 'BTC',
'ladder': 11,
'lastLadder': False,
'marginKeepRate': 0.5,
'marginStartRate': 1,
'maxLeverage': 1,
'maxPiece': 16399400},
{'id': 275,
'instrument': 'BTC',
'ladder': 10,
'lastLadder': False,
'marginKeepRate': 0.25,
'marginStartRate': 0.5,
'maxLeverage': 2,
'maxPiece': 9820000},
{'id': 274,
'instrument': 'BTC',
'ladder': 9,
'lastLadder': False,
'marginKeepRate': 0.15,
'marginStartRate': 0.333,
'maxLeverage': 3,
'maxPiece': 6420000},
{'id': 273,
'instrument': 'BTC',
'ladder': 8,
'lastLadder': False,
'marginKeepRate': 0.125,
'marginStartRate': 0.25,
'maxLeverage': 4,
'maxPiece': 4820000},
{'id': 272,
'instrument': 'BTC',
'ladder': 7,
'lastLadder': False,
'marginKeepRate': 0.1,
'marginStartRate': 0.2,
'maxLeverage': 5,
'maxPiece': 3820000},
{'id': 271,
'instrument': 'BTC',
'ladder': 6,
'lastLadder': False,
'marginKeepRate': 0.05,
'marginStartRate': 0.1,
'maxLeverage': 10,
'maxPiece': 750000},
{'id': 270,
'instrument': 'BTC',
'ladder': 5,
'lastLadder': False,
'marginKeepRate': 0.025,
'marginStartRate': 0.05,
'maxLeverage': 20,
'maxPiece': 330000},
{'id': 269,
'instrument': 'BTC',
'ladder': 4,
'lastLadder': False,
'marginKeepRate': 0.01,
'marginStartRate': 0.02,
'maxLeverage': 50,
'maxPiece': 100000},
{'id': 268,
'instrument': 'BTC',
'ladder': 3,
'lastLadder': False,
'marginKeepRate': 0.005,
'marginStartRate': 0.01,
'maxLeverage': 100,
'maxPiece': 60000},
{'id': 267,
'instrument': 'BTC',
'ladder': 2,
'lastLadder': False,
'marginKeepRate': 0.004,
'marginStartRate': 0.008,
'maxLeverage': 125,
'maxPiece': 30000},
{'id': 266,
'instrument': 'BTC',
'ladder': 1,
'lastLadder': True,
'marginKeepRate': 0.003,
'marginStartRate': 0.005,
'maxLeverage': 200,
'maxPiece': 20000}],
'name': 'BTC'},{....}...]
}, 'msg': ''}