Welcome to CryptoMeter.io API Documentation
This documentation provides comprehensive information about the CryptoMeter.io API, including available endpoints, usage instructions, and sample responses. Whether you are a developer, analyst, or enthusiast, this guide will help you integrate and use our API efficiently.
- Quick Start: Obtain your API key from your dashboard and start making requests to https://api.cryptometer.io.
- Support: For questions or custom endpoint requests, contact us at [email protected] or Telegram @CryptoMeterAdmin.
Custom API
Free Endpoints and Quota
- Full access to all free endpoints
- 10,000 free calls a month
Paid Endpoints and Extra Calls - buy them yourself, no waiting
- Any single paid endpoint (marked Paid below): $20 for 30 days
- All endpoints at once: $99 a month
- Extra calls for the current month: from $0.28 to $0.40 per 1,000, depending on quantity
Buy endpoints or calls → See all API plans
Need an endpoint we don't have yet?
- Email: [email protected]
- Telegram: @CryptoMeterAdmin
General Info
General API Information
- To access API endpoints, an API key is mandatory. Please obtain your unique API key from https://www.cryptometer.io/api-manage.
- The base endpoint: https://api.cryptometer.io
IP Limits / Rate Limits
- The rate limit is 20 requests per 5 seconds. Premium accounts can request an increase to 50 requests per 5 seconds.
- The free tier includes 10,000 API calls per month. For users who need additional API calls, charges will be applied.
- Please refrain from creating multiple accounts to increase your API quota.
- Need more calls or another paid endpoint? Buy it yourself in Manage API - it applies to your key as soon as payment confirms. For an endpoint we don't offer yet, email [email protected].
Change Log
2026-09-17
- ath-screener: New endpoint - every tracked coin's distance from its all-time high.
- gainers-losers: New endpoint - top movers per timeframe (1m to 1mo), one row per coin.
- funding-rates: New endpoint - live perpetual funding rates across exchanges, annualized.
- xtrades:
symbolandeare now optional - omit both for the latest 100 whale trades across all exchanges, or pass one alone as a filter. Each row now also carriessymbolandusd_total. - rapid-movements-v2: New endpoint - the 33-type move-detection feed behind the site's Rapid Change page (breakouts, new highs/lows, volume-backed moves, whale trades and more), with optional type/exchange/symbol filters. The original rapid-movements endpoint is unchanged and stays free.
2025-08-31
- All indicators now use the standardized pair format (BASE-QUOTE, e.g., BTC-USDT).
2025-08-09
- indicator-stoch: New endpoint introduced
2025-08-05
- indicator-stochrsi: New endpoint introduced
2025-05-03
- liquidity-lens: New endpoint introduced
2024-05-14
- volume-flow: Endpoint updated
Market List
Our platform provides two types of cryptocurrency pairs: standardized pairs and market pairs. Standardized pairs are formatted according to the CryptoMeter standard, such as BTC-USD, while market pairs are formatted according specific cryptocurrency exchanges.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of the Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Cryptocurrency Info Paid
Our Cryptocurrency Info API endpoint offers detailed information on a wide range of crypto assets, including filters for various algorithms such as defi, stablecoin, pow, and many others. This data can help users gain a deeper understanding of individual cryptocurrencies, including key metrics such as circulate supply, trading volume, and price movements.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of the Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| filter | STRING | YES | Algorithm filters supported (defi, pow, mineable, stablecoin, privacy, filesharing, all) |
defi |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Coin Info Paid
Get detailed information about individual cryptocurrencies including market cap, total supply, circulating supply, and current price in USD.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Tickers of Exchange
Our Tickerlist API endpoint provides real-time pricing data for multiple cryptocurrencies, including high, low, and volume metrics.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of the Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Tickers of Exchange PRO Paid
Our Tickerlist Pro API endpoint offers a comprehensive set of data on multiple cryptocurrencies, including pricing data in USD, year-to-date (YTD) change, 90-day change, and much more.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of the Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Single Ticker
Our Ticker API endpoint provides real-time pricing data for individual cryptocurrencies.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of the Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| market_pair | STRING | YES | Trading pair | BTC-USDT |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Trend Indicator V3
Get trend analysis with buy/sell pressure indicators and market sentiment scores.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Forex Rates Paid
Supports 150+ Forex Currencies. Updates every 12 hours. Get exchange rates for major global currencies.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| source | STRING | YES | Currency code like USD, EUR, INR etc. | USD |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
AI Screener Paid
Returns AI Screener trades with entry prices, PNL data, and trade status for algorithmic trading insights.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| type | STRING | NO | Data range: latest (last 12 hours) or full (last month) | latest |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
AI Screener Analysis Paid
Get AI Screener analysis with success ratio and historical trade performance for specific symbols.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| symbol | STRING | YES | Symbol name (e.g., BTC) | BTC |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
LS Ratio Data Paid
Get Long/Short ratio data with buy/sell percentages and delta values for futures markets.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of the Exchange (bitmex, binance_futures, bybit, deribit) |
binance_futures |
| pair | STRING | YES | Trading pair | btc-usdt |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Total Liquidation Data in Detailed Paid
24-hour liquidation data expressed in US dollars ($) with detailed breakdown by exchange.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| symbol | STRING | YES | Symbol name (e.g., BTC) | btc |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Rapid Movements
Data on assets experiencing rapid upward price movements. Returns last 4 hours of data for real-time market monitoring.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Rapid Movements V2 Paid
The richer move-detection feed behind the site's own Rapid Change page: 33 move types across price, new highs/lows, short/medium-term rises and falls, volume-backed moves, range breakouts, a volatility surge signal, and single large whale trades. Up to 500 rows, newest first - 100 if any of the three filters below is used. All three filters are optional and can be combined; omit all three for the full feed. type must be one of the type ids in the table below - the literal value all is not accepted, just omit the parameter.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| type | STRING | NO | One move type id from the table below. Omit for every type. | breakout24hUp |
| e | STRING | NO | Name of Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx). Omit for all exchanges. |
binance |
| symbol | STRING | NO | Symbol (btc, eth, sol). Omit for all symbols. | btc |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Move Types (type= values):
| type= | Label | Group | Direction |
|---|---|---|---|
rally |
Rally | Price | Up |
pullback |
Pullback | Price | Down |
newHigh6h |
New 6h High | Highs | Up |
newHigh24h |
New 24h High | Highs | Up |
newHigh7d |
New 7-Day High | Highs | Up |
newHigh30d |
New 30-Day High | Highs | Up |
newLow6h |
New 6h Low | Lows | Down |
newLow24h |
New 24h Low | Lows | Down |
newLow7d |
New 7-Day Low | Lows | Down |
newLow30d |
New 30-Day Low | Lows | Down |
smallRise5Min |
Small Rise (5 Min) | Short Term (5 Min) | Up |
midRise5Min |
Mid Rise (5 Min) | Short Term (5 Min) | Up |
highRise5Min |
High Rise (5 Min) | Short Term (5 Min) | Up |
smallFall5Min |
Small Fall (5 Min) | Short Term (5 Min) | Down |
midFall5Min |
Mid Fall (5 Min) | Short Term (5 Min) | Down |
highFall5Min |
High Fall (5 Min) | Short Term (5 Min) | Down |
smallRise2Hours |
Small Rise (2h) | Medium Term (2h) | Up |
midRise2Hours |
Mid Rise (2h) | Medium Term (2h) | Up |
highRise2Hours |
High Rise (2h) | Medium Term (2h) | Up |
smallFall2Hours |
Small Fall (2h) | Medium Term (2h) | Down |
midFall2Hours |
Mid Fall (2h) | Medium Term (2h) | Down |
highFall2Hours |
High Fall (2h) | Medium Term (2h) | Down |
midVolumePriceIncrease |
Mid-Volume Price Increase | Volume + Price | Up |
midVolumePriceDecrease |
Mid-Volume Price Decrease | Volume + Price | Down |
highVolumePriceIncrease |
High-Volume Price Increase | Volume + Price | Up |
highVolumePriceDecrease |
High-Volume Price Decrease | Volume + Price | Down |
breakout24hUp |
24h Range Breakout | Breakouts | Up |
breakout24hDown |
24h Range Breakdown | Breakouts | Down |
breakout30dUp |
30-Day Range Breakout | Breakouts | Up |
breakout30dDown |
30-Day Range Breakdown | Breakouts | Down |
volatility15h |
Volatility + Volume Surge (15h) | Volatility | Up |
whaleTradeBuy |
Whale Buy | Whale Trades | Up |
whaleTradeSell |
Whale Sell | Whale Trades | Down |
24h Trading Volume
24 hours of buy/sell volume data for trading analysis.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Name of exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Open Interest
Open Interest data in USD for futures trading markets.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of Exchange (bitmex, binance_futures, bybit, deribit) |
binance_futures |
| market_pair | STRING | YES | Trading pair | xbtusd |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
OHLCV Candles Paid
OHLCV candlestick data with volume breakdown and trade count information.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| pair | STRING | YES | Trading pair | BTC-USDT |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Technical Indicators
SMA - Simple Moving Average Paid
Simple Moving Average (SMA) indicator that calculates the average price over a specified period.
Parameters (SMA Example):
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| source | STRING | YES | Supported sources: open, close, high, low, volume | close |
| period | INTEGER | YES | Period (must be less than 300) | 14 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
EMA - Exponential Moving Average Paid
Exponential Moving Average (EMA) indicator that gives more weight to recent prices.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| source | STRING | YES | Supported sources: open, close, high, low, volume | close |
| period | INTEGER | YES | Period (must be less than 300) | 21 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
RSI - Relative Strength Index Paid
Relative Strength Index indicator that measures the speed and change of price movements (0-100 range).
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 1h |
| source | STRING | YES | Supported sources: open, close, high, low, volume | close |
| period | INTEGER | YES | Period (must be less than 300) | 14 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Stochastic RSI Paid
Stochastic RSI indicator that measures the speed and change of price movements (0-100 range).
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| source | STRING | YES | Supported sources: open, close, high, low, volume | close |
| rsi_period | INTEGER | YES | RSI period | 14 |
| stoch_period | INTEGER | YES | Stochastic period | 14 |
| k_period | INTEGER | YES | K period | 3 |
| d_period | INTEGER | YES | D period | 3 |
Stochastic Oscillator Paid
Stochastic Oscillator indicator that measures momentum by comparing a closing price to its price range over a specific period (0-100 range).
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| k_period | INTEGER | YES | Main calculation period for %K | 14 |
| k_slowing_period | INTEGER | YES | Smoothing period for %K line | 1 |
| d_period | INTEGER | YES | Smoothing period for %D line | 3 |
MACD - Moving Average Convergence Divergence Paid
Moving Average Convergence Divergence (MACD) indicator that shows the relationship between two moving averages of prices.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| source | STRING | YES | Supported sources: open, close, high, low, volume | close |
| long_period | INTEGER | YES | Long EMA period | 26 |
| short_period | INTEGER | YES | Short EMA period | 12 |
| signal_period | INTEGER | YES | Signal line period | 9 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
ATR - Average True Range Paid
Average True Range indicator that measures market volatility.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| period | INTEGER | YES | Period (e.g., 14) | 14 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
CCI - Commodity Channel Index Paid
Commodity Channel Index indicator that measures the deviation of the typical price from its average.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| period | INTEGER | YES | Period (must be less than 300) | 20 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
PSAR - Parabolic SAR Paid
Parabolic SAR indicator that provides potential reversal points in price direction.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| source | STRING | YES | Source (open, high, low, close) | close |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 1h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Supertrend Indicator Paid
Supertrend indicator that provides buy/sell signals based on ATR and price movements.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| period | INTEGER | YES | ATR period | 10 |
| multiplier | FLOAT | YES | Multiplier for ATR | 3 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
VWAP - Volume Weighted Average Price Paid
Volume Weighted Average Price indicator that shows the average price weighted by volume.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | d |
| period | INTEGER | YES | Period for calculation | 1 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
MFI - Money Flow Index Paid
Money Flow Index indicator that measures the strength of money flowing into and out of a security.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| period | INTEGER | YES | Period (must be less than 300) | 20 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
BBANDS - Bollinger Bands Paid
Bollinger Bands indicator that measures the volatility of a security.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| pair | STRING | YES | Trading pair | BTC-USDT |
| e | STRING | YES | Exchange name (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| period | INTEGER | YES | Period (must be less than 300) | 20 |
| std_dev | INTEGER | YES | Standard Deviation (must be less than 10) | 5 |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Live Trades Paid
Real-time trade updates with buy/sell quantities across multiple timeframes for comprehensive market analysis.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| pair | STRING | YES | Trading pair | btc-usdt |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Volume Flow Paid
Volume flow analysis showing liquidity movements across different cryptocurrencies and timeframes.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Liquidity Lens Paid
Advanced liquidity analysis showing inflow, outflow, and netflow for major cryptocurrencies across different timeframes.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d, 3d, w) | 4h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Aggregated Order Book
Aggregated order book data showing total bids and asks values in BTC across multiple exchanges.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| api_key | STRING | YES | API Key | YOUR_API_KEY |
xTrades - Whale Trades Paid
Data on executed large trades made by whales - investors who make large trades that can significantly impact the market. Provides valuable insights into market trends and investor behavior. Both filters are optional: call it with just your key for the latest 100 whale trades across every exchange, or narrow by exchange, by symbol, or both (up to 400 rows when both are given).
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | NO | Name of Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx). Omit for all exchanges. |
binance |
| symbol | STRING | NO | Symbol (btc, xbt, eth, xrp). Omit for all symbols. | btc |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
ATH Screener Paid
Every tracked coin ranked by 24h volume with its current price, all-time high, ATH date and drawdown from that high. One row per coin, represented by its highest-volume dollar-quoted pair on a supported exchange; stablecoins are excluded. new_ath flags a high printed within the last 7 days. Up to 500 rows. Pass symbol for a single coin.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| symbol | STRING | NO | Symbol (btc, eth, sol). Omit for every coin. | btc |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Gainers & Losers Paid
The biggest movers over a timeframe, as two ranked lists: the top 100 gainers and the top 100 losers. One row per coin, represented by its highest-volume dollar-quoted pair, so a coin's most liquid market decides its move rather than an illiquid listing. Pairs under $50k 24h volume and stablecoins are excluded. pair_count is how many qualifying pairs the coin has across exchanges. Timeframes: 1m, 5m, 15m, 30m, 1h, 1d, 1w, 1mo (1m is one minute, 1mo one month).
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| timeframe | STRING | YES | 1m, 5m, 15m, 30m, 1h, 1d, 1w, 1mo | 1h |
| e | STRING | NO | Name of Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx). Omit for all exchanges. |
binance |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Funding Rates Paid
The live funding rate of every tracked perpetual contract, refreshed every few minutes. rate is the per-interval rate as a fraction (0.0001 = 0.01%), annualized_percent uses each contract's own settlement interval (hourly on Hyperliquid, 8h on most venues), so rates are comparable across exchanges. Rows are ordered by absolute annualized rate, extremes first. Filter by exchange, by symbol, or both.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | NO | Exchange id (binance_futures, bybit, hyperliquid, deribit, ...). Omit for all exchanges. | binance_futures |
| symbol | STRING | NO | Symbol (btc, eth, sol). Omit for every contract. | btc |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Volatility Index Paid
Volatility analysis showing price movements, average prices, percentage changes, and volume data across different timeframes.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of Exchange (bitmex, binance, binance_futures, bybit_spot, bybit, coinbase_pro, kraken, bitstamp, bitfinex, deribit, binance_us, kucoin, bithumb, okx) |
binance |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Long/Shorts Data
Long and short positions data across different timeframes for futures trading analysis.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| e | STRING | YES | Name of Exchange (bitmex, binance_futures, bybit, deribit) |
binance_futures |
| symbol | STRING | YES | Symbol (e.g., xbt) | xbt |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
Merged Buy/Sell Volume - X Timeframe Paid
Merged buy and sell volumes for specified timeframes. Combines volume data from different pairs and exchanges for comprehensive market trend analysis.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| symbol | STRING | YES | Symbol (e.g., btc) | btc |
| timeframe | STRING | YES | Available timeframes (5m, 15m, 30m, 1h, 4h, d) | 4h |
| exchange_type | STRING | YES | Exchange type (spot, futures) | spot |
| api_key | STRING | YES | API Key | YOUR_API_KEY |
API Usage Information
Get details about your API account including plan, quota, usage statistics, and available endpoints.
Parameters:
| Name | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| api_key | STRING | YES | API Key | YOUR_API_KEY |