{
  "path": "/options/candlesticks",
  "operation_id": "listOptionsCandlesticks",
  "auth_required": false,
  "parameters": [
    {
      "name": "contract",
      "in": "query",
      "description": "Options contract name",
      "required": true,
      "schema": {
        "type": "string"
      },
      "example": "BTC_USDT-20210916-5000-C"
    },
    {
      "name": "limit",
      "in": "query",
      "description": "Maximum number of records returned in a single list",
      "required": false,
      "schema": {
        "type": "integer",
        "default": 100,
        "minimum": 1,
        "maximum": 1000
      },
      "example": 100
    },
    {
      "name": "from",
      "in": "query",
      "description": "Start timestamp\n\nSpecify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)",
      "required": false,
      "schema": {
        "type": "integer",
        "format": "int64"
      },
      "example": 1547706332
    },
    {
      "name": "to",
      "in": "query",
      "description": "Termination Timestamp\n\nSpecify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp",
      "required": false,
      "schema": {
        "type": "integer",
        "format": "int64"
      },
      "example": 1547706332
    },
    {
      "name": "interval",
      "in": "query",
      "required": false,
      "description": "Time interval between data points",
      "schema": {
        "type": "string",
        "enum": [
          "1m",
          "5m",
          "15m",
          "30m",
          "1h"
        ],
        "default": "5m"
      },
      "example": "5m"
    }
  ],
  "response_fields": {
    "200": {
      "description": "Query successful",
      "fields": [
        {
          "path": "$",
          "type": "array<object>",
          "description": "",
          "constraints": ""
        },
        {
          "path": "$[]",
          "type": "object",
          "description": "data point in every timestamp",
          "constraints": ""
        },
        {
          "path": "$[].t",
          "type": "number",
          "description": "Unix timestamp in seconds",
          "constraints": "格式：\"double\""
        },
        {
          "path": "$[].v",
          "type": "integer",
          "description": "size volume (contract size). Only returned if `contract` is not prefixed",
          "constraints": "格式：\"int64\""
        },
        {
          "path": "$[].c",
          "type": "string",
          "description": "Close price (quote currency, unit: underlying corresponding option price)",
          "constraints": ""
        },
        {
          "path": "$[].h",
          "type": "string",
          "description": "Highest price (quote currency, unit: underlying corresponding option price)",
          "constraints": ""
        },
        {
          "path": "$[].l",
          "type": "string",
          "description": "Lowest price (quote currency, unit: underlying corresponding option price)",
          "constraints": ""
        },
        {
          "path": "$[].o",
          "type": "string",
          "description": "Open price (quote currency, unit: underlying corresponding option price)",
          "constraints": ""
        }
      ]
    }
  },
  "source_version": "v4.106.132",
  "source_url": "https://github.com/gate/gateapi-python/blob/cd2cac4d339ec0734480787d23c020f467fd7b80/openapi.yaml",
  "local_tool_limits": [
    "仅检查必填、枚举和简单数值范围",
    "复杂类型序列化、条件必填、时间窗口等以官方规则为准",
    "不会发起 API 请求"
  ]
}
