# Kiyotaka Docs

> Kiyotaka Data API reference. REST and WebSocket endpoints for crypto market data and Polymarket analytics.

## Getting Started

- **Intro —** [Kiyotaka Data API](https://kiyotaka.ai/docs/index.md): Programmatic access to crypto market data across multiple exchanges. Candles, open interest, funding rates, liquidations, heatmaps, volume profiles, and TPO.
- **Intro —** [Quickstart](https://kiyotaka.ai/docs/quickstart.md): From zero to streaming cross-exchange data in 5 minutes.
- **Intro —** [Quick Examples](https://kiyotaka.ai/docs/quick-examples.md): Real queries with real responses. Each card is a single API call you can copy and run.

## Basics

- **Reference —** [Authentication](https://kiyotaka.ai/docs/authentication.md): How to authenticate with the Kiyotaka Data API using API keys.
- **Reference —** [Parameters & Enums](https://kiyotaka.ai/docs/exchanges.md): Exchanges, symbols, intervals, time ranges, sort direction, and transforms for the Kiyotaka Data API.
- **Reference —** [Rate Limits](https://kiyotaka.ai/docs/rate-limits.md): Weight-based rate limiting, tier budgets, and response headers.
- **Reference —** [Errors](https://kiyotaka.ai/docs/errors.md): Error codes, formats, and troubleshooting for the Kiyotaka Data API.
- **Reference —** [Best Practices](https://kiyotaka.ai/docs/best-practices.md): Tips for building reliable, performant integrations with the Kiyotaka Data API.

## Crypto

- **REST —** [Candles](https://kiyotaka.ai/docs/rest/candles.md): OHLCV candlestick data via the Kiyotaka Data API.
- **REST —** [Open Interest](https://kiyotaka.ai/docs/rest/open-interest.md): Open interest data as OHLC candles via the Kiyotaka Data API.
- **REST —** [Funding Rate](https://kiyotaka.ai/docs/rest/funding-rate.md): Perpetual futures funding rate data via the Kiyotaka Data API.
- **REST —** [Liquidations](https://kiyotaka.ai/docs/rest/liquidations.md): Aggregated liquidation volume data via the Kiyotaka Data API.
- **REST —** [Volume Profile](https://kiyotaka.ai/docs/rest/volume-profile.md): Volume distributed across price levels via the Kiyotaka Data API.
- **REST —** [TPO / Market Profile](https://kiyotaka.ai/docs/rest/tpo.md): Time Price Opportunity data -- a Kiyotaka exclusive. Not available on any other crypto data API.
- **REST —** [Orderbook Heatmap](https://kiyotaka.ai/docs/rest/orderbook-heatmap.md): Orderbook depth data bucketed by price level for heatmap rendering.
- **REST —** [Liquidation Heatmap](https://kiyotaka.ai/docs/rest/liquidation-heatmap.md): Liquidation data aggregated by price level for heatmap rendering. Advanced and Enterprise tiers only.
- **REST —** [Bitcoin Dominance](https://kiyotaka.ai/docs/rest/bitcoin-dominance.md): Bitcoin market cap dominance and token supply data via the Kiyotaka Data API. Advanced tier only.
- **REST —** [Implied Volatility](https://kiyotaka.ai/docs/rest/implied-volatility.md): Option summary implied volatility via the Kiyotaka Data API. Advanced tier only.
- **REST —** [Skew](https://kiyotaka.ai/docs/rest/skew.md): Option summary skew via the Kiyotaka Data API. Advanced tier only.
- **REST —** [Metadata & Discovery](https://kiyotaka.ai/docs/rest/metadata.md): Endpoints for discovering available exchanges, symbols, markets, block sizes, tenors, and checking API usage.
- **WebSocket —** [WebSocket API Overview](https://kiyotaka.ai/docs/ws/overview.md): Real-time streaming market data via persistent WebSocket connections.
- **WebSocket —** [Connecting](https://kiyotaka.ai/docs/ws/connecting.md): Establish a WebSocket connection and authenticate with the API.
- **WebSocket —** [Subscribing](https://kiyotaka.ai/docs/ws/subscribing.md): Subscribe to channels, manage subscriptions, and configure Brotli compression.
- **WebSocket —** [Connection Lifecycle](https://kiyotaka.ai/docs/ws/lifecycle.md): Heartbeat, reconnection strategies, and best practices for WebSocket connections.
- **WebSocket —** [Trades (WebSocket)](https://kiyotaka.ai/docs/ws/trades.md): Real-time individual and aggregated trade streams via WebSocket.
- **WebSocket —** [Orderbook (WebSocket)](https://kiyotaka.ai/docs/ws/orderbook.md): Real-time orderbook depth snapshots via WebSocket.
- **WebSocket —** [Funding Rate (WebSocket)](https://kiyotaka.ai/docs/ws/funding.md): Real-time funding rate and predicted funding rate streams via WebSocket.
- **WebSocket —** [Open Interest (WebSocket)](https://kiyotaka.ai/docs/ws/open-interest.md): Real-time open interest updates via WebSocket.
- **WebSocket —** [Liquidations (WebSocket)](https://kiyotaka.ai/docs/ws/liquidations.md): Real-time liquidation events via WebSocket.
- **WebSocket —** [Volume Profile (WebSocket)](https://kiyotaka.ai/docs/ws/volume-profile.md): Real-time volume profile aggregated from live trades via WebSocket.

## Polymarket

- **REST —** [Polymarket Analytics](https://kiyotaka.ai/docs/rest/polymarket-analytics.md): Bounded Polymarket leaderboard, trader profile, positions, market summary, and user category endpoints.