Coinperps API Documentation

Quickstart

1. Create an account and subscribe to the API plan.
2. Generate your API key on the API page of your account.
3. Send it in the X-API-Key header with every request.

curl "https://api.coinperps.com/api/v1/metrics/totals" \
  -H "X-API-Key: YOUR_API_KEY"

Base URL and Authentication

Every endpoint sits under https://api.coinperps.com/api/v1 and takes a GET request. Requests without a valid key return 401 UNAUTHORIZED. Keep your key on the server: anyone with it can use your quota.

Rate Limits

Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time). The API plan costs $39 a month, or $30 a month billed yearly (pricing).

Responses

Responses are JSON with a success flag. meta.cached and meta.cacheAge tell you whether the data came from cache. Prices and volumes are strings to keep full precision, so parse them before doing maths.

{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": 1704067200000,
    "cached": false,
    "cacheAge": null
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded"
  }
}

Endpoints

19 endpoints, all GET, relative to the base URL.

Exchanges

Tickers

Metrics

Logos and icons

Ticker Fields

What /ticker/hyperliquid/BTC-PERP returns. The other ticker endpoints return arrays of the same object.

{
  "success": true,
  "data": {
    "exchange": "hyperliquid",
    "symbol": "BTC-PERP",
    "price": "43250.50",
    "markPrice": "43250.50",
    "indexPrice": "43248.00",
    "bid": "43249.00",
    "ask": "43251.00",
    "volume24h": "15234.567",
    "volumeUsd24h": "658234567.89",
    "priceChange24h": "250.50",
    "priceChangePercent24h": "0.58",
    "openInterest": "5000.25",
    "openInterestUsd": "216256343.13",
    "fundingRate": "0.0001",
    "nextFundingTime": 1704070800000,
    "timestamp": 1704067200000,
    "iconUrl": "https://static.edgex.exchange/icons/coin/BTC.png"
  }
}

Supported Exchanges

Exchange	ID	Chain
Hyperliquid	hyperliquid	Hyperliquid L1
ApeX	apex	Multi-chain
Aster	aster	BNB Chain
Lighter	lighter	Ethereum L2
edgeX	edgex	Ethereum L2
GRVT	grvt	GRVT L2
Jupiter Perps	jupiter	Solana
Reya	reya	Reya Network
Drift	drift	Solana
SynFutures	synfutures	Base
dYdX	dydx	dYdX Chain (Cosmos)
Gains Network	gains	Arbitrum / Polygon
Paradex	paradex	Starknet
GMX	gmx	Arbitrum / Avalanche

See the same data live on Top decentralized perpetual exchanges.

Error Codes

On a 429, wait until X-RateLimit-Reset before retrying.

Code Examples

JavaScript

const res = await fetch('https://api.coinperps.com/api/v1/ticker/hyperliquid/BTC-PERP', {
  headers: { 'X-API-Key': process.env.COINPERPS_API_KEY },
})
const body = await res.json()
if (!body.success) throw new Error(body.error.message)
console.log(Number(body.data.fundingRate) * 100, '% funding')

Python

import os, requests

r = requests.get(
    "https://api.coinperps.com/api/v1/metrics/rankings",
    params={"sortBy": "openInterest"},
    headers={"X-API-Key": os.environ["COINPERPS_API_KEY"]},
)
body = r.json()
if not body["success"]:
    raise RuntimeError(body["error"]["message"])
print(body["data"])

Data Accuracy and Fair Use

Data comes from each exchange’s API and on-chain sources. It can be delayed, cached or wrong at the source, so do not use it to place or time trades. Nothing the API returns is financial advice.

You may use the data in your own apps and research within your plan’s limits and with credit to Coinperps. Reselling it as a competing feed is not allowed. The full rules are in our terms and conditions.

API FAQ

How much does the Coinperps API cost?

$39 a month, or $30 a month billed yearly. Every subscription includes 600 requests a minute and 100,000 a day on all endpoints. There is no free API tier, but everything on coinperps.com stays free to read.

Which exchanges does the API cover?

14 decentralized perpetual exchanges: Hyperliquid, ApeX, Aster, Lighter, edgeX, GRVT, Jupiter Perps, Reya, Drift, SynFutures, dYdX, Gains Network, Paradex and GMX. Centralized exchanges are not in the API yet.

Can I use Coinperps data in my own product?

Yes, within your plan’s limits and with credit to Coinperps. Reselling the data as a competing feed is not allowed. Email us if you need more.

Is the data suitable for trading?

Treat it as market research. Figures come from exchange APIs and on-chain sources, can be cached for a short time (meta.cached and meta.cacheAge show this) and can be wrong at the source. Check prices on the exchange before you trade.

Support

Questions, bugs or higher limits: [email protected]. Include your key prefix (never the full key), the endpoint and the response you got.