TAAPI.IO Reference Data API

openapi: 3.2.0
info:
  title: TAAPI.IO Reference Data API
  version: 2.0.0
  description: 'Technical Analysis API providing indicator calculations and OHLCV candle data for crypto and stock markets.


    Each indicator is exposed as its own endpoint (`GET /indicator/`) with only the parameters that indicator actually accepts documented.


    ## Authentication


    All endpoints require a valid API key passed as a **Bearer token** in the `Authorization` header:


    ```

    Authorization: Bearer

    ```


    Get your API key at taapi.io.


    ## Rate Limiting


    Requests are rate-limited per API key according to your subscription plan (see taapi.io for plan limits). Limits use a **fixed window**: the window (15 seconds by default) starts with your first request, and the counter resets when it expires.


    Every authenticated response includes these headers:


    | Header | Meaning |

    |--------|---------|

    | `X-RateLimit-Limit` | Requests allowed per window |

    | `X-RateLimit-Remaining` | Requests left in the current window |

    | `X-RateLimit-Reset` | Seconds until the current window resets |


    When the limit is exceeded the API returns **HTTP 429** with:


    ```json

    { "error": "Too Many Requests", "retryAfter": 9 }

    ```


    Wait `retryAfter` seconds before retrying.


    ## Real-time streaming (WebSocket)


    For live indicator updates over a persistent connection, use the **streaming** service on the same domain:


    - **WebSocket URL:** `wss://v2.taapi.io/streaming` (or your base URL + `/streaming` if using path-based routing)

    - **Health check:** `GET https://v2.taapi.io/streaming/health`


    All messages are JSON objects with a `type` field. Streaming uses `interval` (not `timeframe` as in REST); allowed intervals are `1m`, `5m`, `15m` and `1h`. Symbols use the same format as the REST API (`BTCUSDT`, not `BTC/USDT`) and must appear in `GET /exchanges/{exchange}/symbols`.


    **Connection flow:**


    1. Connect to the WebSocket URL.

    2. **Authenticate** — send: `{ "type": "auth", "token": "Bearer " }`

    - Response: `{ "type": "auth_ok", "userId": "...", "plan": { "socketSubscriptionsAllowed": 10, "streamThrottleMs": 5000 } }` or `{ "type": "auth_error", "error": "..." }`

    3. **Subscribe** to an indicator — send:

    `{ "type": "subscribe", "id": "my_rsi", "exchange": "binance", "symbol": "BTCUSDT", "interval": "1m", "indicator": "rsi", "params": { "period": 14 } }`

    - Response: `{ "type": "subscribed", "id": "binance_btcusdt_1m_my_rsi", "subscription": "binance:btcusdt:1m", "indicator": "rsi" }`

    - The returned `id` is the **scoped id**: `___`, lowercased. Use it to unsubscribe and to read updates.

    4. **Receive updates** — the server pushes only values that changed, keyed by scoped id. Values are arrays, as in the REST API:

    `{ "type": "update", "subscription": "binance:btcusdt:1m", "data": { "binance_btcusdt_1m_my_rsi": { "value": [41.99], "timestamp": [1793656260] } } }`

    5. **Unsubscribe** — send the scoped id: `{ "type": "unsubscribe", "id": "binance_btcusdt_1m_my_rsi" }` → `{ "type": "unsubscribed", "id": "binance_btcusdt_1m_my_rsi" }`


    **Other message types:**


    - `{ "type": "subscribe_bulk", "exchange": "binance", "symbols": ["BTCUSDT", "ETHUSDT"], "intervals": ["1m"], "indicators": [{ "id": "my_rsi", "name": "rsi", "params": { "period": 14 } }] }` — subscribes every symbol × interval × indicator combination. The server replies `subscribe_bulk_ack`, then `subscribe_bulk_complete` with the `subKeys` registered.

    - `{ "type": "unsubscribe_all" }` → `{ "type": "unsubscribed_all", "message": "..." }`

    - `{ "type": "list" }` → `{ "type": "subscriptions", "data": { ... } }` (add `"unpack": true` for a flat array)

    - `{ "type": "ping" }` → `{ "type": "pong", "timestamp": 1793656260000 }`

    - Errors arrive as `{ "type": "error", "error": "..." }`.


    Use the same API key (Bearer token) as for the REST API.'
servers:
- url: https://v2.taapi.io
  description: Production
- url: http://localhost:8080
  description: Local development
security:
- bearerAuth: []
tags:
- name: Reference Data
  description: Endpoints to discover available exchanges and supported market symbols.
paths:
  /exchanges:
    get:
      summary: List Exchanges
      description: Returns a list of all supported cryptocurrency and stock exchanges.
      operationId: getExchanges
      tags:
      - Reference Data
      responses:
        '200':
          description: List of exchanges.
          content:
            application/json:
              schema:
                type: object
                properties:
                  exchanges:
                    type: array
                    items:
                      type: string
                    example:
                    - binance
                    - bybit
                    - gateio
                  count:
                    type: integer
                    example: 3
  /exchanges/{exchange}/symbols:
    get:
      summary: List Symbols by Exchange
      description: Returns all supported trading pairs or symbols for a specific exchange.
      operationId: getSymbols
      tags:
      - Reference Data
      parameters:
      - name: exchange
        in: path
        required: true
        description: Exchange identifier (e.g. `binance`, `bybit`)
        schema:
          type: string
          example: binance
      responses:
        '200':
          description: List of symbols.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 2
                  symbols:
                    type: array
                    items:
                      type: string
                    example:
                    - BTCUSDT
                    - ETHUSDT
        '404':
          description: Exchange not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Your TAAPI API key, passed as a Bearer token in the Authorization header.