marketpane.creocortex.com

{
  "type": "object",
  "properties": {
    "period": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "start",
        "end"
      ],
      "properties": {
        "start": {
          "type": "string",
          "format": "date"
        },
        "end": {
          "type": "string",
          "format": "date"
        }
      },
      "description": "Inclusive calendar date range, mutually exclusive with as_of. Resolve last week/month to explicit calendar dates. Rank/filter by field.price.period_return_pct for total period gains; baseline is the last loaded session before start, endpoint the last loaded session within the range. Other fields are evaluated at the endpoint. Not an any-time-during-period condition."
    },
    "workspace_id": {
      "type": "string",
      "description": "Defaults to the active workspace."
    },
    "as_of": {
      "type": "string",
      "format": "date",
      "description": "Exact trading session (YYYY-MM-DD) for all filters and rankings. Omit for the latest loaded session. Unavailable sessions are refused, never substituted. Use this for historical gainers; field.date is a filter, not a session selector."
    },
    "screener_id": {
      "type": "string"
    },
    "screener_revision": {
      "type": "integer",
      "description": "Optional. The screener definition's own revision counter -- not the workspace's own revision (see expected_revision, a separate parameter). Runs this exact screener revision instead of the current one; rejected if that revision is no longer retained."
    },
    "expected_revision": {
      "type": "number",
      "description": "Optional. The workspace's own revision, used for optimistic concurrency -- not the screener definition's revision (see screener_revision, a separate parameter). Rejected with a revision conflict if the workspace is no longer at this revision."
    },
    "idempotency_key": {
      "type": "string"
    }
  },
  "required": [
    "screener_id"
  ]
}