quantbrasil rankings list

quantbrasil rankings list

quantbrasil rankings list

export interface RankingsListResponse {
  ok: boolean;
  system: RankingDefinitionOut[];
  user: RankingDefinitionOut[];
  total: number;
}

export interface RankingDefinitionOut {
  id: string;
  name: string;
  kind: "SYSTEM" | "USER";
  description: string | null;
  order_metric: RankingMetricOut;
  metrics: RankingMetricOut[];
  latest_as_of: string | null;
  total_assets: number | null;
  return_simulation: RankingReturnSimulationOut;
}

export interface RankingMetricOut {
  key: string;
  label: string;
  direction: "asc" | "desc";
  unit: string | null;
}

export interface RankingReturnSimulationOut {
  supported: boolean;
  earliest_start_date: string | null;
  max_top_n: number | null;
}

{
  "ok": true,
  "total": 1,
  "system": [
    {
      "id": "momentum-90d",
      "name": "Momentum - 90 dias",
      "kind": "SYSTEM",
      "description": "Ranking por retorno acumulado em 90 dias.",
      "order_metric": {
        "key": "return_value",
        "label": "Retorno 90 dias",
        "direction": "desc",
        "unit": "ratio"
      },
      "metrics": [],
      "latest_as_of": "2026-05-15",
      "total_assets": 120,
      "return_simulation": {
        "supported": true,
        "earliest_start_date": "2023-01-02",
        "max_top_n": 30
      }
    }
  ],
  "user": []
}