Skip to main content

Extension

objectrequired
Constant value: extension
seriesstringrequired
profile_versionstringrequired
Example: standard@2026-11
time_unitTimeUnit

The unit of every time in the request and the answer, since the Unix epoch, UTC. In JSON, us and ns times are strings of digits; ms times are integers.

Possible values: [ms, us, ns]

Default value: ms
barsintegerrequired

Bars in the series so far, these included.

outcomestring

started for a series' first call, segmented when any level closed a segment, extended otherwise.

Possible values: [started, extended, segmented]

closed object[]required

Segments these bars closed, now final, bottom level first. Store them; they never change.

  • Array [
    • idstringrequired

    h@<open_time>. The same segment has the same id in a segmentation and in every extension that names it, so a store keyed on it updates in place.

    Possible values: Value must match regular expression ^h[0-9]+@[0-9]+$

    parentstring | nullnullablerequired

    The id of the segment one level up that contains this one; null at the top.

    heightintegerrequired

    The level: 1 is the finest segments above the bars, larger is coarser.

    Possible values: >= 1

    orderintegerrequired

    Position among its siblings, in time order.

    Possible values: >= 0

    barsintegerrequired

    How many bars it covers.

    Possible values: >= 1

    open_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    opennumberrequired
    high_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    highnumberrequired
    low_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    lownumberrequired
    close_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    closenumberrequired
    provisionalbooleanrequired

    True for the open right edge: it may still grow, and its close may move. Every other segment is final.

  • ]
    • right_edge object[]required

    The open segment at each level, bottom up, all provisional. Replace the previous right edge with it.

  • Array [
    • idstringrequired

    h@<open_time>. The same segment has the same id in a segmentation and in every extension that names it, so a store keyed on it updates in place.

    Possible values: Value must match regular expression ^h[0-9]+@[0-9]+$

    parentstring | nullnullablerequired

    The id of the segment one level up that contains this one; null at the top.

    heightintegerrequired

    The level: 1 is the finest segments above the bars, larger is coarser.

    Possible values: >= 1

    orderintegerrequired

    Position among its siblings, in time order.

    Possible values: >= 0

    barsintegerrequired

    How many bars it covers.

    Possible values: >= 1

    open_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    opennumberrequired
    high_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    highnumberrequired
    low_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    lownumberrequired
    close_time objectrequired
    oneOf
    integer

    Possible values: >= 0

    closenumberrequired
    provisionalbooleanrequired

    True for the open right edge: it may still grow, and its close may move. Every other segment is final.

  • ]
    • edgeEdgerequired

    A forming series' state, sealed by Patternode: encrypted, signed, and bound to your account, the series name and the profile version. Opaque: store it as you got it and send it back unchanged. Omit it to start a series.

    Possible values: <= 65536 characters, Value must match regular expression ^pne1\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$

    edge_last_close_time objectrequired

    The close time of the last bar in the edge. The next bars must open after it.

    oneOf
    integer
    usage object
    samples_billedintegerrequired
    cost_usdnumberrequired
    Extension
    {
      "series": "string",
      "profile_version": "standard@2026-11",
      "time_unit": "ms",
      "bars": 0,
      "outcome": "started",
      "closed": [
        {
          "id": "string",
          "parent": "string",
          "height": 0,
          "order": 0,
          "bars": 0,
          "open_time": 0,
          "open": 0,
          "high_time": 0,
          "high": 0,
          "low_time": 0,
          "low": 0,
          "close_time": 0,
          "close": 0,
          "provisional": true
        }
      ],
      "right_edge": [
        {
          "id": "string",
          "parent": "string",
          "height": 0,
          "order": 0,
          "bars": 0,
          "open_time": 0,
          "open": 0,
          "high_time": 0,
          "high": 0,
          "low_time": 0,
          "low": 0,
          "close_time": 0,
          "close": 0,
          "provisional": true
        }
      ],
      "edge": "string",
      "edge_last_close_time": 0,
      "usage": {
        "samples_billed": 0,
        "cost_usd": 0
      }
    }