QuantBrasil
Documentação

quantbrasil capabilities

Lista as operações disponíveis

Sintaxe

quantbrasil capabilities

Este é um comando operacional da instalação local do QuantBrasil.

Argumentos e opções

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

Exemplos

quantbrasil capabilities
quantbrasil capabilities --json

Saída (--json)

Estrutura da resposta retornada com --json:

export type CapabilitiesJsonOutput = CapabilityInspectionEntry[];

export interface CapabilityInspectionEntry {
  id: string;
  kind: CapabilityKind;
  description: string;
  visibility: readonly CapabilityVisibility[];
  http: CapabilityHttpMetadata;
  cli: CapabilityCliMetadata;
  tool: CapabilityToolMetadata;
  outputModes: readonly CapabilityOutputMode[];
}

Exemplo de resposta

[
  {
    "id": "market.price",
    "kind": "read",
    "description": "Return the latest or date-specific price snapshot for a single ticker.",
    "visibility": ["cli", "opencode"],
    "http": {
      "method": "POST",
      "path": "/api/desk/tools/market/price",
      "inputMode": "json_body",
      "schemas": {
        "request": "MarketPriceRequest",
        "response": "MarketPriceResponse"
      }
    },
    "cli": {
      "group": "market",
      "path": ["market", "price"],
      "summary": "Get the current or historical price snapshot for one ticker.",
      "positional": [
        {
          "kind": "positional",
          "name": "ticker",
          "type": "string",
          "required": true,
          "placeholder": "TICKER",
          "description": "Ticker symbol, for example PETR4 or VALE3."
        }
      ],
      "options": [
        {
          "kind": "option",
          "flag": "--date",
          "name": "date",
          "type": "string",
          "required": false,
          "placeholder": "AAAA-MM-DD",
          "description": "Reference date in ISO format. When omitted, returns the latest available price."
        },
        {
          "kind": "option",
          "flag": "--timeframe",
          "name": "timeframe",
          "type": "string",
          "required": false,
          "placeholder": "TIMEFRAME",
          "defaultValue": "D1",
          "description": "Timeframe identifier. Defaults to D1."
        }
      ],
      "examples": [
        "quantbrasil market price PETR4",
        "quantbrasil market price PETR4 --date 2026-04-10 --timeframe D1"
      ]
    },
    "tool": {
      "name": "qb_market_price",
      "title": "Get market price"
    },
    "outputModes": ["json", "human"]
  }
]