Custom API

Contact us for new endpoint request:

• Email: [email protected]
• Telegram: @CryptoMeterAdmin

Free Endpoints and Quota

• Full access to all free endpoints
• 10,000 Free Calls

Paid Endpoints and Extra Quota Charges

• For single endpoint: $20/- a month
• For all endpoints: $100/- a month
• For each extra API Call: $0.00036

API Plans

---

General Info

General API Information

• The API key is mandatory to access API endpoints. Please get your API key from https://www.cryptometer.io/api-manage
• The base endpoint is: https://api.cryptometer.io

IP Limits / Rate Limits

• Rate Limit: 10 Requests/calls allowed in 5 seconds.
• Rate Limit: 50 Requests/calls allowed in 5 seconds on Premium accounts [Available on request].
• Calls Limit: 10k Calls are free per month. Charges will be applied for extra API calls.
• Please do not create multiple accounts for more API quota. If system detect any of bad activity, it will lead to permanently ban.
• Please contact us if required more API calls or any custom endpoints. [[email protected]]

Change Log

2022-07-22

• forex-rates : Forex currency rates endpoint introduced

2021-06-29

• info : New Endpoint Introduced to monitor API usage

2021-06-21

• tickerlist-pro : New Endpoint Introduced

2021-05-30

• liquidation-data-v2 : New Endpoint Introduced

2021-05-29

• ohlcv : New Endpoint Introduced
• live-trades : New Endpoint Introduced

2021-03-08

• volume-flow : New Endpoint Introduced

2021-01-09

• ls-ratio : New Endpoint Introduced

2020-12-03

• Cryptocurrency-info : New Endpoint Introduced

2020-09-23

• xTrades - Whale trades : New Endpoint Introduced

2020-07-02

• Merged Orderbook - New Endpoint Introduced

2020-06-02

• Liquidation Data - New Endpoint Introduced

2020-05-02

• Trend Indicator V3 - New Endpoint Introduced
• Open Interest - New Endpoint Introduced

2020-04-02

• Endpoint deprecated: current-day-merged-volume
• Endpoint deprecated: current-day-long-short
• Endpoint deprecated: 24h-trade-volume

Above three endpoints are deprecated and will not available after a month. We have introduced new three endpoint to replace these endpoints. Please upgrade them asap.

2020-03-20

• Technical Indicators, new endpoint Introduced

2020-03-03

• Merged Trade Volume Endpoint Introduced

2019-12-06

• Rest API released

Market Data Endpoints

Market List

All mapped pairs and market pairs

Response:

  {
   "success":"true",
   "error":"false",
   "data":[
      {
         "pair":"BTC-USD",
         "market_pair":"USD-BTC"
      }
   ]
}

GET /coinlist/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of the Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
api_key	STRING	YES	API Key

Cryptocurrency Info Paid

Response:

        //defi filter
        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "name":"Chainlink", // Name Of the coin/token
                 "pair":"LINK-USDT", // pair name at cryptometer.io
                 "market_pair":"LINKUSDT", // pair name at exchange
                 "total_supply":"1000000000", // total supply of the coin/token
                 "circulate_supply":"394509556.43444", // circulating supply  of the coin/token
                 "price":"13.97710000", // last price
                 "high":"14.14820000", // 24h high
                 "low":"13.45010000", // 24h low
                 "volume":71636181.74, // 24h volume
                 "change_24h":1.73, // 24h change in %
                 "change_1h":0.36, // 1 hour change in %
                 "change_7d":-1.63, // 7 day change in %
                 "change_30d":29.58 // 30 day change in %
              },
              {
                 "name":"yearn.finance",
                 "pair":"YFI-USDT",
                 "market_pair":"YFIUSDT",
                 "total_supply":"30000",
                 "circulate_supply":"29967.75773773",
                 "price":"30044.05000000",
                 "high":"31780.41000000",
                 "low":"28393.81000000",
                 "volume":162827379.97,
                 "change_24h":5.66,
                 "change_1h":-0.37,
                 "change_7d":34.23,
                 "change_30d":196.92
              }
           ]
        }

