> ## 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.
# Historical Market Data
> Market state of all tracked coins at a given point in time: price, market cap, volume and circulating supply.
Available from: Advanced
Cost: 1 credit per request
## OpenAPI
````yaml https://api.cryptorank.io/v3/documentation-json get /v3/currencies/historical
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/currencies/historical:
get:
tags:
- Currencies
summary: Historical Market Data
description: >-
**Description**
Market state of all tracked coins at a given point in time: price,
market cap, volume and circulating supply.
> **Note:** `storedTime` is the actual timestamp of the returned values,
which may differ slightly from the requested `date`.
> **Note:** A `date` deeper than your plan allows returns `403
PLAN_LIMIT_EXCEEDED` — Advanced 2y, Pro 5y, Business 10y.
> **Tip:** For the history of a single coin use
[/currencies/:id/sparkline](https://docs.cryptorank.io/api-reference/currencies/price-&-volume-chart).
**Access**
- Available from: **Advanced**
- Cost: 1 credit per request
operationId: CurrenciesController_getHistorical
parameters:
- name: page
required: false
in: query
description: Page number (1-based). Returns up to 100 items per page.
schema:
minimum: 1
maximum: 1000
default: 1
type: number
- name: date
required: true
in: query
description: >-
Point in time to return market data for. Accepted: ISO 8601, bare
date (YYYY-MM-DD), or Unix timestamp in seconds or milliseconds.
Must not be in the future. Bounded by your plan's history limit —
Advanced 2y, Pro 5y, Business 10y.
schema:
example: '2024-01-15'
type: string
- name: currencyIds
required: false
in: query
description: >-
Comma-separated coin IDs, up to 100. See: [GET
/v3/currencies/map](https://docs.cryptorank.io/api-reference/currencies/currency-map-id-reference).
schema:
example: 1,1027
type: string
- name: sortBy
required: false
in: query
description: 'Sort field: `id | rank | price | marketCap | volume24h`.'
schema:
default: rank
type: string
enum:
- id
- rank
- price
- marketCap
- volume24h
- name: sortOrder
required: false
in: query
description: Sort direction. For `rank`, `asc` puts top-1 first.
schema:
default: asc
type: string
enum:
- asc
- desc
- name: convert
required: false
in: query
description: >-
Fiat ISO code for monetary fields (e.g. USD, EUR, RUB, AED). See:
[GET
/v3/fiat/list](https://docs.cryptorank.io/api-reference/fiat/supported-fiat-currency-list).
schema:
default: USD
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
required:
- data
- meta
- status
properties:
data:
type: array
items:
$ref: '#/components/schemas/CurrencyHistoricalItemDto'
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:
CurrencyHistoricalItemDto:
type: object
properties:
id:
type: number
example: 1
description: Unique numeric identifier.
slug:
type: string
example: bitcoin
description: URL-friendly entity slug.
symbol:
type: string
example: BTC
nullable: true
description: Native token symbol (e.g. 'ETH', 'BNB'); null when unknown.
name:
type: string
example: Bitcoin
description: Display name.
price:
type: string
example: '42750.5'
description: Price at the requested date in the convert currency (default USD).
marketCap:
type: string
example: '835000000000'
nullable: true
description: >-
Market cap at the requested date in the convert currency (default
USD); null when unavailable.
volume24h:
type: string
example: '21000000000'
description: >-
24h trading volume at the requested date in the convert currency
(default USD).
volume24hBase:
type: string
example: '490000'
description: >-
24h trading volume at the requested date, denominated in the coin
itself.
circulatingSupply:
type: string
example: '19500000'
nullable: true
description: >-
Circulating supply (tokens in circulation) at the requested date;
null when unavailable.
storedTime:
type: number
example: 1705320000000
description: >-
Actual timestamp of the returned values, Unix epoch milliseconds;
may differ slightly from the requested `date`.
required:
- id
- slug
- symbol
- name
- price
- marketCap
- volume24h
- volume24hBase
- circulatingSupply
- storedTime
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
````