This endpoint returns information on a trader's positions' percentile in the unwind queue. It is updated every five seconds.
Authentication is required.
|
Endpoint |
Request Type | Permissible API Keys |
|
/api/v3/unwindqueue
|
GET | Read-only, Read-write, Master |
| Arguments | |||
| none |
| Sample Call |
| https://cryptofacilities.com/derivatives/api/v3/unwindqueue |
| Sample Return if Successful |
| { "result":"success", "serverTime":"2022-06-13T18:01:18.695Z", "queue":[ { "symbol":"PI_XBTUSD", "percentile":100 }, { "symbol":"FI_ETHUSD_220624", "percentile":20 }, { "symbol":"PI_XRPUSD", "percentile":80 } ] } |
|
Field |
Type | Description |
|
result
|
String | Always success |
| serverTime | ISO 8601 datetime | The server date and time |
| queue | list of structures | A list containing structures with information on open positions' percentile rank in the unwind/termination queue |
| symbol | string | The symbol of the futures to which the order refers. |
| percentile | positive integer | The percentile rank of which the trader's position is in the unwind queue (20, 40, 80, or 100) |
| Sample Return if Unsuccessful |
| { "result":"error", "serverTime":"2022-06-08T09:45:53.818Z", "error":"apiLimitExceeded", } |
|
Field |
Type | Description |
|
result
|
String | Always error |
|
serverTime
|
ISO8601 datetime | The server date and time |
|
error
|
string |
The reason the API call failed, either of:
|