get_markets
Retrieve cryptocurrency market data ranked by 24-hour volume with filtering options for specific currencies and sorting capabilities.
Instructions
Get a list of markets. Markets are ranked by their volume over the last 24 hours. Use our filters to get a subset of the markets. This endpoint requires the ultra plan or higher.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| referenceCurrencyUuid | No | UUID of reference currency, in which all the prices are calculated. Defaults to US Dollar Default value: yhjMzLPhuIDl | |
| currencyUuid | No | Filter markets with specific currency as either base or quote. Specifying a currencyUuid will also alter how prices are shown: By default all the markets will show the price of the base in the reference currency (e.g. an ETH/BTC market will show the price of ETH). By specifying a currencyUuid the prices of this currency will always be shown, disregarding whether or not this currency represents the base or the quote in the market (e.g. by specifying BTC as currency, both ETH/BTC as BTC/USD market | |
| toCurrencyUuid | No | Filter markets with specific currency as either base or quote. The toCurrencyUuid will not alter how the prices will be shown, but will keep the base price. This can be combined with the currencyUuid variable to get specific markets. | |
| baseCurrencyUuid | No | Filter markets with specific currency as base | |
| quoteCurrencyUuid | No | Filter markets with specific currency as quote | |
| limit | No | Limit. Used for pagination. Only usable when no filters are applied Default value: 50 Size range: 0-100 | 50 |
| offset | No | Offset. Used for pagination only usable when no filters are applied Default value: 0 | 0 |
| orderBy | No | Sort by either 24h volume or price. Only usable when no filters are applied Default value: 24hVolume Allowed values: 24hVolume price | |
| orderDirection | No | Sort in ascending or descending order. Only usable when no filters are applied. Default value: desc Allowed values: desc asc |