GET /cryptocurrency-info/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of the Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
filter	STRING	YES	Algorithm filters supported(defi, pow, mineable, stablecoin, privacy, filesharing, all)
api_key	STRING	YES	API Key

Tickers of exchange

Response:

{
 "success":"true",
 "error":"false",
 "data":[
    {
       "market_pair":"USD-BTC",
       "last":"7301.136",
       "high":"7794.172",
       "low":"7085.034",
       "volume_24":7020059.09,
       "change_24h":2.33,
       "change_1h":0.15,
       "change_7days":-3.03
    }
 ]
}

GET /tickerlist/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of the Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
api_key	STRING	YES	API Key

Tickers of exchange Paid

Response:

{
   "success":"true",
   "error":"false",
   "data":[
      {
         "market_pair":"BTC/EUR", // exchange pair
         "symbol":"BTC", 
         "pair":"BTC-EUR", // Standardized CryptoMeter style Pair
         "price":34500.01, // price in quote currency
         "usd_price":34578.49896, // price in USD
         "high":36139.73,
         "low":33347.05,
         "volume_24":747852607.88, // volume in quote currency
         "change_24h":-2.81, // change in %
         "change_1h":0.21, // change in %
         "change_7d":-14.88, // change in %
         "change_30d":-7.93, // change in %
         "change_90d":-36.51, // change in %
         "change_ytd":17.32 // year to date change in %
      }
      ...
   ]
}

GET /tickerlist-pro/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of the Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/tickerlist-pro/?e=coinbase_pro&api_key=YOUR_API_KEY

Single ticker

Response:

  {
   "success":"true",
   "error":"false",
   "data":[
      {
         "market_pair":"USD-BTC",
         "last":"7301.136",
         "high":"7794.172",
         "low":"7085.034",
         "volume_24":7020059.09,
         "change_24h":2.33,
         "change_1h":0.15,
         "change_7days":-3.03
      }
   ]
}

GET /ticker/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of the Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
market_pair	STRING	YES
api_key	STRING	YES	API Key

Trend Indicator V3

Response:

        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "trend_score":38.64,
                 "buy_pressure":50.55,
                 "sell_pressure":49.45,
                 "timestamp":"2020-05-02T12:56:00.000Z"
              }
           ]
        }

GET /trend-indicator-v3/

Parameters:

Name	Type	Mandatory	Description
api_key	STRING	YES	API Key

• trend_score: Current Trend of the market. 0-100 Score, higher is better (bullish)
• buy_pressure: Buying pressure in the market in percentage (%)
• sell_pressure: Selling pressure in the market in percentage (%)
• timestamp: Last recorded time

Forex Rates Paid

• Supports 150+ Forex Currencies
• Update every 12 Hours

Response:

            {
    "success":"true",
    "error":"false",
    "data":[
        {
          "symbol":"CNY",
          "rate":6.762803
       },
        {
          "symbol":"INR",
          "rate":79.907498
       },
        {
          "symbol":"JPY",
          "rate":137.920749
       },
        {
          "symbol":"KRW",
          "rate":1313.140274
       },
        {
          "symbol":"RUB",
          "rate":56.524986
       },
        {
          "symbol":"USD",
          "rate":1
       },
       ...
        ]
 }
            

GET /forex-rates/

Parameters:

Name	Type	Mandatory	Description
source	STRING	YES	Currency code like USD, EUR, INR etc.
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/forex-rates/?source=USD&api_key=YOUR_API_KEY

LS Ratio Data Paid

Response:

      {
         "success":"true",
         "error":"false",
         "data":[
            {
               "ratio":"0.95", // ratio
               "buy":"48.65", // value in percentage
               "sell":"51.35", // value in percentage
               "close":26996.73, // close price or last price
               "delta":-475.15999999999985 // delta value
            }
            ...
         ]
      }
  

