Skip to content

Commit

Permalink
Added information about start option
Browse files Browse the repository at this point in the history
  • Loading branch information
abhinavk99 committed Jan 6, 2018
1 parent a75f1ca commit 119ba4e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Get ticker information
**Parameters**

- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options for the request:
- `options.start` **Int?** Return results from rank start and above
- `options.limit` **Int?** Only returns the top limit results
- `options.convert` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Return price, 24h volume, and market cap in terms of another currency
- `options.currency` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Return only specific currency
Expand All @@ -99,6 +100,7 @@ const client = new CoinMarketCap()
client.getTicker({limit: 3}).then(console.log).catch(console.error)
client.getTicker({limit: 1, currency: 'bitcoin'}).then(console.log).catch(console.error)
client.getTicker({convert: 'EUR'}).then(console.log).catch(console.error)
client.getTicker({start: 0, limit: 5}).then(console.log).catch(console.error)
```

### getGlobal
Expand Down

0 comments on commit 119ba4e

Please sign in to comment.