Skip to content

Commit

Permalink
Merge pull request ccxt#1591 from mkutny/man
Browse files Browse the repository at this point in the history
Manual: fetchMyTrades: separate section, ordering (aka sorting)
  • Loading branch information
kroitor authored Jan 29, 2018
2 parents 5ce9bed + cfde079 commit ca45d5a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 22 deletions.
45 changes: 26 additions & 19 deletions wiki/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1142,7 +1142,7 @@ The fetchOHLCV method shown above returns a list (a flat array) of OHLCV candles
]
```

## Trades, Orders, Executions, Transactions
## Trades, Executions, Transactions

```diff
- this is under heavy development right now, contributions appreciated
Expand Down Expand Up @@ -1432,24 +1432,6 @@ many exchanges propagate those properties to the orders as well.
exchange.fetchClosedOrders (symbol = undefined, since = undefined, limit = undefined, params = {})
```

#### Trades / Transactions / Fills / Executions

```
- this part of the unified API is currenty a work in progress
- there may be some issues and missing implementations here and there
- contributions, pull requests and feedback appreciated
```

##### Recent Trades

```JavaScript
exchange.fetchMyTrades (symbol = undefined, since = undefined, limit = undefined, params = {})
```

##### Trades By Order Id

```UNDER CONSTRUCTION```

### Order Structure

Most of methods returning orders within ccxt unified API will usually yield an order structure as described below:
Expand Down Expand Up @@ -1581,6 +1563,31 @@ As such, `cancelOrder()` can throw an `OrderNotFound` exception in these cases:
- canceling an already-closed order
- canceling an already-canceled order


## Trades / Transactions / Fills / Executions

```
- this part of the unified API is currenty a work in progress
- there may be some issues and missing implementations here and there
- contributions, pull requests and feedback appreciated
```

A trade is a result of order execution. Note, that orders and trades have 1-n relationship: execution of 1 order may result in several trades.


### Recent Trades

```JavaScript
exchange.fetchMyTrades (symbol = undefined, since = undefined, limit = undefined, params = {})
```

Returns ordered array of trades (most recent trade first).

### Trades By Order Id

```UNDER CONSTRUCTION```


## Funding Your Account

```diff
Expand Down
4 changes: 1 addition & 3 deletions wiki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ Welcome to the ccxt wiki!
- [All Orders](https://github.com/ccxt-dev/ccxt/wiki/Manual#all-orders)
- [Open Orders](https://github.com/ccxt-dev/ccxt/wiki/Manual#open-orders)
- [Closed Orders](https://github.com/ccxt-dev/ccxt/wiki/Manual#closed-orders)
- [Trades / Transactions / Fills / Executions](https://github.com/ccxt-dev/ccxt/wiki/Manual#trades--transactions--fills--executions)
- [Order Structure](https://github.com/ccxt/ccxt/wiki/Manual#order-structure)
- [Placing Orders](https://github.com/ccxt/ccxt/wiki/Manual#placing-orders)
- [Market Orders](https://github.com/ccxt/ccxt/wiki/Manual#market-orders)
- [Limit Orders](https://github.com/ccxt/ccxt/wiki/Manual#limit-orders)
- [Custom Params](https://github.com/ccxt/ccxt/wiki/Manual#custom-order-params)
- [Cancelling Orders](https://github.com/ccxt/ccxt/wiki/Manual#cancelling-orders)
- [Trades / Transactions / Fills / Executions](https://github.com/ccxt-dev/ccxt/wiki/Manual#trades--transactions--fills--executions)
- [Funding Your Account](https://github.com/ccxt/ccxt/wiki/Manual#funding-your-account)
- [Deposit](https://github.com/ccxt/ccxt/wiki/Manual#deposit)
- [Withdraw](https://github.com/ccxt/ccxt/wiki/Manual#withdraw)
Expand All @@ -74,5 +74,3 @@ Welcome to the ccxt wiki!
## API Reference

- API Reference (under construction right now!)


0 comments on commit ca45d5a

Please sign in to comment.