Skip to content
This repository is currently being migrated. It's locked while the migration is in progress.

Commit

Permalink
docs(orders): add returnOrderStatus endpoint (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhustler committed Dec 3, 2018
1 parent 2621021 commit 5464202
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Expand Up @@ -13,6 +13,7 @@ Table of Contents
- [return24Volume](#return24volume)
- [returnOrderBook](#returnorderbook)
- [returnOpenOrders](#returnopenorders)
- [returnOrderStatus](#returnorderstatus)
- [returnTradeHistory](#returntradehistory)
- [returnCurrencies](#returncurrencies)
- [returnBalances](#returnbalances)
Expand Down Expand Up @@ -249,6 +250,8 @@ Sample response:
"market": "ETH_AURA",
"type": "sell",
"orderNumber": 2228127,
"filled": "10000",
"status": "open",
"params": {
"tokenBuy": "0x0000000000000000000000000000000000000000",
"buySymbol": "ETH",
Expand All @@ -270,6 +273,42 @@ Sample response:
]
```

### returnOrderStatus

Returns a single order.

* `orderHash` (string) Required. Example `0x22a9ba7f8dd37ed24ae327b14a8a941b0eb072d60e54bcf24640c2af819fc7ec`.

Sample response:

```js
{
"timestamp": 1516415000,
"orderHash": "0x32858bf5d73f538d83893af18970ebd9bef4ace2df759d2a5ce8c9dbd5fff43f",
"market": "ETH_AURA",
"type": "sell",
"orderNumber": 2228127,
"filled": "10000",
"status": "open",
"params": {
"tokenBuy": "0x0000000000000000000000000000000000000000",
"buySymbol": "ETH",
"buyPrecision": 18,
"amountBuy": "5000000000000000000",
"tokenSell": "0xcdcfc0f66c522fd086a1b725ea3c0eeb9f9e8814",
"sellSymbol": "AURA",
"sellPrecision": 18,
"amountSell": "500000000000000000000",
"expires": 190000,
"nonce": 6,
"user": "0x2db094ffeb85cb09de753846425d4c415cb2c07a"
},
"price": "0.01",
"amount": "500",
"total": "5"
}
```

### returnTradeHistory

Returns a paginated list of all trades for a given market or address, sorted by date.
Expand Down

0 comments on commit 5464202

Please sign in to comment.