Skip to navigation
API ReferenceAccount

Get PM position limits

Retrieve the maximum position limits for a Portfolio margin account by instrument type and underlying/family.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Query parameters

instTypeenumRequired
Instrument type.
Allowed values:
ulystringOptional

Single underlying or multiple underlyings (no more than 3) separated with comma.

instFamilystringOptional

Single instrument family or multiple (no more than 5) separated with comma.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional