# Candlestick Subscription

### Overview

This page provides detailed documentation on how to subscribe to real-time candlestick (OHLCV) data using the WebSocket API. This WebSocket connection delivers continuous, live datafeeds for candlestick data across multiple markets such as stocks, cryptocurrencies, forex, and futures.

### **Request Frequency**

For a single WebSocket connection, all requests (subscribe, unsubscribe, heartbeat) are limited to 60 times per minute. If the request frequency limit is exceeded, the connection will be automatically closed. If disconnections occur too frequently, and the system deems them to be malicious requests, the API key will be banned. Please be mindful of the calling logic during usage.

### **Error Code Explanation**

Please refer to the [WebSocket error code](/en-docs/getting-started/error-codes/websocket-error-codes.md) documentation for further details.

### **Subscription Address**

Please refer to the [WebSocket subscription addresses.](/en-docs/websocket/subscription-address.md)

### **Request Quantity**

Different subscription plans allow varying numbers of products per WebSocket subscription. Please refer to the [WebSocket restrictions](/en-docs/getting-started/api-limitation/websocket-limitation.md) documentation for specific details.

### Request (Protocol Number: 10006)

```json
{
    "code": 10006,
    "trace": "423afec425004bd8a5e02e1ba5f9b2b0",
    "data": {
        "arr": [
            {
                "type": 1,
                "codes": "BTCUSDT,DOGUSDT"
            }
        ]
    }
}
```

| Parameter | Type    | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                | Example                            |
| --------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| `code`    | Integer | Yes      | Request protocol number                                                                                                                                                                                                                                                                                                                                                                                    | `10006`                            |
| `trace`   | String  | Yes      | Traceable ID (random string)                                                                                                                                                                                                                                                                                                                                                                               | `423afec425004bd8a5e02e1ba5f9b2b0` |
| `data`    | JSON    | Yes      | Subscription data                                                                                                                                                                                                                                                                                                                                                                                          |                                    |
| `arr`     | Array   | Yes      | Multiple subscription entities                                                                                                                                                                                                                                                                                                                                                                             |                                    |
| `type`    | Integer | Yes      | <p>The type of candlestick interval. Options:<br><code>1</code> = 1 minute<br><code>2</code> = 5 minutes<br><code>3</code> = 15 minutes<br><code>4</code> = 30 minutes<br><code>5</code> = 1 hour<br><code>6</code> = 2 hours<br><code>7</code> = 4 hours<br><code>8</code> = 1 day<br><code>9</code> = 1 week<br><code>10</code> = 1 month<br><code>11</code> = 1 quarter<br><code>12</code> = 1 year</p> | `1`                                |
| `codes`   | String  | Yes      | Product symbols (comma-separated for multiple)                                                                                                                                                                                                                                                                                                                                                             | `BTCUSDT`                          |

### Response (Protocol Number: 10007)

```
{
    "code": 10007,
    "trace": "423afec425004bd8a5e02e1ba5f9b2b0",
    "msg": "ok"
}
```

| Parameter | Type    | Required | Description                   | Example Value                      |
| --------- | ------- | -------- | ----------------------------- | ---------------------------------- |
| `code`    | Integer | Yes      | Response protocol number      | `10007`                            |
| `trace`   | String  | Yes      | Trace ID (same as in request) | `423afec425004bd8a5e02e1ba5f9b2b0` |
| `msg`     | String  | Yes      | Response message              | `ok`                               |

### Push (Protocol Number: 10008)

```
{
    "code": 10008,
    "data": {
        "c": "103478.27",
        "h": "103478.27",
        "l": "103478.26",
        "o": "103478.26",
        "pca": "0.00",
        "pfr": "0.00%",
        "s": "BTCUSDT",
        "t": 1747550640,
        "ty": 1,
        "v": "0.34716",
        "vw": "35923.5149678"
    }
}
```

| Parameter | Type    | Required | Description                             | Example Value   |
| --------- | ------- | -------- | --------------------------------------- | --------------- |
| `code`    | Integer | Yes      | Candlestick push protocol number        | `10008`         |
| `data`    | JSON    | Yes      | Kline push entity                       | —               |
| `s`       | String  | Yes      | Symbol name                             | `BTCUSDT`       |
| `c`       | String  | Yes      | Closing price                           | `103478.27`     |
| `h`       | String  | Yes      | Highest price                           | `103478.27`     |
| `l`       | String  | Yes      | Lowest price                            | `103478.26`     |
| `o`       | String  | Yes      | Opening price                           | `103478.26`     |
| `pca`     | String  | Yes      | Price change amount                     | `0.00`          |
| `pfr`     | String  | Yes      | Price change percentage                 | `0.00%`         |
| `t`       | Long    | Yes      | Kline timestamp (in seconds)            | `1747550640`    |
| `ty`      | Integer | Yes      | Kline type (refer to request parameter) | `1`             |
| `v`       | String  | Yes      | Trade volume                            | `0.34716`       |
| `vw`      | String  | Yes      | Trade value                             | `35923.5149678` |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.infoway.io/en-docs/websocket/websocket-subscribe-method/candlestick-subscription.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.