---
title: "Dicionário de campos"
method: GET
path: "/api/v2/dictionary"
tags: ["Utilitários"]
---

# Dicionário de campos

`GET /api/v2/dictionary`

## Request

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

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.

## Query parameters

- `search` string: Texto buscado em key, label, description, category e endpoints. Ignora maiúsculas.
- `category` string: Categoria exata do campo. Ex.: fii, treasury, quote, balance-sheet.

## Response `200`

Campos do dicionário.

- DictionaryResponse
  - `fields` DictionaryEntry[], required
    - `key` string, required
    - `label` string, required
    - `description` string, required
    - `calculation` string, nullable, required
    - `endpoints` string[], required
    - `category` string, required
    - `type` 'number' | 'string' | 'boolean' | 'date' | 'object' | 'array', required
    - `unit` string, nullable, required
  - `requestedAt` string, date-time, required: Data e hora da requisição em ISO 8601.
  - `took` integer, required: Tempo de processamento, em milissegundos.

## Changes

- **2026-08-21** `d51b6ee0304a`: 1 info
  - api operation id `getDictionary` was added
- **2026-04-07** `19f807c15a24`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/changes/api/v2/dictionary/get.md)

---

[API](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro.md) - [All operations](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/llms.txt) - [OpenAPI document](https://skmtc.dev/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/revisions/7c732d79148a?raw)