This endpoint returns allows historical triggers made on an account.
Note:
- This endpoint uses the ‘history’ path instead of ‘derivatives’ and uses the v2 versioning
- The maximum amount of records per response is 1000
Authentication is required.
Endpoint |
Request Type |
Permissible API Keys |
/api/history/v2/triggers |
GET |
Read-write, Master |
Arguments |
||||||||||||||||||||
|
Sample Call |
https://www.cryptofacilities.com/api/history/v2/triggers?since=1606449104000&before=1604937700000&sort=desc Sample Return if Successful { "accountUid": "e695bf7c-c17c-4f82-80e3-3c577b8b5662", "len": 0, "serverTime": "2019-08-24T14:15:22Z", "elements": [ { 'uid': '76f9dec5-019a-4696-975e-cbe460e3e598', 'timestamp': 1606753158105, 'event': { 'OrderTriggerPlaced': { 'order': { 'uid': '07cc67f4-45d6-494b-adac-09b5cbc7e2b5', 'accountId': 105461, 'accountUid': 'e695bf7c-c17c-4f82-80e3-3c577b8b5662', 'tradeable': 'FI_ETHUSD_210326', 'direction': 'Sell', 'quantity': '10000', 'timestamp': 1606753158105, 'limitPrice': '625', 'orderType': 'Limit', 'clientId': '', 'reduceOnly': True, 'triggerOptions': { 'triggerPrice': '626', 'triggerSignal': 'MarkPrice', 'triggerSide': 'Below' }, 'lastUpdateTimestamp': 0 }, 'reason': 'new_user_order' } } } ] }
|
Field |
Type |
Description |
accountUid |
string |
UID for the futures account |
len |
positive integer |
Character length of response |
serverTime |
ISO 8601 datetime |
Server time upon request |
elements |
structure |
|
uid |
string |
The UID associated with the event |
timestamp |
positive integer |
Unix timestamp in milliseconds |
event |
Event description, one of: OrderTriggerActivated OrderTriggerUpdated OrderTriggerCancelled |
|
order |
structure |
structure of order details |
uid |
string |
The UID associated with the trigger |
accountId |
string |
Unique identifier margin account |
accountUid |
string |
UID for the futures account |
tradeable |
string |
The symbol of the Futures. |
direction |
string |
The side associated with the order - buy or sell. |
quantity |
positive float |
The quantity (size) associated with the order. |
timestamp |
positive integer |
Unix timestamp in milliseconds |
limitPrice |
positive float |
The limit price associated with a limit order. |
orderType |
string |
The order type of order attached to trigger order, one of: Limit IoC |
clientId |
string |
The client order id or no value if order does not have one. |
reduceOnly |
boolean |
Is the order a reduce only order or not. |
triggerOptions |
structure |
|
triggerPrice |
positive float |
Price at which the trigger order will activate |
triggerSignal |
string |
Price used to activate the trigger order. One of: MarkPrice, LastPrice, SpotPrice |
triggerSide |
positive float |
Side of the trigger signal that would activate the trigger. Below or Above |
lastUpdateTimestamp |
positive integer |
Unix timestamp in milliseconds |
reason |
string |
new_user_order edited_by user cancelled_by_user |