API Documentation

Usenami provides a powerful REST API for accessing real-time and historical cryptocurrency derivatives data across major CEX and DEX venues. Get funding rates, open interest, trading volume, and arbitrage opportunities programmatically.

Base URL: https://usenami.io

Building an autonomous agent? There is also a separate pay-per-call API (x402 protocol, USDC per request, no accounts) — see API for AI agents.

Authentication

The public JSON endpoints below are free and require no API key. The only exception is CSV export, which needs an x-api-key header.

bash

curl "https://usenami.io/api/screener?ticker=BTC"

API keys are not self-serve yet — they are issued manually while the API is in beta.

Endpoints

GET/api/screener

Current funding rate snapshot per asset (with price, OI and 24h volume)

Query Parameters

tickerstring • optional

Filter by asset (e.g., BTC, ETH)

sortstring • optional

Sort field (default: updated_at)

limitinteger • optional

Rows to return (default: 10, max: 100)

Response Example

json

{
  "count": 2,
  "data": [
    {
      "ticker": "BTC",
      "current_price": 101284.5,
      "funding_rate": 0.0000125,
      "rate_change_pct_24h": -3.2,
      "open_interest": 18500000000,
      "volume_24h": 52000000000,
      "updated_at": "2026-07-05T12:00:00Z"
    },
    {
      "ticker": "ETH",
      "current_price": 3842.12,
      "funding_rate": 0.0000081,
      "rate_change_pct_24h": 1.4,
      "open_interest": 9200000000,
      "volume_24h": 21000000000,
      "updated_at": "2026-07-05T12:00:00Z"
    }
  ]
}

GET/api/oi

Open interest per asset for one exchange source

Query Parameters

source_idinteger • optional

Exchange source id (default: 29)

limitinteger • optional

Rows to return (default: 50, max: 200)

compareboolean • optional

Include cross-exchange comparison

Response Example

json

{
  "exchange": "Binance",
  "source_id": 29,
  "data": [
    {
      "ticker": "BTC",
      "open_interest": 6200000000,
      "volume_24h": 52000000000,
      "oi_volume_ratio": 0.12,
      "funding_rate": 0.0000125
    }
  ]
}

GET/api/volume

24h trading volume per asset for one exchange source

Query Parameters

source_idinteger • optional

Exchange source id (default: 29)

limitinteger • optional

Rows to return (default: 50, max: 200)

leadersboolean • optional

Return volume leaders view

Response Example

json

{
  "exchange": "Binance",
  "source_id": 29,
  "data": [
    {
      "ticker": "BTC",
      "volume_24h": 52000000000,
      "volume_share_pct": 41.6,
      "open_interest": 6200000000,
      "funding_rate": 0.0000125
    }
  ]
}

GET/api/arbitrage

Find funding rate arbitrage opportunities

Query Parameters

min_difffloat • optional

Minimum rate differential in decimal (default: 0.005 = 0.5%)

Response Example

json

{
  "minDiff": 0.005,
  "opportunities": [
    {
      "ticker": "WIF",
      "longExchange": 1,
      "longExchangeName": "Binance",
      "longRate": -0.0032,
      "shortExchange": 3,
      "shortExchangeName": "OKX",
      "shortRate": 0.0026,
      "diff": 0.0058
    }
  ]
}

GET/api/export/funding

Download funding rate history as CSV file. Requires an API key (x-api-key header). Pro keys can export up to 30 days, free keys up to 7 days.

Query Parameters

tickerstring • optional

Asset ticker (e.g., BTC, ETH). Defaults to BTC.

daysinteger • optional

Number of days to export (max 30 for Pro, 7 for Free). Defaults to 7.

Response Example

json

{
  "file": "funding_BTC_7d.csv",
  "format": "CSV with columns: ticker, source_id, funding_rate, funding_rate_pct, recorded_at",
  "sampleRows": [
    "ticker,source_id,funding_rate,funding_rate_pct,recorded_at",
    "BTC,binance,0.0001,0.010000,2026-03-18T12:00:00Z",
    "BTC,bybit,0.00012,0.012000,2026-03-18T12:00:00Z"
  ]
}

Rate Limits

The public endpoints are free within fair-use limits (enforced per IP). If you need sustained high-frequency access or the CSV export, ask for an API key — keyed access is issued manually while the API is in beta.

Code Examples

Get Current BTC Funding Rate

bash

curl "https://usenami.io/api/screener?ticker=BTC"

Find Arbitrage Opportunities

bash

curl "https://usenami.io/api/arbitrage?min_diff=0.005"

Export Funding Rate History as CSV (API key required)

bash

curl -H "x-api-key: YOUR_API_KEY" \
  "https://usenami.io/api/export/funding?ticker=BTC&days=7" \
  -o funding_BTC_7d.csv

Python Example

python

import requests

# No API key needed for public endpoints
response = requests.get(
    "https://usenami.io/api/screener",
    params={"limit": 50}
)
data = response.json()

for row in data['data']:
    print(f"{row['ticker']}: {row['funding_rate']}")

JavaScript / Node.js Example

javascript

// No API key needed for public endpoints
async function getRates(ticker) {
  const params = new URLSearchParams({ ticker: ticker || "" });

  const response = await fetch(
    `https://usenami.io/api/screener?${params}`
  );

  const data = await response.json();
  return data.data;
}

getRates("BTC").then(rows => {
  console.log("BTC funding snapshot:", rows);
});

CSV Export

Download historical funding rate data as a CSV file for offline analysis. Requires an API key (issued manually while the API is in beta). Free key: 7 days max. Pro key: 30 days max.

GET/api/export/funding?ticker=BTC&days=7

Download funding rate history as CSV. Pro plan: 30 days max. Free: 7 days.

Example (curl):

curl -H "x-api-key: YOUR_KEY" "https://usenami.io/api/export/funding?ticker=BTC&days=7" > btc_funding.csv

CSV format:

ticker,source_id,funding_rate,funding_rate_pct,recorded_at
BTC,binance,0.0001,0.010000,2026-03-18T12:00:00Z
BTC,bybit,0.000125,0.012500,2026-03-18T12:00:00Z

Ready to get started?

The public API is free — no key, no signup required.

See code examples →