Get Orders
EndPoint
Header
| Field | Description | Example |
|---|---|---|
X-API-KEY | ApiKey | "HlkcGxbqBeaF76j4rvPaOayfPwnkQ6B6DQ6THZWbvrGxzEdulXQvOKLrRWZLnN" |
Request
| Field | Description | Example |
|---|---|---|
accountId | Account ID | 10010 |
market | (Optional) trading pair | "LRC-ETH" |
start | (Optional) Start time in milliseconds Default : 0L | 1578558098000 |
end | (Optional) End time in milliseconds Default : 0L | 1578558098000 |
side | (Optional) "BUY" or "SELL" | |
status | (Optional) Order status. You can specify one of the following values: Allowable : ['processing', 'processed', 'failed', 'cancelled', 'cancelling', 'expired'] | |
limit | (Optional) Number of records to return, max is 50 | 20 |
offset | (Optional) Number of records to skip Default : 0L | 1 |
orderTypes | request.getOrders.orderTypes Allowable : ['LIMIT_ORDER', 'MAKER_ONLY', 'TAKER_ONLY', 'AMM'] | "transfer,deposit" |
extraOrderTypes | (Optional) can be "TRADITIONAL_ORDER", "STOP_LIMIT", default is "TRADITIONAL_ORDER" | "STOP_LIMIT" |
Response
| Field | Description | Example |
|---|---|---|
totalNum | total number | |
orders | List[Order] |
Model
Order
| Field | Description | Example |
|---|---|---|
hash | Order hash | "0xfb5e711c2f 044e94322ed2 62229cd8f0d0 da00c22e1a00 a0f5d881e45a 38e1cf" |
clientOrderId | Order's client-side ID | "200310143135 081332" |
side | Order's side Allowable : ['SELL', 'BUY'] | "SELL" |
market | Trading pair | "LRC-ETH" |
price | Order price | "0.01987608" |
volumes | OrderVolume, Wraps data regarding the orders volumes (base, quote, and filled.) | "0" |
validity | OrderValidity, Wraps data regarding time validity constraints (since and until) | "{start: 1234, end: 2345}" |
orderType | Whether the order has to be treated as a limit, maker, or taker operation. Allowable : ['LIMIT_ORDER', 'TAKER_ONLY', 'MAKER_ONLY'] | "LIMIT_ORDER" |
tradeChannel | Order channel, can be ORDER_BOOK, AMM_POOL, MIXED Allowable : ['ORDER_BOOK', 'AMM_POOL', 'MIXED'] | "ORDER_BOOK" |
status | Order status Allowable : ['processing', 'processed', 'cancelling', 'cancelled', 'expired', 'waiting'] | "processing" |
storageInfo | (Optional) storage info | |
extraOrderInfo | (Optional) extra order info |
OrderVolumes
| Field | Description | Example |
|---|---|---|
baseAmount | The amount of base tokens involved in the order. | "0" |
quoteAmount | The amount of quote tokens involved in the order. | "0" |
baseFilled | The amount of requested base tokens filled in the order. | "0" |
quoteFilled | The amount of requested quote tokens filled in the order. | "0" |
fee | The amount of quote or base token amount used to pay for the orders fee. Whether this data refers to the base or quote token, one can find out by looking at the orders side | "0" |
OrderValidity
| Field | Description | Example |
|---|---|---|
start | Timestamp from when the order officially becomes valid and fillable | 0 |
end | Timestamp from when the order ceases to be valid and fillable | 0 |
storageInfo
| Field | Description | Example |
|---|---|---|
accountId | account ID | 10110 |
tokenId | token ID | 0 |
storageId | storageId | 1 |
extraOrderInfo
| Field | Description | Example |
|---|---|---|
isTriggered | triggerd or not | false |
stopPrice | stop price | "0.36" |
stopSide | stop side, "GREAT_THAN_AND_EQUAL" or "LESS_THAN_AND_EQUAL" | "GREAT_THAN_AND_EQUAL" |
Last updated