{"components":{"securitySchemes":{"l402":{"description":"L402 authentication. On first request, the server returns 402 with a Lightning invoice. Pay the invoice, then retry with: Authorization: L402 {macaroon}:{preimage}","in":"header","name":"Authorization","type":"apiKey"}}},"info":{"description":"API endpoints for BTC Intel","title":"BTC Intel","version":"1.0.0"},"openapi":"3.1.0","paths":{"/v1/derivatives/cme-basis":{"get":{"operationId":"get_v1_derivatives_cme_basis","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Derivatives Cme Basis","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/derivatives/liquidation-heatmap":{"get":{"operationId":"get_v1_derivatives_liquidation_heatmap","parameters":[{"description":"Bypass cache and force a recompute.","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Derivatives Liquidation Heatmap","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/derivatives/liquidations":{"get":{"operationId":"get_v1_derivatives_liquidations","parameters":[{"description":"Rolling window for liquidation aggregation, in hours.","in":"query","name":"window_hours","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Derivatives Liquidations","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/derivatives/liquidations/stream":{"get":{"operationId":"get_v1_derivatives_liquidations_stream","parameters":[{"description":"Drop liquidation events smaller than this notional (USD).","in":"query","name":"min_size_usd","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Derivatives Liquidations Stream","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/derivatives/options":{"get":{"operationId":"get_v1_derivatives_options","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Derivatives Options","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/derivatives/overview":{"get":{"operationId":"get_v1_derivatives_overview","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Derivatives Overview","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/ecosystem/metrics":{"get":{"operationId":"get_v1_ecosystem_metrics","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Ecosystem Metrics","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/events/upcoming":{"get":{"operationId":"get_v1_events_upcoming","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Events Upcoming","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/history/analogs":{"get":{"operationId":"get_v1_history_analogs","parameters":[{"description":"Master regime label to search for (e.g. bullish, bearish, neutral)","in":"query","name":"regime","required":true,"schema":{"type":"string"}},{"description":"Min RSI to match","in":"query","name":"rsi_min","schema":{"type":"number"}},{"description":"Max RSI to match","in":"query","name":"rsi_max","schema":{"type":"number"}},{"description":"Min Fear \u0026 Greed to match","in":"query","name":"fg_min","schema":{"type":"integer"}},{"description":"Max Fear \u0026 Greed to match","in":"query","name":"fg_max","schema":{"type":"integer"}},{"description":"Max analogs to return","in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Analogs","x-l402-pricing":{"model":"per_request","priceSats":5}}},"/v1/history/candles":{"get":{"operationId":"get_v1_history_candles","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Candle timeframe: 1h, 4h, 1d","in":"query","name":"timeframe","schema":{"type":"string"}},{"description":"Start datetime ISO 8601","in":"query","name":"start","schema":{"type":"string"}},{"description":"End datetime ISO 8601","in":"query","name":"end","schema":{"type":"string"}},{"description":"Max rows to return","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Pagination offset","in":"query","name":"offset","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Candles","x-l402-pricing":{"model":"per_request","priceSats":5}}},"/v1/history/heatmaps":{"get":{"operationId":"get_v1_history_heatmaps","parameters":[{"description":"Symbol filter, e.g. BTC.","in":"query","name":"symbol","schema":{"type":"string"}},{"description":"Start datetime ISO 8601.","in":"query","name":"start","schema":{"type":"string"}},{"description":"End datetime ISO 8601.","in":"query","name":"end","schema":{"type":"string"}},{"description":"Max rows to return","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Pagination offset (rows to skip)","in":"query","name":"offset","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Heatmaps","x-l402-pricing":{"model":"per_request","priceSats":5}}},"/v1/history/indicators":{"get":{"operationId":"get_v1_history_indicators","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Candle timeframe: 1h, 4h, 1d","in":"query","name":"timeframe","schema":{"type":"string"}},{"description":"Start datetime ISO 8601","in":"query","name":"start","schema":{"type":"string"}},{"description":"End datetime ISO 8601","in":"query","name":"end","schema":{"type":"string"}},{"description":"Max candles to load","in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Indicators","x-l402-pricing":{"model":"per_request","priceSats":5}}},"/v1/history/order-book-walls":{"get":{"operationId":"get_v1_history_order_book_walls","parameters":[{"description":"Symbol filter, e.g. BTC.","in":"query","name":"symbol","schema":{"type":"string"}},{"description":"Start datetime ISO 8601.","in":"query","name":"start","schema":{"type":"string"}},{"description":"End datetime ISO 8601.","in":"query","name":"end","schema":{"type":"string"}},{"description":"Max rows to return","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Pagination offset (rows to skip)","in":"query","name":"offset","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Order Book Walls","x-l402-pricing":{"model":"per_request","priceSats":6}}},"/v1/history/snapshots":{"get":{"operationId":"get_v1_history_snapshots","parameters":[{"description":"Filter by source name","in":"query","name":"source","schema":{"type":"string"}},{"description":"Start datetime ISO 8601","in":"query","name":"start","schema":{"type":"string"}},{"description":"End datetime ISO 8601","in":"query","name":"end","schema":{"type":"string"}},{"description":"Max rows to return","in":"query","name":"limit","schema":{"type":"integer"}},{"description":"Pagination offset (rows to skip)","in":"query","name":"offset","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Snapshots","x-l402-pricing":{"model":"per_request","priceSats":5}}},"/v1/history/summary":{"get":{"operationId":"get_v1_history_summary","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"History Summary","x-l402-pricing":{"model":"per_request","priceSats":5}}},"/v1/macro/correlations":{"get":{"operationId":"get_v1_macro_correlations","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Macro Correlations","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/macro/stablecoins":{"get":{"operationId":"get_v1_macro_stablecoins","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Macro Stablecoins","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/market/intelligence":{"get":{"operationId":"get_v1_market_intelligence","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Comma-separated source names to include (e.g. on_chain,sentiment,technical_analysis)","in":"query","name":"sources","schema":{"type":"string"}},{"description":"Cache control: 'false' (serve cache), 'true' (stale-while-revalidate), 'blocking' (wait for live data)","in":"query","name":"fresh","schema":{"type":"string"}},{"description":"Response detail level: 'full' (default) or 'summary' (compact, no individual whale txs or meta)","in":"query","name":"detail","schema":{"type":"string"}},{"description":"Include per-source meta descriptions","in":"query","name":"include_meta","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Market Intelligence","x-l402-pricing":{"model":"per_request","priceSats":80}}},"/v1/market/multi_exchange":{"get":{"operationId":"get_v1_market_multi_exchange","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Market Multi Exchange","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/market/order-book-walls":{"get":{"operationId":"get_v1_market_order_book_walls","parameters":[{"description":"Include unconfirmed candidates (potential spoofs / not-yet-aged walls) under ``unconfirmed_candidates``. Off by default.","in":"query","name":"include_candidates","schema":{"type":"boolean"}},{"description":"Bypass cache and recompute.","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Market Order Book Walls","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/market/snapshot":{"get":{"operationId":"get_v1_market_snapshot","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache and fetch live data","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Market Snapshot","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/network/mempool":{"get":{"operationId":"get_v1_network_mempool","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Network Mempool","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/onchain/exchange-reserves":{"get":{"operationId":"get_v1_onchain_exchange_reserves","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Onchain Exchange Reserves","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/onchain/metrics":{"get":{"operationId":"get_v1_onchain_metrics","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Onchain Metrics","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/onchain/valuation":{"get":{"operationId":"get_v1_onchain_valuation","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Onchain Valuation","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/risk/anomalies":{"get":{"operationId":"get_v1_risk_anomalies","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Risk Anomalies","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/risk/manipulation":{"get":{"operationId":"get_v1_risk_manipulation","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Manipulation Risk","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/sentiment/overview":{"get":{"operationId":"get_v1_sentiment_overview","parameters":[{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Sentiment Overview","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/technical/entry-timing":{"get":{"operationId":"get_v1_technical_entry_timing","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Entry Timing","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/technical/indicators":{"get":{"operationId":"get_v1_technical_indicators","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Technical Indicators","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/technical/trend":{"get":{"operationId":"get_v1_technical_trend","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Trend Data","x-l402-pricing":{"model":"per_request","priceSats":10}}},"/v1/technical/volume-profile":{"get":{"operationId":"get_v1_technical_volume_profile","parameters":[{"description":"Exchange venue. Supported: binance, bybit, coinbase, kraken, okx.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Bypass cache","in":"query","name":"fresh","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response"},"402":{"description":"Payment Required — pay the Lightning invoice in the WWW-Authenticate header"}},"summary":"Volume Profile","x-l402-pricing":{"model":"per_request","priceSats":10}}}},"security":[{"l402":[]}],"servers":[{"url":"https://btc-intel.gw.bolthub.ai"}],"x-l402-sdks":{"python":"bolthub","typescript":"@bolthub/agent"}}