> ## 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.
# Exchange Profile
> Full profile of a single exchange.
Available from: Basic
Cost: 1 credit per request
## OpenAPI
````yaml https://api.cryptorank.io/v3/documentation-json get /v3/exchanges/{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/exchanges/{id}:
get:
tags:
- Exchanges
summary: Exchange Profile
description: |-
**Description**
Full profile of a single exchange.
**Access**
- Available from: **Basic**
- Cost: 1 credit per request
operationId: ExchangesController_getById
parameters:
- name: id
required: true
in: path
description: Exchange ID. Resolve via /exchanges/map
schema:
type: integer
minimum: 1
example: 200
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
required:
- data
- status
properties:
data:
$ref: '#/components/schemas/ExchangeProfileDto'
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: Exchange 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:
ExchangeProfileDto:
type: object
properties:
id:
type: number
example: 1
description: Unique numeric identifier.
slug:
type: string
example: binance
description: URL-friendly entity slug.
name:
type: string
example: Binance
description: Display name.
type:
type: string
enum:
- cex-spot
- cex-derivatives
- dex-spot
- dex-derivatives
example: cex-spot
description: Exchange type.
imageUrl:
type: string
example: https://images.cryptorank.io/exchanges/150x150.binance.png
nullable: true
description: Logo image URL, 150x150. Null when no image is available.
yearOfFoundation:
type: number
example: 2017
nullable: true
description: Year founded.
nativeCurrencyId:
type: number
example: 1839
nullable: true
description: ID of the exchange's native token.
adjustedVolume24h:
type: string
example: '12345678901'
description: Adjusted 24h trading volume, USD.
reportedVolume24h:
type: string
example: '23456789012'
description: Reported 24h trading volume, USD.
marketShare:
type: number
example: 12.34
description: >-
Share of total market trading volume, %. Futures venues are excluded
from the total.
currenciesCount:
type: number
example: 350
description: Number of distinct coins traded.
pairsCount:
type: number
example: 1820
description: Number of active tickers.
openInterest:
type: string
example: '4567890123'
nullable: true
description: >-
Total open interest for derivative contracts, USD. Only for
derivatives.
blockchain:
type: string
example: null
nullable: true
description: Native blockchain.
description:
type: string
example: Binance is a global cryptocurrency exchange...
nullable: true
description: Exchange description.
links:
description: Related links — website, whitepaper, github, socials, etc.
type: array
items:
$ref: '#/components/schemas/LinkDto'
jurisdiction:
type: string
example: Cayman Islands
nullable: true
description: Exchange jurisdiction or country of registration.
hasProofOfReserves:
type: boolean
example: true
description: Whether the exchange publishes proof of reserves.
perpetualContractsCount:
type: number
example: null
nullable: true
description: Number of perpetual contracts listed. Null for non-derivatives.
futuresContractsCount:
type: number
example: null
nullable: true
description: Number of futures contracts listed. Null for non-derivatives.
required:
- id
- slug
- name
- type
- imageUrl
- yearOfFoundation
- nativeCurrencyId
- adjustedVolume24h
- reportedVolume24h
- marketShare
- currenciesCount
- pairsCount
- openInterest
- blockchain
- description
- links
- jurisdiction
- hasProofOfReserves
- perpetualContractsCount
- futuresContractsCount
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
LinkDto:
type: object
properties:
type:
type: string
enum:
- referral
- web
- twitter
- reddit
- slack
- discord
- blog
- github
- gitlab
- linkedin
- facebook
- google+
- explorer
- weibo
- chat
- messageboard
- wechat
- telegram
- medium
- announcement
- youtube
- fees
- whitepaper
- gitbook
- farcaster
example: twitter
value:
type: string
required:
- type
- value
securitySchemes:
X-Api-Key:
name: X-Api-Key
type: apiKey
in: header
````