Skip to content

Commit

Permalink
Merge pull request ccxt#1225 from neuhaus/docs1
Browse files Browse the repository at this point in the history
document "active" flag in market structure
  • Loading branch information
kroitor authored Jan 12, 2018
2 parents a39bb91 + 3b631f7 commit f41bffe
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion wiki/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,7 @@ In terms of the ccxt library, every exchange offers multiple markets within itse
'symbol': 'BTC/USD', // uppercase string literal of a pair of currencies
'base': 'BTC', // uppercase string, base currency, 3 or more letters
'quote': 'USD', // uppercase string, quote currency, 3 or more letters
'active': true, // boolean, market status
'precision': { // number of decimal digits "after the dot"
'price': 8, // integer
'amount': 8, // integer
Expand All @@ -383,11 +384,12 @@ Each market is an associative array (aka dictionary) with the following keys:
- `symbol`. An uppercase string code representation of a particular trading pair or instrument. This is usually written as `BaseCurrency/QuoteCurrency` with a slash as in `BTC/USD`, `LTC/CNY` or `ETH/EUR`, etc. Symbols are used to reference markets within the ccxt library (explained below).
- `base`. An uppercase string code of base fiat or crypto currency.
- `quote`. An uppercase string code of quoted fiat or crypto currency.
- `active`. A boolean indicating whether or not trading this market is currently possible.
- `info`. An associative array of non-common market properties, including fees, rates, limits and other general market information. The internal info array is different for each particular market, its contents depend on the exchange.
- `precision`. The amounts of decimal digits accepted in order values by exchanges upon order placement for price, amount and cost.
- `limits`. The minimums and maximums for prices, amounts (volumes) and costs (where cost = price * amount).

*The `precision` and `limits` params are currently under heavy development, some of these fields may be missing here and there until the unification process is complete. This does not influence most of the orders but can be significant in extreme cases of very large or very small orders.*
*The `precision` and `limits` params are currently under heavy development, some of these fields may be missing here and there until the unification process is complete. This does not influence most of the orders but can be significant in extreme cases of very large or very small orders. The `active` flag is not yet supported and/or implemented by all markets.*

## Loading Markets

Expand Down

0 comments on commit f41bffe

Please sign in to comment.