# Dicionário de campos da API
URL: /docs/dicionario.mdx

Nome em português, descrição, fórmula, tipo e unidade de cada campo da API, e por que alguns campos vêm como null.


## Categorias

| Categoria          | Campos de                           | Exemplo de endpoint                                   |
| ------------------ | ----------------------------------- | ----------------------------------------------------- |
| `quote`            | Cotação de ações, FIIs, ETFs e BDRs | `/api/quote/{tickers}`                                |
| `historical`       | Histórico de preços e volume        | `/api/quote/{tickers}`                                |
| `financial-data`   | Receita, EBITDA e margens           | `/api/quote/{tickers}?modules=financialData`          |
| `balance-sheet`    | Balanço patrimonial                 | `/api/quote/{tickers}?modules=balanceSheetHistory`    |
| `income-statement` | DRE                                 | `/api/quote/{tickers}?modules=incomeStatementHistory` |
| `cash-flow`        | Fluxo de caixa                      | `/api/quote/{tickers}?modules=cashflowHistory`        |
| `value-added`      | DVA                                 | `/api/quote/{tickers}?modules=valueAddedHistory`      |
| `statistics`       | P/L, ROE e valor de mercado         | `/api/quote/{tickers}?modules=defaultKeyStatistics`   |
| `dividends`        | Dividendos e JCP                    | `/api/quote/{tickers}?dividends=true`                 |
| `fii`              | Indicadores de FIIs                 | `/api/v2/fii/indicators`                              |
| `fii-reports`      | Informes mensais de FIIs            | `/api/v2/fii/reports`                                 |
| `fii-portfolio`    | Carteira de FIIs                    | `/api/v2/fii/portfolio`                               |
| `fii-properties`   | Imóveis de FIIs                     | `/api/v2/fii/properties`                              |
| `treasury`         | Taxas e preços do Tesouro Direto    | `/api/v2/treasury/indicators`                         |
| `options`          | Métricas de opções                  | `/api/v2/options/analytics`                           |
| `futures`          | Contratos futuros                   | `/api/v2/futures/quote`                               |
| `future-options`   | Opções sobre futuros                | `/api/v2/futures/options/chain`                       |
| `crypto`           | Criptomoedas                        | `/api/v2/crypto`                                      |
| `currency`         | Câmbio                              | `/api/v2/currency`                                    |
| `inflation`        | Inflação                            | `/api/v2/inflation`                                   |
| `prime-rate`       | Selic                               | `/api/v2/prime-rate`                                  |

## Por que um campo vem como null

Um campo vem como `null` quando o dado não existe para aquele ativo ou período.
Os casos mais comuns:

* Bancos e seguradoras usam planos de contas próprios. Campos como
  `costOfRevenue`, `grossProfit`, `inventories` e `accountsReceivable` não se
  aplicam a eles. Campos como `deposits` e `loansNet` só existem para bancos.
* FIIs, ETFs e índices como `^BVSP` não têm balanço de empresa. Campos como
  `grossProfit` e `ebitda` vêm como `null`. Para FIIs, use as categorias que
  começam com `fii`.
* BDRs podem não ter alguns campos da empresa estrangeira.
* Empresas com IPO recente ou demonstrativos atrasados na CVM podem não ter
  dados fundamentalistas.

`calculation` é `null` nos campos que não são calculados.




## Swagger Documentation

# brapi - API do Mercado Financeiro Brasileiro - /api/v2/dictionary

Single endpoint documentation for /api/v2/dictionary

## Base URLs

- `https://brapi.dev` - Servidor principal da API brapi
- `http://localhost:3001` - Servidor local para desenvolvimento

## GET /api/v2/dictionary

**Summary:** Dicionário de campos


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.


**Tags:** Utilitários

### Parameters

- **search** (query)
- **category** (query)

### Responses

#### 200

Campos do dicionário.

## Schemas

The following schemas are used by this endpoint:

### DictionaryEntry

**Properties:**

- **key** (string) *(required)*

- **label** (string) *(required)*

- **description** (string) *(required)*

- **calculation** (string) *(nullable)* *(required)*

- **endpoints** (array) *(required)*
  Array items:
    **Type:** string


- **category** (string) *(required)*

- **type** (string) - Options: `number`, `string`, `boolean`, `date`, `object`, `array` *(required)*

- **unit** (string) *(nullable)* *(required)*


### DictionaryResponse

**Properties:**

- **fields** (array) *(required)*
  Array items:
    Reference to: **DictionaryEntry**

- **requestedAt** (string, date-time) *(required)*
  Data e hora da requisição em ISO 8601.

- **took** (integer) *(required)*
  Tempo de processamento, em milissegundos.