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

# Dicionário de Campos da API

`GET /api/v2/dictionary`

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

```bash
# 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)

## Query parameters

- `search` string — Termo de busca para filtrar campos (busca em key, label, description e category)
- `category` string — Filtrar por categoria (ex: fii, treasury, quote, balance-sheet, income-statement)

## Response `200`

Lista de 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 formato ISO 8601
  - `took` integer, required — Tempo de processamento em milissegundos

---

[API](https://skmtc.net/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro.md) · [All operations](https://skmtc.net/brapi-dev/apis/brapi-api-do-mercado-financeiro-brasileiro/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brapi-dev/brapi-api-do-mercado-financeiro-brasileiro/versions/f275d46193ea/schema)