> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptorank.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Tickers
> Trading pairs filtered by coin, by exchange, or both.
Available from: Basic
Cost: 1 credit per request
currencyId only — all tickers for a coin across exchanges; exchangeId only — all tickers on an exchange; both — tickers for that coin on that exchange.
## OpenAPI
````yaml https://api.cryptorank.io/v3/documentation-json get /v3/tickers
openapi: 3.0.0
info:
title: Cryptorank API V3
description: >
# Overview
Cryptorank Public API v3 — comprehensive cryptocurrency data for B2B clients
and partners.
Useful Links:
- [API Plans](https://cryptorank.io/public-api)
- [Dashboard](https://cryptorank.io/public-api/dashboard)
# Getting Started
Primary Server URL:
[https://api.cryptorank.io/v3/](https://api.cryptorank.io/v3/)
**Authentication**
Generate an API key in the
[dashboard](https://cryptorank.io/public-api/dashboard) and pass it in the
`X-Api-Key` header.
Keep your keys secret — never commit them to public repositories or expose
them in client-side code.
version: 3.0.0
contact:
name: Cryptorank Team
url: https://cryptorank.io
email: info@cryptorank.io
servers:
- url: https://api.cryptorank.io
security: []
tags: []
paths:
/v3/tickers:
get:
tags:
- Tickers
summary: Tickers
description: >-
**Description**
Trading pairs filtered by coin, by exchange, or both.
> **Note:** currencyId only — all tickers for a coin across exchanges;
exchangeId only — all tickers on an exchange; both — tickers for that
coin on that exchange.
**Access**
- Available from: **Basic**
- Cost: 1 credit per request
operationId: TickersController_getList
parameters:
- name: page
required: false
in: query
description: Page number (1-based). Returns up to 50 items per page.
schema:
minimum: 1
maximum: 1000
default: 1
type: number
- name: currencyId
required: false
in: query
description: >-
Filter by coin id — matches pairs where the coin is the base or the
quote asset. See: [GET
/v3/currencies/map](https://docs.cryptorank.io/api-reference/currencies/currency-map-id-reference).
schema:
type: number
example: 1
- name: exchangeId
required: false
in: query
description: >-
Filter by exchange id. See: [GET
/v3/exchanges/map](https://docs.cryptorank.io/api-reference/exchanges/exchanges-map).
schema:
example: 200
type: number
- name: sortBy
required: false
in: query
description: Sort field.
schema:
default: id
type: string
enum:
- id
- volume
- spread
- lastPrice
- name: sortOrder
required: false
in: query
description: Sort direction.
schema:
default: asc
type: string
enum:
- asc
- desc
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
required:
- data
- meta
- status
properties:
data:
type: array
items:
$ref: '#/components/schemas/TickerItemDto'
meta:
$ref: '#/components/schemas/ListMetaDto'
status:
$ref: '#/components/schemas/ResponseStatusDto'
'400':
description: Request validation failed
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- VALIDATION_ERROR
example: VALIDATION_ERROR
message:
type: string
example: Validation failed
status:
type: number
example: 400
'401':
description: API key is missing or invalid
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- API_KEY_MISSING
- API_KEY_INVALID
example: API_KEY_MISSING
message:
type: string
example: API key is missing
status:
type: number
example: 401
'403':
description: >-
No active subscription, the endpoint is not available in your plan,
or the request goes beyond what your plan allows
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- NO_ACTIVE_SUBSCRIPTION
- ENDPOINT_NOT_AVAILABLE
- PLAN_LIMIT_EXCEEDED
example: NO_ACTIVE_SUBSCRIPTION
message:
type: string
example: No active subscription found
status:
type: number
example: 403
'429':
description: Rate limit or credit limit exceeded
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- RATE_LIMIT_EXCEEDED
- DAILY_CREDITS_EXCEEDED
- MONTHLY_CREDITS_EXCEEDED
example: RATE_LIMIT_EXCEEDED
message:
type: string
example: Rate limit exceeded
status:
type: number
example: 429
'500':
description: Internal server error
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- INTERNAL_ERROR
example: INTERNAL_ERROR
message:
type: string
example: Internal server error
status:
type: number
example: 500
security:
- X-Api-Key: []
components:
schemas:
TickerItemDto:
type: object
properties:
id:
type: number
example: 12345
description: Ticker id — stable identifier of the trading pair; default sort key.
exchangeId:
type: number
example: 200
description: Exchange id.
exchangeName:
type: string
example: Binance
exchangeType:
type: string
example: cex-spot
enum:
- cex-spot
- cex-derivatives
- dex-spot
- dex-derivatives
description: Kind of the market the pair trades on.
baseSymbol:
type: string
example: BTC
description: Symbol of the base asset.
quoteSymbol:
type: string
example: USDT
description: Symbol of the quote asset the price is denominated in.
lastPrice:
type: string
example: '65000.5'
description: Last price in the quote currency.
priceUsd:
type: string
example: '65000.5'
nullable: true
description: >-
Last price normalized to USD. Null when USD normalization is
unavailable.
priceChangePercent24h:
type: number
example: 1.23
nullable: true
description: >-
24h change as a percent (open → last). Null when open price is
unavailable.
high24hUsd:
type: string
example: '65500'
nullable: true
description: 24h high normalized to USD. Null when unavailable.
low24hUsd:
type: string
example: '64000'
nullable: true
description: 24h low normalized to USD. Null when unavailable.
spread:
type: number
example: 0.05
nullable: true
description: >-
Bid-ask spread as a percent: (ask − bid) / ask × 100. Null when
bid/ask is unavailable.
volume24hUsd:
type: string
example: '12500000'
nullable: true
description: 24h trade volume in USD. Null when USD normalization is unavailable.
volumeShare:
type: number
example: 12.34
nullable: true
description: >-
Share of the total 24h volume (percent), ignoring filters: of the
coin when currencyId is set, of the exchange when only exchangeId is
set. Null when neither filter is set.
tradeUrl:
type: string
example: https://www.binance.com/en/trade/BTC_USDT
nullable: true
description: >-
Direct link to the trading pair on the exchange. Null when
unavailable.
required:
- id
- exchangeId
- exchangeName
- exchangeType
- baseSymbol
- quoteSymbol
- lastPrice
- priceUsd
- priceChangePercent24h
- high24hUsd
- low24hUsd
- spread
- volume24hUsd
- volumeShare
- tradeUrl
ListMetaDto:
type: object
properties:
page:
type: number
example: 1
description: Current page number (1-based)
pageSize:
type: number
example: 25
description: >-
Fixed number of items per page for this endpoint (varies per
endpoint)
hasNextPage:
type: boolean
example: true
description: Whether a further page of results exists
required:
- page
- pageSize
- hasNextPage
ResponseStatusDto:
type: object
properties:
usedCredits:
type: number
example: 1
description: Credits charged for this request
timestamp:
type: number
example: 1780000000000
description: Server time of the response. Unix timestamp in milliseconds
required:
- usedCredits
- timestamp
securitySchemes:
X-Api-Key:
name: X-Api-Key
type: apiKey
in: header
````