marketpane.creocortex.com

{
  "type": "object",
  "properties": {
    "panel_id": {
      "type": "string",
      "description": "Panel to bind."
    },
    "source": {
      "type": "object",
      "description": "Data source to bind.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "screener_results",
            "instrument",
            "watchlist",
            "symbol_list",
            "panel_reference"
          ],
          "description": "Registered source type. One of: screener_results, instrument, watchlist, symbol_list, panel_reference."
        },
        "ref": {
          "type": "object",
          "description": "Shape depends on \"type\"; see x-source-ref-schemas for each type's schema."
        }
      },
      "required": [
        "type",
        "ref"
      ]
    },
    "expected_revision": {
      "type": "number",
      "description": "Revision this call assumes the workspace is currently at. Omitting it skips the concurrency check; a mismatch fails with error \"revision_conflict\"."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Replaying the same key returns the original result instead of applying the change twice; reusing a key for a materially different request fails with error \"idempotency_conflict\"."
    }
  },
  "required": [
    "panel_id",
    "source"
  ],
  "x-source-ref-schemas": {
    "screener_results": {
      "type": "object",
      "properties": {
        "run_id": {
          "type": "string"
        }
      },
      "required": [
        "run_id"
      ]
    },
    "instrument": {
      "type": "object",
      "description": "What a chart panel shows: instrument, timeframe, visible range and comparison series. The instrument is named by ID, never by ticker. How the chart draws them -- candle type, scale, session, price-adjustment policy -- is a view concern, set through configure_panel_view.",
      "required": [
        "instrument"
      ],
      "properties": {
        "instrument": {
          "type": "object",
          "description": "A resolved instrument reference. The instrument is named by ID (for example \"inst:XNAS:AAPL\"), never by ticker -- resolve a ticker through instrument search first.",
          "required": [
            "instrument_id",
            "symbol",
            "exchange",
            "asset_type"
          ],
          "properties": {
            "instrument_id": {
              "type": "string",
              "description": "Canonical instrument ID. A bare ticker such as \"AAPL\" is rejected."
            },
            "symbol": {
              "type": "string",
              "description": "Display ticker. Identity, not identifier."
            },
            "exchange": {
              "type": "string",
              "description": "ISO 10383 MIC of the listing venue."
            },
            "asset_type": {
              "type": "string",
              "description": "equity, etf, adr, fund, index, future, fx, crypto."
            }
          }
        },
        "timeframe": {
          "type": "string",
          "enum": [
            "1m",
            "5m",
            "15m",
            "30m",
            "1h",
            "4h",
            "1d",
            "1wk",
            "1mo"
          ],
          "description": "Bar interval. Changing it invalidates cached bars and study output."
        },
        "range": {
          "description": "The visible range, either an explicit ISO 8601 {start, end} window or a relative token. Changing it invalidates cached bars and study output for this chart.",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "kind",
                "start",
                "end"
              ],
              "properties": {
                "kind": {
                  "const": "explicit"
                },
                "start": {
                  "type": "string",
                  "description": "ISO 8601 instant or date."
                },
                "end": {
                  "type": "string",
                  "description": "ISO 8601 instant or date, after start."
                }
              }
            },
            {
              "type": "object",
              "required": [
                "kind",
                "token"
              ],
              "properties": {
                "kind": {
                  "const": "relative"
                },
                "token": {
                  "type": "string",
                  "enum": [
                    "1d",
                    "5d",
                    "1mo",
                    "3mo",
                    "6mo",
                    "ytd",
                    "1y",
                    "2y",
                    "5y",
                    "max"
                  ]
                }
              }
            }
          ]
        },
        "comparisons": {
          "type": "array",
          "description": "Comparison instruments drawn beside the primary series.",
          "items": {
            "type": "object",
            "required": [
              "instrument"
            ],
            "properties": {
              "instrument": {
                "type": "object",
                "description": "A resolved instrument reference. The instrument is named by ID (for example \"inst:XNAS:AAPL\"), never by ticker -- resolve a ticker through instrument search first.",
                "required": [
                  "instrument_id",
                  "symbol",
                  "exchange",
                  "asset_type"
                ],
                "properties": {
                  "instrument_id": {
                    "type": "string",
                    "description": "Canonical instrument ID. A bare ticker such as \"AAPL\" is rejected."
                  },
                  "symbol": {
                    "type": "string",
                    "description": "Display ticker. Identity, not identifier."
                  },
                  "exchange": {
                    "type": "string",
                    "description": "ISO 10383 MIC of the listing venue."
                  },
                  "asset_type": {
                    "type": "string",
                    "description": "equity, etf, adr, fund, index, future, fx, crypto."
                  }
                }
              },
              "normalization": {
                "type": "object",
                "description": "How a comparison series is rescaled onto the primary series. Omit it and the default (mode \"none\", anchor \"window_start\") is applied and reported in the result.",
                "properties": {
                  "mode": {
                    "type": "string",
                    "enum": [
                      "none",
                      "percent_change",
                      "indexed_100",
                      "z_score"
                    ]
                  },
                  "anchor": {
                    "type": "string",
                    "enum": [
                      "window_start",
                      "anchor_bar"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    "watchlist": {
      "type": "object",
      "properties": {
        "watchlist_id": {
          "type": "string"
        }
      },
      "required": [
        "watchlist_id"
      ]
    },
    "symbol_list": {
      "type": "object",
      "properties": {
        "symbols": {
          "type": "array"
        }
      },
      "required": [
        "symbols"
      ]
    },
    "panel_reference": {
      "type": "object",
      "properties": {
        "panel_id": {
          "type": "string"
        }
      },
      "required": [
        "panel_id"
      ]
    }
  }
}