GET /ls-ratio/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of the Exchange (bitmex, binance_futures, bybit, ftx, deribit)
pair	STRING	YES	Example (BTC-USDT)
timeframe	STRING	YES	Available timeframes (5m, 15m, 30m, 1h, 4h, d)
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/ls-ratio/?e=binance_futures&pair=btc-usdt&timeframe=4h&api_key=YOUR_API_KEY

BTC Liquidation Data

• It will return Aggregated 24 Hours Liquidation data
• Values are in US Dollar ($)
• Aggregated data from Bitmex, Binance Futures, Bitfinex, OkEx, FTX

Response:

      {
         "success":"true",
         "error":"false",
         "data":{
            "longs":5479987.645280001,
            "shorts":230584458.8454366
         }
      }

GET /liquidation-data/

Parameters:

Name	Type	Mandatory	Description
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/liquidation-data/?api_key=YOUR_API_KEY

Total Liquidation Data in Detailed Paid

• It will return 24 Hours Liquidation data
• Values are in US Dollar ($)

Response:

      {
         "success":"true",
         "error":"false",
         "data":[
            {
               "binance_futures":{
                  "longs":6556449.80143,
                  "shorts":8546450.39233
               },
               "bitfinex":{
                  "longs":177375.14674178,
                  "shorts":50304.36069142
               },
               "bitmex":{
                  "longs":16134555,
                  "shorts":6367904
               },
               "bybit":{
                  "longs":32039041,
                  "shorts":17557593
               },
               "deribit":{
                  "longs":1351710,
                  "shorts":853330
               },
               "ftx":{
                  "longs":1723445.6022,
                  "shorts":2359737.0387
               },
               "okex":{
                  "longs":2391600,
                  "shorts":2247800
               }
            }
         ]
      }
    

GET /liquidation-data-v2/

Parameters:

Name	Type	Mandatory	Description
symbol	STRING	YES	example: BTC
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/liquidation-data-v2/?symbol=btc&api_key=YOUR_API_KEY

Bitmex Liquidation Data

4 Hours of data

Response:

  {
   "success":"true",
   "error":"false",
   "data":[
      {
         "market_pair":"XBTUSD",
         "quantity":5600,
         "side":"BUY",
         "timestamp":"2019-12-11T06:01:34.000Z"
      }
   ]
}

GET /bitmex-liquidation/

Parameters:

Name	Type	Mandatory	Description
market_pair	STRING	YES
api_key	STRING	YES	API Key

Rapid Movements

4 Hours of data

Response:

  {
     "success":"true",
     "error":"false",
     "data":[
        {
           "pair":"WLO-USD",
           "exchange":"bitfinex",
           "change_detected":5.17,
           "side":"PUMP",
           "timestamp":"2019-12-11T11:18:15.000Z"
        }
     ]
  }

GET /rapid-movements/

Parameters:

Name	Type	Mandatory	Description
api_key	STRING	YES	API Key

24h Trading Volume

24 Hours of data

Response:

        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "buy":52550.757832,
                 "sell":49059.904543
              }
           ]
        }

GET /24h-trade-volume-v2/

Parameters:

Name	Type	Mandatory	Description
pair	STRING	YES	example: BTC-USDT
e	STRING	YES	Name of exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
api_key	STRING	YES	API Key

Merged Volume - Current Day

Current Day data - UTC timezone

Response:

        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "buy":45371.03,
                 "sell":45802.35,
                 "timestamp":"2020-03-024T00:00:00.000Z"
              }
           ]
        }

GET /current-day-merged-volume-v2/

Parameters:

Name	Type	Mandatory	Description
symbol	STRING	YES	example: BTC
api_key	STRING	YES	API Key

Long/Shorts Data - Current Day

Current Day data - UTC timezone

Response:

        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "longs":533708150,
                 "shorts":519060716,
                 "timestamp":"2020-04-02T00:00:00.000Z"
              }
           ]
        }

GET /current-day-long-short-v2/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of Exchange (bitmex, binance_futures, bybit, ftx, deribit)
symbol	STRING	YES	example: xbt
api_key	STRING	YES	API Key

