BRbrapi-dev
Utilitários

Dicionário de campos

Changed on

Lista os campos da API com nome em português, descrição, fórmula de cálculo, tipo, unidade, categoria e os endpoints onde cada campo aparece.

Use para gerar rótulos e tooltips, formatar valores pela unidade e entender um campo antes de usar.

category filtra por área, como fii, treasury ou balance-sheet. search busca em chave, nome, descrição, categoria e endpoints. Os dois funcionam juntos. Endpoint público, sem token.

get/api/v2/dictionary

Request

  • Base URL
    https://brapi.dev
  • URL
    https://brapi.dev/api/v2/dictionary
  • Auth
    none declared

Query parameters

searchstring

Texto buscado em key, label, description, category e endpoints. Ignora maiúsculas.

Example:patrimônio
categorystring

Categoria exata do campo. Ex.: fii, treasury, quote, balance-sheet.

Example:treasury

Response

Campos do dicionário.

requestedAtstring date-time required

Data e hora da requisição em 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
}

Changes