Skip to navigation
API ReferencePublic Data

Get insurance fund

Retrieve the balance of the insurance fund and its change history for the given instrument type.

Query parameters

instTypeenumRequired
Instrument type.
Allowed values:
typeenumOptional

Type of insurance-fund activity.

Allowed values:
ulystringOptional

Underlying, e.g. BTC-USD. Required for FUTURES/SWAP/OPTION when instFamily is not passed.

instFamilystringOptional

Instrument family, e.g. BTC-USD. Required for FUTURES/SWAP/OPTION when uly is not passed.

ccystringOptional
Currency, only applicable to MARGIN.
beforestringOptional
Pagination of data to return records newer than the requested ts, Unix timestamp in milliseconds.
afterstringOptional
Pagination of data to return records earlier than the requested ts, Unix timestamp in milliseconds.
limitstringOptional

Number of results per request. The maximum is 100; the default is 100.

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