quantbrasil screening indicators

quantbrasil screening indicators

quantbrasil screening indicators
quantbrasil screening indicators --json

export interface ScreeningIndicatorsResponse {
  ok: boolean;
  indicators: ScreeningIndicatorOut[];
  operators: string[];
}

export interface ScreeningIndicatorOut {
  name: string;
  display_name: string;
  description: string;
  timeframes: string[];
  params: ScreeningIndicatorParamOut[];
  examples: ScreeningIndicatorExampleOut[];
}

export interface ScreeningIndicatorParamOut {
  name: string;
  type: "integer" | "number" | "enum" | "string" | "boolean";
  required: boolean;
  default: ScreeningIndicatorScalar | null;
  description: string;
  enum_values: string[] | null;
  examples: ScreeningIndicatorScalar[];
}

export interface ScreeningIndicatorExampleOut {
  label: string;
  description: string;
  indicator: ScreeningIndicatorRef;
}

export type ScreeningIndicatorScalar = string | number | boolean;

export interface ScreeningIndicatorRef {
  name: string;
  timeframe: string;
  offset: number;
  params: Record<string, JsonValue>;
}

{
  "ok": true,
  "operators": ["lt", "lte", "gt", "gte", "eq", "neq"],
  "indicators": [
    {
      "name": "RSI",
      "display_name": "IFR",
      "description": "Índice de Força Relativa calculado sobre o fechamento.",
      "timeframes": ["M5", "M15", "M30", "H1", "H2", "H4", "D1", "W1"],
      "params": [
        {
          "name": "period",
          "type": "integer",
          "required": false,
          "default": 14,
          "description": "Número de períodos usados no cálculo.",
          "enum_values": null,
          "examples": [2, 14]
        }
      ],
      "examples": [
        {
          "label": "IFR(14)",
          "description": "IFR diário de 14 períodos.",
          "indicator": {
            "name": "RSI",
            "timeframe": "D1",
            "offset": 0,
            "params": {
              "period": 14
            }
          }
        }
      ]
    }
  ]
}