QuantBrasil
Documentação

quantbrasil screening universes

Lista universos salvos disponíveis para screening de indicadores

Sintaxe

quantbrasil screening universes

Esta é uma operação de leitura. Modos de saída: json, human.

Argumentos e opções

NomeTipoObrigatórioDescriçãoPadrão
--jsonOpçãoNãoExibe saída JSON

Exemplos

quantbrasil screening universes

Saída (--json)

Estrutura da resposta retornada com --json:

export interface ScreeningUniversesResponse {
  ok: boolean;
  system: ScreeningUniverseOut[];
  watchlists: ScreeningUniverseOut[];
  holdings: ScreeningUniverseOut[];
  total: number;
}

export interface ScreeningUniverseOut {
  id: number;
  name: string;
  kind: "SYSTEM" | "WATCHLIST" | "HOLDING";
  slug: string | null;
  symbol_count: number;
}

Exemplo de resposta

{
  "ok": true,
  "total": 2,
  "system": [
    {
      "id": 1,
      "name": "Ações Mais Líquidas",
      "kind": "SYSTEM",
      "slug": "acoes-mais-liquidas",
      "symbol_count": 250
    }
  ],
  "watchlists": [
    {
      "id": 93,
      "name": "Minha Watchlist",
      "kind": "WATCHLIST",
      "slug": null,
      "symbol_count": 12
    }
  ],
  "holdings": []
}