marketpane.creocortex.com

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "results_table",
        "watchlist",
        "alert_draft",
        "similar_opportunities",
        "filter_builder",
        "chart",
        "study_library",
        "alerts",
        "symbol_details"
      ],
      "description": "Registered panel kind. One of: results_table, watchlist, alert_draft, similar_opportunities, filter_builder, chart, study_library, alerts, symbol_details."
    },
    "title": {
      "type": "string",
      "description": "Defaults to the kind's own default title."
    },
    "config": {
      "type": "object",
      "description": "Kind-specific configuration; defaults to the kind's own default config. See x-kind-config-schemas for each registered kind's schema."
    },
    "source": {
      "type": [
        "object",
        "null"
      ],
      "description": "Data source to bind; omit or null for an unbound panel.",
      "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"
      ]
    },
    "renderer": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "table",
        "chart_grid",
        "heatmap",
        "scatter_plot",
        null
      ],
      "description": "Initial renderer; defaults to the kind's default renderer. Registered renderer types. One of: table, chart_grid, heatmap, scatter_plot. See x-renderer-config-schemas."
    },
    "rect": {
      "type": "object",
      "description": "Explicit footprint (6-column by 4-row grid, both zero-based); auto-placed when omitted.",
      "properties": {
        "col": {
          "type": "integer",
          "minimum": 0,
          "maximum": 5,
          "description": "Zero-based column."
        },
        "row": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3,
          "description": "Zero-based row."
        },
        "col_span": {
          "type": "integer",
          "minimum": 1,
          "maximum": 6,
          "description": "Columns spanned."
        },
        "row_span": {
          "type": "integer",
          "minimum": 1,
          "maximum": 4,
          "description": "Rows spanned."
        }
      },
      "required": [
        "col",
        "row",
        "col_span",
        "row_span"
      ]
    },
    "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": [
    "kind"
  ],
  "x-kind-config-schemas": {
    "results_table": {
      "type": "object",
      "description": "How a results table panel presents a screener run: displayed columns, computed columns, sort, grouping, conditional formatting, page size, and the chart panel it is bound to. Only the properties named are changed; every other property is left as it was.",
      "properties": {
        "columns": {
          "type": "array",
          "description": "Displayed columns, in display order."
        },
        "computed_columns": {
          "type": "array",
          "description": "Formula-derived columns available to display."
        },
        "sort": {
          "type": "object",
          "description": "The active sort key and direction, or null for none."
        },
        "grouping": {
          "type": "object",
          "description": "The active grouping key, or null for none."
        },
        "formatting_rules": {
          "type": "array",
          "description": "Conditional formatting rules."
        },
        "page_size": {
          "type": "number",
          "description": "Rows per page. Defaults when omitted."
        },
        "chart_panel_id": {
          "type": "string",
          "description": "The chart panel this table drives, or null."
        }
      }
    },
    "watchlist": {
      "type": "object",
      "properties": {
        "sortBy": {
          "type": "string"
        }
      }
    },
    "alert_draft": {
      "type": "object",
      "properties": {}
    },
    "similar_opportunities": {
      "type": "object",
      "properties": {
        "runId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "filter_builder": {
      "type": "object",
      "properties": {
        "filterTree": {
          "type": "object"
        }
      }
    },
    "chart": {
      "type": "object",
      "description": "How a chart panel draws its series. Only the properties named are changed; every other property of the chart is left exactly as it was. What the chart shows -- instrument, timeframe, range, comparisons -- is a source concern, set through bind_panel_source.",
      "properties": {
        "candle_type": {
          "type": "string",
          "enum": [
            "candlestick",
            "ohlc_bar",
            "line",
            "area",
            "heikin_ashi",
            "hollow_candle"
          ],
          "description": "How each bar is drawn."
        },
        "scale": {
          "type": "string",
          "enum": [
            "linear",
            "logarithmic"
          ],
          "description": "Price axis scale."
        },
        "session": {
          "type": "string",
          "enum": [
            "regular",
            "extended",
            "continuous"
          ],
          "description": "Which trading session the bars cover. Changing it changes which bars exist, so it invalidates cached bars and study output."
        },
        "price_adjustment": {
          "type": "string",
          "enum": [
            "adjusted",
            "split_adjusted",
            "unadjusted"
          ],
          "description": "The basis every price on this chart is stated on: \"adjusted\" (splits and dividends), \"split_adjusted\" (splits only) or \"unadjusted\" (as traded). It is not a display setting -- it restates every downstream price: bars, study values, annotation anchors and every read of this chart. Changing it invalidates cached bars and study output."
        },
        "studies": {
          "type": "array",
          "description": "Study instances on the chart, in display order. Pane placement is derived from the catalog and is not a caller choice.",
          "items": {
            "type": "object",
            "required": [
              "id",
              "catalog_item_id",
              "params",
              "pane",
              "order",
              "enabled"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable instance ID, `study_`-prefixed."
              },
              "catalog_item_id": {
                "type": "string"
              },
              "params": {
                "type": "object",
                "description": "Fully resolved, catalog defaults included."
              },
              "pane": {
                "enum": [
                  "price_overlay",
                  "sub_pane"
                ]
              },
              "order": {
                "type": "integer",
                "minimum": 0
              },
              "enabled": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "study_library": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string"
        },
        "searchTerm": {
          "type": "string"
        }
      }
    },
    "alerts": {
      "type": "object",
      "properties": {
        "onlyTriggered": {
          "type": "boolean"
        }
      }
    },
    "symbol_details": {
      "type": "object",
      "properties": {
        "symbol": {
          "type": "string"
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-renderer-config-schemas": {
    "table": {
      "type": "object",
      "description": "How a results table panel presents a screener run: displayed columns, computed columns, sort, grouping, conditional formatting, page size, and the chart panel it is bound to. Only the properties named are changed; every other property is left as it was.",
      "properties": {
        "columns": {
          "type": "array",
          "description": "Displayed columns, in display order."
        },
        "computed_columns": {
          "type": "array",
          "description": "Formula-derived columns available to display."
        },
        "sort": {
          "type": "object",
          "description": "The active sort key and direction, or null for none."
        },
        "grouping": {
          "type": "object",
          "description": "The active grouping key, or null for none."
        },
        "formatting_rules": {
          "type": "array",
          "description": "Conditional formatting rules."
        },
        "page_size": {
          "type": "number",
          "description": "Rows per page. Defaults when omitted."
        },
        "chart_panel_id": {
          "type": "string",
          "description": "The chart panel this table drives, or null."
        }
      }
    },
    "chart_grid": {
      "type": "object",
      "description": "How a chart panel draws its series. Only the properties named are changed; every other property of the chart is left exactly as it was. What the chart shows -- instrument, timeframe, range, comparisons -- is a source concern, set through bind_panel_source.",
      "properties": {
        "candle_type": {
          "type": "string",
          "enum": [
            "candlestick",
            "ohlc_bar",
            "line",
            "area",
            "heikin_ashi",
            "hollow_candle"
          ],
          "description": "How each bar is drawn."
        },
        "scale": {
          "type": "string",
          "enum": [
            "linear",
            "logarithmic"
          ],
          "description": "Price axis scale."
        },
        "session": {
          "type": "string",
          "enum": [
            "regular",
            "extended",
            "continuous"
          ],
          "description": "Which trading session the bars cover. Changing it changes which bars exist, so it invalidates cached bars and study output."
        },
        "price_adjustment": {
          "type": "string",
          "enum": [
            "adjusted",
            "split_adjusted",
            "unadjusted"
          ],
          "description": "The basis every price on this chart is stated on: \"adjusted\" (splits and dividends), \"split_adjusted\" (splits only) or \"unadjusted\" (as traded). It is not a display setting -- it restates every downstream price: bars, study values, annotation anchors and every read of this chart. Changing it invalidates cached bars and study output."
        },
        "studies": {
          "type": "array",
          "description": "Study instances on the chart, in display order. Pane placement is derived from the catalog and is not a caller choice.",
          "items": {
            "type": "object",
            "required": [
              "id",
              "catalog_item_id",
              "params",
              "pane",
              "order",
              "enabled"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable instance ID, `study_`-prefixed."
              },
              "catalog_item_id": {
                "type": "string"
              },
              "params": {
                "type": "object",
                "description": "Fully resolved, catalog defaults included."
              },
              "pane": {
                "enum": [
                  "price_overlay",
                  "sub_pane"
                ]
              },
              "order": {
                "type": "integer",
                "minimum": 0
              },
              "enabled": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "heatmap": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string"
        },
        "colorScale": {
          "type": "string"
        },
        "groupBy": {
          "type": "string"
        }
      }
    },
    "scatter_plot": {
      "type": "object",
      "properties": {
        "xAxis": {
          "type": "string"
        },
        "yAxis": {
          "type": "string"
        },
        "colorBy": {
          "type": "string"
        }
      }
    }
  },
  "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"
      ]
    }
  }
}