Merged Buy/Sell Volume - Hourly Paid

Hourly data of last 24 Hours

Response:

        {
             "success":"true",
             "error":"false",
             "data":[
                {
                   "buy":15371.03,
                   "sell":15802.35,
                   "symbol":"BTC",
                   "timestamp":"2019-12-11T09:00:00.000Z"
                }
             ]
          }

It will merge all volumes from different pairs and exchanges that we support.

GET /hourly-buy-sell-merged-volume/

Parameters:

Name	Type	Mandatory	Description
symbol	STRING	YES	example: btc
api_key	STRING	YES	API Key

Merged Buy/Sell Volume - X Timeframe Paid

Response:

        {
             "success":"true",
             "error":"false",
             "data":[
                {
                   "buy":15371.03,
                   "sell":15802.35,
                }
             ]
          }

It will merge all volumes from different pairs and exchanges that we support.

GET /merged-trade-volume/

Parameters:

Name	Type	Mandatory	Description
symbol	STRING	YES	example: btc
timeframe	STRING	YES	5m, 15m, 30m, 1h, 4h, d
exchange_type	STRING	YES	spot, futures
api_key	STRING	YES	API Key

Technical Indicators Paid

Simple Moving Average

Response:

        {
         "success":"true",
         "error":"false",
         "data":[
            [
               6437.404285714286,
               6613.859285714285,
               6820.522857142857,
               7060.174285714286,
               7305.874285714287,
               ...
            ]
         ]
      }

GET /indicator-sma/

Parameters:

Name	Type	Mandatory	Description
market_pair	STRING	YES	example: btcusdt
e	STRING	YES	exchange name (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
timeframe	STRING	YES	5m, 15m, 30m, 1h, 4h, d
source	STRING	YES	Supported Sources: open, close, high, low, volume (pass any of one)
period	integer	YES	example: 14 (it must be less than 300)
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/indicator-sma/?market_pair=btcusdt&e=binance&timeframe=d&source=close&period=14&api_key=YOUR_API_KEY

Available Indicators

• MACD
• RSI
• ATR
• PSAR
• EMA
• SMA
• CCI

More Indicators are available on request. Contact us for more details.

Open Interest

Response:

        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "open_interest":284233058
              }
           ]
        }

GET /open-interest/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of Exchange (bitmex, binance_futures, bybit, ftx, deribit)
market_pair	STRING	YES	example: xbtusd
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/open-interest/?market_pair=xbtusd&e=bitmex&api_key=YOUR_API_KEY

Open Interest Value in USD

Aggregated Order Book

Response:

        {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "symbol":"BTC",
                 "bids":1263.37,
                 "asks":1481.62
              }
           ]
        }

GET /merged-orderbook/

Parameters:

Name	Type	Mandatory	Description
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/merged-orderbook/?api_key=YOUR_API_KEY

Value in BTC

xTrades - Whale Trades Paid

It return executed Large Trades on exchanges.

Response:

                {
           "success":"true",
           "error":"false",
           "data":[
              {
                 "u_id":187723, // Unique ID
                 "pair":"BTC-USDT", // trade executed under this pair
                 "exchange":"binance", // exchange name
                 "price":36500, // trade executed at this price
                 "size":19.999999, // trade size
                 "total":729999.9635, // total value in quote currency
                 "side":"SELL", // trade side
                 "timestamp":"2021-05-29T04:30:05.000Z"
              }
           ]
        }

GET /xtrades/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
symbol	STRING	YES	example: btc, xbt, eth, xrp
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/xtrades/?symbol=btc&e=binance&api_key=YOUR_API_KEY

Live Trades Paid

It will give recent trade updates

