Sign in

v20

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-2176162684.2 KB
Utilitários

Dicionário de Campos da API

Retorna o dicionário completo de todos os campos disponíveis na API, com nome em português, descrição detalhada e fórmula de cálculo.

Funcionalidades

  • Busca: Filtre por nome, descrição, categoria ou endpoint
  • Categorias: Agrupe campos por área (fii, treasury, quote, balance-sheet, income-statement, etc.)
  • Fórmulas: Veja como cada indicador é calculado

Exemplos de Uso

# Listar todos os campos
curl "https://brapi.dev/api/v2/dictionary"

# Buscar por termo
curl "https://brapi.dev/api/v2/dictionary?search=patrimônio"

# Filtrar por categoria
curl "https://brapi.dev/api/v2/dictionary?category=fii"

# Filtrar campos do Tesouro Direto
curl "https://brapi.dev/api/v2/dictionary?category=treasury"

Campos de Cada Entrada

  • key — Identificador do campo (ex: dividendYield12m)
  • label — Nome em português (ex: "Dividend Yield 12 meses")
  • description — Descrição detalhada
  • calculation — Fórmula de cálculo (quando aplicável)
  • endpoints — Endpoints onde o campo aparece
  • category — Categoria do campo
  • type — Tipo de dado (number, string, boolean, date)
  • unit — Unidade (%, R$, etc.)

Caso de Uso

Ideal para construir interfaces dinâmicas, tooltips, ou documentação automatizada a partir dos campos da API.

Plano Mínimo: Gratuito Autenticação: Não necessária (Público)

get/api/v2/dictionary

Query parameters

searchstring

Termo de busca para filtrar campos (busca em key, label, description e category)

Example:patrimônio
categorystring

Filtrar por categoria (ex: fii, treasury, quote, balance-sheet, income-statement)

Example:treasury

Response

Lista de campos do dicionário

requestedAtstring date-time required

Data e hora da requisição em formato ISO 8601

tookinteger required

Tempo de processamento em milissegundos

Example response

{
  "fields": [
    {
      "key": "symbol",
      "label": "Símbolo",
      "description": "Código de negociação do ativo brasileiro (ex: PETR4, VALE3)",
      "calculation": null,
      "endpoints": [
        "/api/quote/{tickers}",
        "/api/quote/list"
      ],
      "category": "quote",
      "type": "string",
      "unit": null
    },
    {
      "key": "shortName",
      "label": "Nome Curto",
      "description": "Nome resumido do ativo",
      "calculation": null,
      "endpoints": [
        "/api/quote/{tickers}",
        "/api/quote/list"
      ],
      "category": "quote",
      "type": "string",
      "unit": null
    },
    {
      "key": "longName",
      "label": "Nome Completo",
      "description": "Nome completo da empresa ou fundo",
      "calculation": null,
      "endpoints": [
        "/api/quote/{tickers}"
      ],
      "category": "quote",
      "type": "string",
      "unit": null
    }
  ],
  "requestedAt": "2026-02-08T16:25:35.000Z",
  "took": 2
}