--
--MAP

Real-Time Crypto Liquidation and Market Data API

Access powerful trading data and analytics through our REST API. Integrate liquidation maps, GEX, TOF, and more into your applications.

Supercharge Your Trading

Institutional derivatives analytics API delivering modeled liquidation clusters, aggregated depth, GEX+, and order flow across major venues.

  • Detect reversal zones before price moves with hidden liquidity cluster analysis
  • Production-ready Python client with comprehensive error handling
  • Backtest strategies with historical liquidation archives (depth varies by plan tier: 3 months, 1 year, or full archive)
  • Consolidate cross-exchange liquidation maps, GEX+ gamma levels, and toxic flow endpoints in a single REST schema
  • Options-aware trading with gamma exposure data showing dealer positioning

Transform your trading strategy with data that reveals what others miss.

Supercharge Your Trading Section

What You Can Build

Liquidation-based Strategies

Identify high-density liquidation clusters across major exchanges. Query historical archive depth scoped to your plan tier to test setup behavior.

Options-aware Trading

Gamma exposure (GEX+) profiles show modeled options dealer positioning alongside liquidation clusters for multi-signal confluence.

Toxic Flow Alerts

Track large orders moving markets with TOF endpoints. Identify when smart money is active and capitalize on institutional positioning.

Multi-exchange Arbitrage

Aggregate liquidation data across exchanges instantly. Spot dispersion opportunities and price inefficiencies before they disappear.

Forge Your Edge

Join quantitative trading firms, algorithmic traders, and hedge funds using Kingfisher data to build competitive advantages.

API Documentation

Quick start guide to integrate Kingfisher data into your trading applications

Authentication

All API requests require your API key in the header:

X-API-Key: kf_your_api_key_here

Example request:
GET https://app.thekingfisher.io/api/api-subscription/status

Available Endpoints

Different endpoints consume different amounts of credits per request

GEX (Gamma Exposure)

2 credits
POST/api/map/gevex
  • instrumentstring"BTC" or "ETH"
  • timestampnumberOptional: Unix timestamp for historical snapshot (rounded to nearest hour)

GEX Options Widgets

2 credits each
POST/api/map/greeks
  • instrumentstring"BTC" or "ETH"
  • daysnumberOptional: 1-45, default 14
  • intervalnumberOptional: 1-1440, default 60
POST/api/map/gexplus
  • instrumentstring"BTC" or "ETH"
  • stepsnumberOptional: 10-61, default 41
POST/api/map/charm_pin
  • instrumentstring"BTC" or "ETH"
  • expirystringOptional: DDMMMYY or "ALL"
POST/api/map/charm_tide
  • instrumentstring"BTC" or "ETH"
  • daysnumberOptional: 1-45, default 14
  • scenario_pctnumberOptional: -50 to 50, default 0
POST/api/map/charm_heatmap
  • instrumentstring"BTC" or "ETH"
  • daysnumberOptional: 1-45, default 14
  • spot_pctnumberOptional: 5-50, default 15
  • spot_stepsnumberOptional: 10-61, default 29
POST/api/map/volbeta
  • instrumentstring"BTC" or "ETH"
  • daysnumberOptional: 1-3650, default 365

TOF (Toxic Order Flow)

1 credit
GET/api/tof/get_available

Get available trading pairs

POST/api/tof

Latest snapshot (~30d 1h, ~90d 4h)

  • pairstring"BTCUSDT", "ETHUSDT"
  • tfstring"5m", "1h", "4h"
POST/api/tof/historical

Historical TOF for any date range (tier-dependent depth)

  • symbolstring"BTCUSDT"
  • timeframestring"5m", "1h", "4h"
  • limitnumber1-1000 (default: 100)
  • endnumberOptional end timestamp (ms)

Map (Liquidation Map)

1 credit5 credits (multi)
POST/api/map/latest
  • pairstring"BTC/USDT"
  • exchangestring"binance", "multi"
  • typestring"optical_opti"
POST/api/map/timestamp
  • pairstring"BTC/USDT"
  • exchangestring"binance", "multi"
  • typestring"optical_opti"
  • tsnumberUnix timestamp

Liq Ratios

5 credits
POST/api/ratios/latest
  • map_typestring"optical_opti"

RSI (Relative Strength Index)

1 credit
POST/api/rsi
  • tfstring"5m", "15m", "1h", "4h", "1d"

Market Surge

1 credit
GET/api/markets-surge

Get trending/volatile assets

Usage & Status

0 credits (free)
GET/api/api-subscription/usage

Get current credit usage

GET/api/api-subscription/instruments

Get allowed instruments

Response Format

All responses follow this structure:

{
  "status": true,
  "data": { ... }
  // or
  "error": "error message"
}

Python Integration Example

Here's a quick example to get you started:

Python
import requests

# Configure your API key
API_KEY = "kf_your_api_key_here"
BASE_URL = "https://app.thekingfisher.io/api"

headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json"
}

# Get GEX data for BTC
response = requests.post(
    f"{BASE_URL}/map/gevex",
    headers=headers,
    json={"instrument": "BTC"}
)

data = response.json()
print(f"GEX Data: {data}")

A complete Python client is provided to API subscribers with advanced features and error handling. Get API access

API Pricing

Pro includes 420 API credits per month; Max includes 600. Dedicated API plans offer higher limits.

Individual
2,000API credits/month
$499
per month
2,000 monthly credits
BTC + ETH
3 months of historical data
$0.20/credit overage
Enterprise
15,000API credits/month
$2,499
per month
15,000 monthly credits
All instruments
Full historical data
$0.05/credit overage

API Credit Consumption

Different endpoints consume different amounts of credits per request

1 credit
TOF
Toxic Order Flow
1 credit
Liq Map
Liquidation Map
2 credits
GEX / Greeks / GEX+
Gamma Exposure
5 credits
Aggr Map
Aggregated Orderbook
5 credits
Liq Ratio
Liquidation Ratio

Example: With the Professional tier's 5,000 monthly credits, you could make:

  • 5,000 Liq Map queries
  • 2,500 GEX queries
  • 1,000 Aggregated Orderbook queries
Ready to Get Started?

Join thousands of traders using Kingfisher API to power their trading strategies.