CandlesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/tickfeed-pro/json-schema/tickfeed-pro-candles-response-schema.json",
  "title": "CandlesResponse",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/tickfeed-pro-openapi.json#/components/schemas/CandlesResponse",
  "properties": {
    "symbol": {
      "type": "string",
      "title": "Symbol"
    },
    "timeframe": {
      "$ref": "#/$defs/Timeframe"
    },
    "source": {
      "$ref": "#/$defs/CandleSource"
    },
    "count": {
      "type": "integer",
      "title": "Count"
    },
    "truncated": {
      "type": "boolean",
      "title": "Truncated",
      "description": "True if more bars matched the range than `limit` allowed."
    },
    "next_start_time": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Start Time",
      "description": "When truncated with start_time, pass this as start_time to get the next page."
    },
    "candles": {
      "items": {
        "$ref": "#/$defs/CandleOut"
      },
      "type": "array",
      "title": "Candles",
      "description": "Chronological, oldest first. No gaps are filled."
    },
    "notes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Notes",
      "default": []
    }
  },
  "type": "object",
  "required": [
    "symbol",
    "timeframe",
    "source",
    "count",
    "truncated",
    "next_start_time",
    "candles"
  ],
  "$defs": {
    "CandleOut": {
      "properties": {
        "time": {
          "type": "string",
          "format": "date-time",
          "title": "Time",
          "description": "Bar open time, UTC."
        },
        "open": {
          "type": "number",
          "title": "Open"
        },
        "high": {
          "type": "number",
          "title": "High"
        },
        "low": {
          "type": "number",
          "title": "Low"
        },
        "close": {
          "type": "number",
          "title": "Close"
        },
        "tick_volume": {
          "type": "integer",
          "title": "Tick Volume"
        },
        "spread_points": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Spread Points",
          "description": "Spread recorded for the bar, in points."
        },
        "complete": {
          "type": "boolean",
          "title": "Complete",
          "description": "False if the bar period had not ended when these values were captured; its values can still change."
        }
      },
      "type": "object",
      "required": [
        "time",
        "open",
        "high",
        "low",
        "close",
        "tick_volume",
        "spread_points",
        "complete"
      ],
      "title": "CandleOut"
    },
    "CandleSource": {
      "type": "string",
      "enum": [
        "live",
        "stored"
      ],
      "title": "CandleSource"
    },
    "Timeframe": {
      "type": "string",
      "enum": [
        "S1",
        "S5",
        "S15",
        "S30",
        "M1",
        "M5",
        "M15",
        "M30",
        "H1",
        "H4",
        "D1"
      ],
      "title": "Timeframe"
    }
  }
}