> ## 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.
# Currency Profile
> Returns a coin's profile: identity, current price snapshot.
Available from: Sandbox
Cost: 1 credit per request
Asset classification:
* coin — native asset of its own blockchain (BTC, ETH, SOL)
* token — asset issued via smart contract on an existing chain (ERC-20, SPL)
* etf — exchange-listed fund tracking underlying asset(s); no chain, no on-chain contract; excluded from ranked coin lists
* leveraged-token — tokenized leveraged product (e.g. BTC3L/BTC3S); has on-chain contract address; issued by exchanges
* fiat — government-issued currency (USD, EUR); price/quote reference only, not tradable crypto
* no-token — tracked project without a launched token yet; no symbol/price
* derivative — primarily a futures instrument; markets page defaults to Futures tab (legacy, rarely used)
## OpenAPI
````yaml https://api.cryptorank.io/v3/documentation-json get /v3/currencies/{id}
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/{id}:
get:
tags:
- Currencies
summary: Currency Profile
description: >-
**Description**
Returns a coin's profile: identity, current price snapshot.
> **Note:** Asset classification:
- coin — native asset of its own blockchain (BTC, ETH, SOL)
- token — asset issued via smart contract on an existing chain (ERC-20,
SPL)
- etf — exchange-listed fund tracking underlying asset(s); no chain, no
on-chain contract; excluded from ranked coin lists
- leveraged-token — tokenized leveraged product (e.g. BTC3L/BTC3S); has
on-chain contract address; issued by exchanges
- fiat — government-issued currency (USD, EUR); price/quote reference
only, not tradable crypto
- no-token — tracked project without a launched token yet; no
symbol/price
- derivative — primarily a futures instrument; markets page defaults to
Futures tab (legacy, rarely used)
**Access**
- Available from: **Sandbox**
- Cost: 1 credit per request
operationId: CurrenciesController_getById
parameters:
- name: id
required: true
in: path
description: Numeric coin id.
schema:
example: 1
type: integer
- name: convert
required: false
in: query
description: Fiat currency for price/market-cap conversion (default USD).
schema:
default: USD
type: string
enum:
- EUR
- USD
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
required:
- data
- status
properties:
data:
$ref: '#/components/schemas/CurrencyProfileDto'
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
'404':
description: Currency not found
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
enum:
- NOT_FOUND
example: NOT_FOUND
message:
type: string
example: Resource not found
status:
type: number
example: 404
'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:
CurrencyProfileDto:
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 for assets without a
token.
name:
type: string
example: Bitcoin
description: Display name.
rank:
type: number
example: 1
nullable: true
description: CryptoRank rank. Null when unranked.
type:
type: string
example: coin
description: >-
Asset classification:
- `coin` — native asset of its own blockchain (BTC, ETH, SOL)
- `token` — issued via smart contract on an existing chain (ERC-20,
SPL)
- `etf` — exchange-listed fund tracking an underlying asset;
excluded from ranked coin lists
- `leveraged-token` — tokenized leveraged product (e.g. BTC3L/BTC3S)
- `fiat` — government-issued currency (USD, EUR); price reference
only, not tradable crypto
- `no-token` — tracked project without a launched token yet
- `derivative` — primarily a futures instrument
lifecycle:
type: string
enum:
- scheduled
- funding
- crowdsale
- traded
- inactive
- unknown
example: traded
description: >-
Lifecycle stage: `traded` (live market), `crowdsale` (active
ICO/IDO), `funding` (raising), `scheduled` (announced TGE),
`inactive` (not trading), `unknown`. Market fields are null unless
`traded`.
category:
nullable: true
description: Coin category (always single); null when the coin has none.
type: object
allOf:
- $ref: '#/components/schemas/CurrencyCategoryDto'
tags:
description: Coin tags / sub-categories (can be multiple); empty array when none.
type: array
items:
$ref: '#/components/schemas/CurrencyTagItemDto'
imageUrl:
type: string
example: https://images.cryptorank.io/coins/150x150.bitcoin1524754012028.png
nullable: true
description: Coin logo image URL, 150×150. Null when no image is available.
description:
type: string
nullable: true
description: Full project description, in English. Null when none.
listingDate:
type: string
example: '2009-01-03T00:00:00.000Z'
nullable: true
description: First exchange listing date, ISO 8601. Null when unknown.
links:
description: Related links — website, whitepaper, github, socials, etc.
type: array
items:
$ref: '#/components/schemas/CurrencyLinkDto'
price:
type: string
example: '65000.5'
nullable: true
description: >-
Price in the requested `convert` currency (USD by default). Null
when the coin is not actively traded.
pricePercentChange:
description: Price change over multiple periods, %.
allOf:
- $ref: '#/components/schemas/PercentChangeDto'
volume24h:
type: string
example: '32000000000'
nullable: true
description: >-
24h trading volume, in the requested `convert` currency (USD by
default). Null when the coin is not actively traded.
marketCap:
type: string
example: '1280000000000'
nullable: true
description: >-
Market cap, in the requested `convert` currency (USD by default).
Null when unavailable or the coin is not actively traded.
volMcapRatio:
type: number
example: 0.025
nullable: true
description: >-
Volume to market-cap ratio. Null when market cap is unavailable or
zero, or the coin is not actively traded.
volatility:
type: number
example: 3.5
nullable: true
description: >-
30-day historical price volatility, % per day (not annualized). E.g.
3.5 = ±3.5% average daily move. Null when the coin is not actively
traded.
high24hUsd:
type: string
example: '65500'
nullable: true
description: >-
24h high price, USD (always USD — not affected by `convert`). Null
when the coin is not actively traded.
low24hUsd:
type: string
example: '64000'
nullable: true
description: >-
24h low price, USD (always USD — not affected by `convert`). Null
when the coin is not actively traded.
fullyDilutedValuation:
type: string
example: '1300000000000'
nullable: true
description: >-
Fully diluted valuation (FDV), in the requested `convert` currency
(USD by default). Null when unavailable or the coin is not actively
traded.
circulatingPercent:
type: number
example: 92.5
nullable: true
description: >-
Circulating supply as percent of total supply. Null when total
supply is unknown or the coin is not actively traded.
circulatingSupply:
type: string
example: '19700000'
nullable: true
description: >-
Circulating supply — tokens currently in circulation. Null when
unavailable or the coin is not actively traded.
totalSupply:
type: string
example: '21000000'
nullable: true
description: >-
Total supply — issued minus burned, excluding not-yet-emitted
tokens. Null when unavailable.
maxSupply:
type: string
example: '21000000'
nullable: true
description: Max supply ever to exist. Null when uncapped or unknown.
required:
- id
- slug
- symbol
- name
- rank
- type
- lifecycle
- category
- tags
- imageUrl
- description
- listingDate
- links
- price
- pricePercentChange
- volume24h
- marketCap
- volMcapRatio
- volatility
- high24hUsd
- low24hUsd
- fullyDilutedValuation
- circulatingPercent
- circulatingSupply
- totalSupply
- maxSupply
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
CurrencyCategoryDto:
type: object
properties:
id:
type: number
example: 7
slug:
type: string
example: smart-contracts
name:
type: string
example: Smart Contracts
required:
- id
- slug
- name
CurrencyTagItemDto:
type: object
properties:
id:
type: number
example: 12
slug:
type: string
example: defi
name:
type: string
example: DeFi
required:
- id
- slug
- name
CurrencyLinkDto:
type: object
properties:
type:
type: string
example: web
description: >-
Link kind. Common values: `web`, `whitepaper`, `github`, `twitter`,
`discord`, `telegram`, `reddit`, `medium`, `youtube`, `gitbook`,
`farcaster`. Other values may appear over time.
url:
type: string
example: https://bitcoin.org
required:
- type
- url
PercentChangeDto:
type: object
properties:
h24:
type: number
example: 1.23
nullable: true
description: Price change over the last 24 hours, %. Null when unavailable.
d7:
type: number
example: -4.56
nullable: true
description: Price change over the last 7 days, %. Null when unavailable.
d30:
type: number
example: 12.34
nullable: true
description: Price change over the last 30 days, %. Null when unavailable.
m3:
type: number
example: 8.9
nullable: true
description: >-
Price change over the last ~3 months (≈90 days), %. Null when
unavailable.
ytd:
type: number
example: 50.12
nullable: true
description: Price change year-to-date, %. Null when unavailable.
required:
- h24
- d7
- d30
- m3
- ytd
securitySchemes:
X-Api-Key:
name: X-Api-Key
type: apiKey
in: header
````