Response:

        {
           "success":"true",
           "data":[
              {
                 "24h":{
                    "buy_quantity":63430.818,
                    "sell_quantity":68774.903
                 },
                 "1h":{
                    "buy_quantity":2569.928,
                    "sell_quantity":2234.597
                 },
                 "30m":{
                    "buy_quantity":703.442,
                    "sell_quantity":734.313
                 },
                 "15m":{
                    "buy_quantity":413.693,
                    "sell_quantity":442.004
                 },
                 "5m":{
                    "buy_quantity":123.260,
                    "sell_quantity":119.243
                 },
                 "1m":{
                    "buy_quantity":10.720,
                    "sell_quantity":8.524
                 }
              }
           ]
        }

GET /live-trades/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
pair	STRING	YES	example: btc-usdt
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/live-trades/?e=binance&pair=btc-usdt&api_key=YOUR_API_KEY

OHLCV Candles Paid

Response:

              {
                 "success":"true",
                 "error":"false",
                 "data":[
                    {
                       "timestamp":"2021-05-29T00:00:00.000Z",
                       "open":35661.79,
                       "high":37338.58,
                       "low":35604.3,
                       "close":36958.95,
                       "volume":830171905.88,
                       "buy":11352.22,
                       "sell":11476.07,
                       "buy_total":412970773.11,
                       "sell_total":417201132.77
                    },
                    ...
                 ]
              }
      

GET /ohlcv/

Parameters:

Name	Type	Mandatory	Description
e	STRING	YES	Name of Exchange (bitmex, binance, binance_futures, bybit, ftx, coinbase_pro, kraken, bitstamp, bitfinex, bittrex, deribit, binance_us, kucoin, bithumb, ftx_spot)
pair	STRING	YES	example: btc-usdt
timeframe	STRING	YES	example: 5m, 15m, 30m, 1h, 4h, d
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/ohlcv/?e=binance&pair=BTC-USDT&timeframe=d&api_key=YOUR_API_KEY

Volume Flow Paid

Response:

        {
           "success":"true",
           "error":"false",
           "data":{
              "buy_flow":[
                 {
                    "from":"USDT",
                    "to":"BTC",
                    "volume":16924591.41958453 //  Volume in USD
                 },
                 {
                    "from":"USDT",
                    "to":"ETH",
                    "volume":11067643.662260486
                 },
                 {
                    "from":"USD",
                    "to":"BTC",
                    "volume":6045045.363472098
                 }
                 ...
              ],
              "sell_flow":[
                 {
                    "from":"BTC",
                    "to":"USDT",
                    "volume":19592616.616997313 //  Volume in USD
                 },
                 {
                    "from":"ETH",
                    "to":"USDT",
                    "volume":8789476.493191348
                 },
                 {
                    "from":"ETH",
                    "to":"BTC",
                    "volume":5495281.407753442
                 }
                 ...
              ]
           }
        }

GET /volume-flow/

Parameters:

Name	Type	Mandatory	Description
timeframe	STRING	YES	5m, 15m, 30m, 1h, 4h, d
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/volume-flow/?timeframe=15m&api_key=YOUR_API_KEY

API Usage Information

It will give details about your API account.

Response:

{
   "success":"true",
   "error":"false",
   "data":[
      {
         "plan":"PAID",
         "subscription_expiry":"2021-09-27T00:00:00.000Z",
         "counter_reset":"2021-07-26T00:00:00.000Z",
         "quota":10000,
         "total_requests":12,
         "status":"active",
         "extra_endpoints":[
            "ohlcv",
            "xtrades",
            "ls-ratio",
            "live-trades",
            "volume-flow",
            "indicator-atr",
            "indicator-cci",
            "indicator-ema",
            "indicator-rsi",
            "indicator-sma",
            "indicator-macd",
            "indicator-psar",
            "tickerlist-pro",
            "cryptocurrency-info",
            "liquidation-data-v2",
            "merged-trade-volume",
            "hourly-buy-sell-merged-volume"
         ]
      }
   ]
}

GET /info/

Parameters:

Name	Type	Mandatory	Description
api_key	STRING	YES	API Key

Sample URL: https://api.cryptometer.io/info/?api_key=YOUR_API_KEY