### GET /api/sdks

Source: https://brapi.dev/swagger/latest.json

Retorna página com informações sobre as SDKs oficiais da brapi para integração rápida.

### SDKs Disponíveis

*   **TypeScript/JavaScript:** `npm install brapi` — GitHub: https://github.com/brapi-dev/brapi-typescript
*   **Python:** `pip install brapi` — GitHub: https://github.com/brapi-dev/brapi-python

### Nota

Recomendamos o uso das SDKs para autenticação automática, tipagem completa e retry inteligente.

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

```markdown
### Responses

#### 200 - Página HTML de SDKs


### Example Usage

```bash
curl -X GET "https://brapi.dev/api/sdks"
```

```

--------------------------------

### GET /api/v2/macro/latest

Source: https://brapi.dev/swagger/latest.json


Snapshot dos valores mais recentes para uma lista de séries (ou todas, se
`symbols` for omitido).


```markdown
### Parameters

- **symbols** (string, query, optional) (example: "selic,cdi,ipca")

### Responses

#### 200 - Snapshot retornado com sucesso.

**MacroSeriesLatestResponse**
- **results** (array (MacroSeriesLatest)) (required)
  Array items:
    - **series** (object) (required) (example: {"slug":"selic","name":"Taxa Selic","description":"Taxa básica de juros da economia brasileira, definida pelo COPOM (Comitê de Política Monetária) do Banco Central. É a referência para todas as demais taxas de juros do país.","unit":"percentPerYear","frequency":"daily","category":"interestRate","startDate":"1999-03-05"})
      - **slug** (string) (required)
      - **name** (string) (required)
      - **description** (string) (required)
      - **unit** (string) (required)
      - **frequency** (string) (required)
      - **category** (string) (required)
      - **startDate** (string) (required)
    - **latest** (object) (required)
      - **date** (string) (required) (example: "2026-04-30")
      - **value** (number) (required) (example: 14.75)
- **warnings** (array (MacroSeriesAliasWarning))
  Array items:
    - **provided** (string) (required)
    - **canonicalSlug** (string) (required)
    - **message** (string) (required)
- **errors** (array (MacroSeriesError))
  Array items:
    - **slug** (string) (required)
    - **code** (string) (required)
    - **message** (string) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Parâmetros inválidos.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Token ausente ou inválido.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Plano sem acesso ao módulo de macroeconomia.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno.

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/macro/latest?symbols=selic,cdi,ipca"
```

```

--------------------------------

### GET /api/v2/futures/specs

Source: https://brapi.dev/swagger/latest.json

Retorna só os dados do contrato (vencimento, multiplicador, lote, ISIN), sem preço.

```markdown
### Parameters

- **symbols** (string, query, required) (example: "WINM26,BGIF27,DI1F27")

### Responses

#### 200 - Especificações.

**FutureSpecsResponse**
- **specs** (array (FutureSpecs)) (required)
  Array items:
    - **symbol** (string) (required): Código do contrato (ex.: `WINM26`, `BGIF27`, `DI1F27`).
    - **underlyingAsset** (string) (required): Código do ativo (ex.: `WIN`, `BGI`, `DI1`).
    - **assetDescription** (string) (required): Nome do ativo em português.
    - **segment** (string (financial|agribusiness)) (required): `financial` = índices, juros e moeda. `agribusiness` = commodities. ("financial"|"agribusiness")
    - **quotationType** (string (price|rate)) (required): `rate` para juros (DI/DAP) — OHLC vem em %a.a. `price` para os demais. ("price"|"rate")
    - **expirationDate** (string) (required): Data de vencimento (YYYY-MM-DD).
    - **firstTradeDate** (string) (required): Data do primeiro pregão.
    - **lastTradeDate** (string) (required): Data do último pregão.
    - **contractMultiplier** (number) (required): Quanto vale cada ponto. Ex.: WIN = 0,2; BGI = 330; DI1 = 1.
    - **allocationRoundLot** (integer) (required): Tamanho do lote.
    - **tradingCurrency** (string) (required): Moeda (quase sempre `BRL`).
    - **deliveryType** (string) (required): Tipo de entrega: `Financial` ou `Physical`.
    - **exerciseType** (string) (required): Tipo de cotação: `Price` ou `Rate`.
    - **isin** (string) (required): Código ISIN.
    - **cficCode** (string) (required): Código CFI.
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Requisição inválida

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Não autorizado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Acesso negado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno do servidor

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/futures/specs?symbols=WINM26,BGIF27,DI1F27"
```

```

--------------------------------

### GET /api/v2/futures/options/expirations

Source: https://brapi.dev/swagger/latest.json

Lista os vencimentos disponíveis das opções sobre um futuro.

```markdown
### Parameters

- **underlying** (string, query, required) (example: "BGI")
- **includeExpired** (string (true|false), query, optional)

### Responses

#### 200 - Vencimentos.

**FutureOptionExpirationsResponse**
- **underlying** (string) (required)
- **expirations** (array (string)) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Requisição inválida

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Não autorizado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Acesso negado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno do servidor

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/futures/options/expirations?underlying=BGI&includeExpired=false"
```

```

--------------------------------

### GET /api/v2/user/usage

Source: https://brapi.dev/swagger/latest.json


Retorna o uso atual da conta autenticada com dados frescos do Postgres.

### O que retorna

* `planName` — plano atual da conta (`free`, `startup`, `pro`)
* `planLimit` — limite de requisições do plano
* `currentUsage` — uso atual contabilizado no banco
* `remainingUsage` — saldo restante dentro da janela atual
* `usageWindow` — janela usada para contagem (`billing-cycle` ou `rolling-30d`)
* `subscriptionPeriod` — período atual de assinatura salvo no usuário

### Autenticação

Bearer token ou query param `token`.

### Exemplo

```bash
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/user/usage"
```


```markdown
### Responses

#### 200 - Uso da conta retornado com sucesso.

**UserUsageResponse**
- **usage** (object) (required)
  - **planName** (string (free|startup|pro)) (required) ("free"|"startup"|"pro")
  - **planLimit** (integer) (required)
  - **currentUsage** (integer) (required)
  - **remainingUsage** (integer) (required)
  - **usageWindow** (object) (required)
    - **type** (string (billing-cycle|rolling-30d)) (required) ("billing-cycle"|"rolling-30d")
    - **start** (string (date-time)) (required)
    - **end** (string (date-time)) (required)
  - **subscriptionPeriod** (object) (required)
    - **start** (string (date-time)) (required)
    - **end** (string (date-time)) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 401 - Token ausente, inválido ou inativo.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 404 - Usuário associado ao token não encontrado.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno ao buscar o uso da conta.

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/user/usage"
```

```

--------------------------------

### GET /api/v2/macro

Source: https://brapi.dev/swagger/latest.json


Retorna observações históricas para uma ou mais séries macroeconômicas
brasileiras (taxas de juros, inflação, agregados monetários e atividade).


```markdown
### Parameters

- **symbols** (string, query, required) (example: "selic,ipca")
- **startDate** (string, query, optional) (example: "2025-01-01")
- **endDate** (string, query, optional) (example: "2026-04-30")
- **sortOrder** (string (asc|desc), query, optional) (example: "desc")
- **limit** (integer, query, optional) (example: 20)

### Responses

#### 200 - Observações retornadas com sucesso.

**MacroSeriesDataResponse**
- **results** (array (MacroSeriesResult)) (required)
  Array items:
    - **series** (object) (required) (example: {"slug":"selic","name":"Taxa Selic","description":"Taxa básica de juros da economia brasileira, definida pelo COPOM (Comitê de Política Monetária) do Banco Central. É a referência para todas as demais taxas de juros do país.","unit":"percentPerYear","frequency":"daily","category":"interestRate","startDate":"1999-03-05"})
      - **slug** (string) (required)
      - **name** (string) (required)
      - **description** (string) (required)
      - **unit** (string) (required)
      - **frequency** (string) (required)
      - **category** (string) (required)
      - **startDate** (string) (required)
    - **observations** (array (MacroSeriesObservation)) (required)
      Array items:
        - **date** (string) (required) (example: "2026-04-30")
        - **value** (number) (required) (example: 14.75)
- **warnings** (array (MacroSeriesAliasWarning))
  Array items:
    - **provided** (string) (required)
    - **canonicalSlug** (string) (required)
    - **message** (string) (required)
- **errors** (array (MacroSeriesError))
  Array items:
    - **slug** (string) (required)
    - **code** (string) (required)
    - **message** (string) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Parâmetros inválidos.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Token ausente ou inválido.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Plano sem acesso ao módulo de macroeconomia.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno.

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/macro?symbols=selic,ipca&startDate=2025-01-01&endDate=2026-04-30&sortOrder=desc&limit=20"
```

```

--------------------------------

### GET /api/v2/currency/available

Source: https://brapi.dev/swagger/latest.json


Retorna a lista de pares de moedas disponíveis para consulta no endpoint `/api/v2/currency`.

### Formato:
ORIGEM-DESTINO, onde ORIGEM é o código da moeda de origem e DESTINO a moeda de destino

### Pares Disponíveis:
*   **Moedas Fiduciárias:** USD-BRL, EUR-BRL, GBP-BRL, ARS-BRL, CAD-BRL, AUD-BRL, JPY-BRL, CNY-BRL
*   **Cross Rates:** EUR-USD, GBP-USD
*   **Criptomoedas:** BTC-BRL, ETH-BRL

### Exemplos de Requisição:
```bash
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/currency/available"
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/currency/available?search=USD"
```

**Plano Mínimo:** Startup
**Autenticação:** Necessária


```markdown
### Parameters

- **search** (string, query, optional) (example: "USD")

### Responses

#### 200 - Lista de pares de moedas disponíveis retornada com sucesso.

**CurrencyAvailableResponse**
- **currencies** (array (object)) (required)
  Array items:
    - **name** (string) (required)
    - **currency** (string) (required)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/currency/available?search=USD"
```

```

--------------------------------

### GET /api/v2/inflation/available

Source: https://brapi.dev/swagger/latest.json


Retorna a lista de países disponíveis para consulta de dados de inflação.

### Países Disponíveis

*   **brazil** — Dados do IPCA (IBGE)

Use o valor retornado como referência para futuras expansões do endpoint.

### Exemplo de Uso

```bash
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/inflation/available"
```

**Plano Mínimo:** Startup | **Autenticação:** Necessária


```markdown
### Responses

#### 200 - Lista de países disponíveis para dados de inflação retornada com sucesso.

**InflationAvailableResponse**
- **countries** (array (string)) (required)
- **message** (string) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/inflation/available"
```

```

--------------------------------

### GET /api/v2/treasury/list

Source: https://brapi.dev/swagger/latest.json

Retorna os títulos do Tesouro Direto atualmente ofertados, com taxas e preços indicativos mais recentes. Requer plano Pro, exceto pelos três títulos sandbox documentados.

```markdown
### Parameters

- **page** (integer, query, optional) (example: 1)
- **limit** (integer, query, optional) (example: 20)
- **search** (string, query, optional) (example: "tesouro-selic-01032031")
- **indexer** (string (selic|prefixado|ipca|igpm), query, optional) (example: "selic")
- **couponType** (string (zero|semestral), query, optional) (example: "zero")
- **sortBy** (string (symbol|bondType|maturityDate|durationDays|baseDate|buyRate|sellRate|buyPrice|sellPrice|basePrice), query, optional) (example: "maturityDate")
- **sortOrder** (string (asc|desc), query, optional) (example: "asc")

### Responses

#### 200 - Lista paginada de títulos do Tesouro Direto

**TreasuryListResponse**
- **results** (array (TreasuryListItem)) (required)
  Array items:
    - **symbol** (string) (required): Slug público do título do Tesouro Direto (example: "tesouro-selic-01032031")
    - **bondType** (string) (required): Nome público do título (example: "Tesouro Selic")
    - **indexer** (string (selic|prefixado|ipca|igpm)) (required): Indexador normalizado do título (example: "selic") ("selic"|"prefixado"|"ipca"|"igpm")
    - **couponType** (string (zero|semestral)) (required): Tipo de pagamento de juros do título (example: "zero") ("zero"|"semestral")
    - **maturityDate** (string) (required): Data de vencimento no formato YYYY-MM-DD (example: "2031-03-01")
    - **durationDays** (number) (required): Dias corridos entre a data-base e o vencimento (example: 1751)
    - **baseDate** (string) (required): Data-base da cotação no formato YYYY-MM-DD (example: "2026-05-15")
    - **buyRate** (number) (required): Taxa indicativa de compra em % a.a. Unidade: Tesouro Selic = spread (% a.a.) sobre a taxa Selic; Tesouro Prefixado = rendimento nominal (% a.a.); Tesouro IPCA = rendimento real (% a.a.) acima do IPCA. (example: 0.08)
    - **sellRate** (number) (required): Taxa indicativa de venda em % a.a. Unidade: Tesouro Selic = spread (% a.a.) sobre a taxa Selic; Tesouro Prefixado = rendimento nominal (% a.a.); Tesouro IPCA = rendimento real (% a.a.) acima do IPCA. (example: 0.09)
    - **buyPrice** (number) (required): Preço unitário indicativo de compra em BRL (example: 18944.78)
    - **sellPrice** (number) (required): Preço unitário indicativo de venda em BRL (example: 18925.53)
    - **basePrice** (number) (required): Preço unitário base em BRL (example: 18925.53)
    - **rateInfo** (object) (required): Metadados para interpretar buyRate e sellRate. As taxas têm significados diferentes conforme o indexador.
      - **rateType** (string (spreadOverSelic|nominalAnnualRate|realAnnualRateOverIpca|realAnnualRateOverIgpm)) (required): Tipo de interpretação para buyRate e sellRate (example: "spreadOverSelic") ("spreadOverSelic"|"nominalAnnualRate"|"realAnnualRateOverIpca"|"realAnnualRateOverIgpm")
      - **rateUnit** (string) (required): Unidade das taxas buyRate e sellRate (example: "% a.a.")
      - **description** (string) (required): Descrição textual de como interpretar buyRate e sellRate para o indexador do título (example: "Para Tesouro Selic, buyRate e sellRate representam o spread em pontos percentuais ao ano sobre a taxa Selic, não a rentabilidade total do título.")
- **pagination** (object) (required)
  - **page** (number) (required)
  - **limit** (number) (required)
  - **totalItems** (number) (required)
  - **totalPages** (number) (required)
  - **hasNextPage** (boolean) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Requisição inválida

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Não autorizado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Acesso negado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 404 - Não encontrado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 429 - Limite de requisições excedido

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno do servidor

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 503 - Serviço externo temporariamente indisponível

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/treasury/list?page=1&limit=20&search=tesouro-selic-01032031&indexer=selic&couponType=zero&sortBy=maturityDate&sortOrder=asc"
```

```

--------------------------------

### GET /api/v2/prime-rate/available

Source: https://brapi.dev/swagger/latest.json


Retorna a lista de países disponíveis para consulta de dados de taxa de juros.

### Países Disponíveis

*   **brazil** — Taxa SELIC (Banco Central)

Use o valor retornado como referência para futuras expansões do endpoint.

### Exemplo de Uso

```bash
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/prime-rate/available"
```

**Plano Mínimo:** Startup | **Autenticação:** Necessária


```markdown
### Responses

#### 200 - Lista de países disponíveis para dados de taxa de juros retornada com sucesso.

**PrimeRateAvailableResponse**
- **countries** (array (string)) (required)
- **message** (string) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/prime-rate/available"
```

```

--------------------------------

### GET /api/v2/options/chain

Source: https://brapi.dev/swagger/latest.json

Retorna as séries negociadas de um vencimento, combinando metadados do contrato com o último OHLCV disponível até a data solicitada. Sem token, o sandbox aceita apenas `underlying=PETR4`.

```markdown
### Parameters

- **underlying** (string, query, required) (example: "PETR4")
- **expirationDate** (string, query, required) (example: "2026-05-15")
- **date** (string, query, optional) (example: "2026-04-17")
- **side** (string (call|put), query, optional)
- **minStrike** (number, query, optional)
- **maxStrike** (number, query, optional)

### Responses

#### 200 - Séries retornadas com sucesso.

**OptionSeriesResponse**
- **underlying** (string) (required): Ativo subjacente consultado, normalizado em maiúsculas.
- **expirationDate** (string) (required): Vencimento consultado, no formato YYYY-MM-DD.
- **date** (string) (required): Data EOD efetivamente usada para buscar preço e volume, no formato YYYY-MM-DD.
- **tradedOnly** (boolean) (required): Sempre `true`: só aparecem séries que tiveram negócio no pregão selecionado. ("true")
- **series** (array (OptionSeriesSnapshot)) (required): Séries negociadas no vencimento, com metadados do contrato e OHLCV do pregão em `date`.
  Array items:
    - **symbol** (string) (required): Código de negociação da série (ex: PETRE370).
    - **underlyingSymbol** (string) (required): Ativo subjacente da opção (ex: PETR4).
    - **side** (string (call|put)) (required): Tipo da opção: `call` (opção de compra) ou `put` (opção de venda). ("call"|"put")
    - **market** (string (equity|index)) (required): Mercado da opção: `equity` (ação/ETF) ou `index` (índice). ("equity"|"index")
    - **optionStyle** (string (american|european)) (required): Estilo de exercício da opção: `american` permite exercício a qualquer momento até o vencimento; `european` permite exercício apenas no vencimento. `null` em séries antigas que ainda não passaram pelo enriquecimento de cadastro. ("american"|"european")
    - **strike** (number) (required): Preço de exercício (strike) da opção.
    - **allocationRoundLot** (integer) (required): Tamanho do lote pré-definido para alocação. Geralmente 100 para opções sobre ações brasileiras.
    - **expirationDate** (string) (required): Data de vencimento da série, no formato YYYY-MM-DD.
    - **firstTradeDate** (string) (required): Data do primeiro pregão observado para a série (YYYY-MM-DD).
    - **lastTradeDate** (string) (required): Data do último pregão observado para a série (YYYY-MM-DD).
    - **date** (integer) (required): Data do pregão em timestamp Unix (segundos).
    - **open** (number) (required): Preço de abertura do pregão.
    - **high** (number) (required): Máxima do pregão.
    - **low** (number) (required): Mínima do pregão.
    - **average** (number) (required): Preço médio do pregão.
    - **close** (number) (required): Preço de fechamento do pregão.
    - **bid** (number) (required): Melhor oferta de compra registrada no fechamento.
    - **ask** (number) (required): Melhor oferta de venda registrada no fechamento.
    - **trades** (number) (required): Número de negócios realizados no pregão.
    - **volume** (number) (required): Volume negociado no pregão (em contratos).
    - **financialVolume** (number) (required): Volume financeiro negociado no pregão (em BRL).
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Requisição inválida

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Não autorizado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Acesso negado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 404 - Não encontrado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno do servidor

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/options/chain?underlying=PETR4&expirationDate=2026-05-15&date=2026-04-17&side=call&minStrike=0&maxStrike=0"
```

```

--------------------------------

### GET /api/v2/macro/available

Source: https://brapi.dev/swagger/latest.json


Lista as séries macroeconômicas disponíveis com slug, nome, unidade, frequência,
categoria e data de início do histórico. Endpoint público (use para descobrir
slugs antes de chamar `/api/v2/macro` ou `/api/v2/macro/latest`).

### Filtros opcionais

- `q` — busca textual em slug, alias, nome e descrição (case-insensitive).
  Quando presente, os resultados vêm ordenados por relevância.
- `category` — filtra por categoria (ex: `interestRate`, `inflation`).

Os filtros podem ser combinados.


```markdown
### Parameters

- **q** (string, query, optional) (example: "juros")
- **category** (string, query, optional) (example: "interestRate")

### Responses

#### 200 - Lista de séries disponíveis retornada com sucesso.

**MacroAvailableResponse**
- **results** (array (MacroSeriesPublic)) (required): Lista de séries macroeconômicas. Quando `q` é informado, vem ordenada por relevância (slug > alias > nome > descrição).
  Array items:
    - **slug** (string) (required)
    - **name** (string) (required)
    - **description** (string) (required)
    - **unit** (string) (required)
    - **frequency** (string) (required)
    - **category** (string) (required)
    - **startDate** (string) (required)
- **categories** (array (string)) (required): Todas as categorias do catálogo. Não é afetado pelos filtros — sempre lista o universo completo de categorias para que o cliente possa montar facetas.
- **count** (integer) (required): Quantidade de séries em `results` após aplicar os filtros.
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/macro/available?q=juros&category=interestRate"
```

```

--------------------------------

### GET /api/v2/futures/options/historical

Source: https://brapi.dev/swagger/latest.json

Série diária de uma opção sobre futuro, com OHLC e volume.

```markdown
### Parameters

- **symbol** (string, query, required) (example: "BGIK26C034300")
- **startDate** (string, query, optional)
- **endDate** (string, query, optional)
- **sortOrder** (string (asc|desc), query, optional)

### Responses

#### 200 - Histórico.

**FutureOptionHistoricalResponse**
- **option** (object) (required)
  - **symbol** (string) (required): Código da opção (ex.: `BGIH27C028550`).
  - **underlyingAsset** (string) (required): Código do ativo (ex.: `BGI`).
  - **underlyingFuture** (string) (required): Contrato futuro de base, quando existir.
  - **optionType** (string (call|put)) (required): `call` (compra) ou `put` (venda). ("call"|"put")
  - **optionStyle** (string (american|european)) (required): `american` (exerce a qualquer momento) ou `european` (só no vencimento). ("american"|"european")
  - **segment** (string (financial|agribusiness)) (required): `financial` ou `agribusiness`. ("financial"|"agribusiness")
  - **strike** (number) (required): Strike (preço combinado).
  - **expirationDate** (string) (required): Data de vencimento (YYYY-MM-DD).
  - **firstTradeDate** (string) (required): Data do primeiro pregão.
  - **lastTradeDate** (string) (required): Data do último pregão.
  - **contractMultiplier** (number) (required): Multiplicador (vem do futuro de base).
  - **allocationRoundLot** (integer) (required): Tamanho do lote.
  - **exerciseType** (string) (required): Tipo de exercício.
  - **automaticExercise** (boolean) (required): `true` se a opção é exercida sozinha no vencimento.
  - **premiumUpfront** (boolean) (required): `true` se o prêmio é pago à vista, `false` se é diferido.
  - **isin** (string) (required): Código ISIN.
  - **cficCode** (string) (required): Código CFI.
  - **history** (array (FutureOptionPricePoint)) (required)
    Array items:
      - **date** (integer) (required): Data do pregão (Unix em segundos).
      - **open** (number) (required): Abertura.
      - **high** (number) (required): Máxima.
      - **low** (number) (required): Mínima.
      - **average** (number) (required): Preço médio.
      - **close** (number) (required): Fechamento.
      - **referencePrice** (number) (required): Preço de referência oficial.
      - **oscillationPct** (number) (required): Variação % em relação ao dia anterior.
      - **trades** (number) (required): Número de negócios.
      - **volume** (number) (required): Quantidade de contratos negociados.
      - **financialVolume** (number) (required): Volume em reais (BRL).
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - Requisição inválida

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - Não autorizado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - Acesso negado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 404 - Não encontrado

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - Erro interno do servidor

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/futures/options/historical?symbol=BGIK26C034300&startDate=string&endDate=string&sortOrder=desc"
```

```

--------------------------------

### GET /api/v2/currency

Source: https://brapi.dev/swagger/latest.json


Retorna cotações atualizadas de pares de moedas, com preço de compra/venda, variação e extremos do dia.

### Funcionalidades:
*   **Cotação Atual:** Preço de compra (bid), venda (ask), máxima, mínima, variação
*   **Múltiplos Pares:** Consulte vários em uma requisição (separados por vírgula)
*   **Formato:** `ORIGEM-DESTINO` (ex: `USD-BRL`)

### Autenticação:
Bearer token ou query param `token`. Obtenha em brapi.dev/dashboard.

### Exemplos de Requisição:
```bash
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/currency?currency=USD-BRL"
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/currency?currency=USD-BRL,EUR-BRL,GBP-BRL"
curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/currency?currency=BTC-BRL"
```

### Pares de Moedas Populares:
*   `USD-BRL` — Dólar Americano / Real
*   `EUR-BRL` — Euro / Real
*   `GBP-BRL` — Libra Esterlina / Real
*   `ARS-BRL` — Peso Argentino / Real
*   `EUR-USD` — Euro / Dólar
*   `BTC-BRL` — Bitcoin / Real
*   `ETH-BRL` — Ethereum / Real

### Campos da Resposta:
*   `fromCurrency` / `toCurrency` — Par de moedas
*   `name` — Nome do par
*   `bidPrice` — Preço de compra
*   `askPrice` — Preço de venda
*   `high` / `low` — Máxima/Mínima do dia
*   `bidVariation` — Variação do preço de compra
*   `percentageChange` — Variação percentual (%)

### Fonte dos Dados:
Banco Central do Brasil (PTAX) / Yahoo Finance

**Plano Mínimo:** Startup
**Autenticação:** Necessária


```markdown
### Parameters

- **currency** (string, query, optional) (example: "USD-BRL")

### Responses

#### 200 - Cotações dos pares de moedas solicitados retornadas com sucesso.

**CurrencyResponseSimple**
- **currency** (array (CurrencyQuoteSimple)) (required)
  Array items:
    - **fromCurrency** (string) (required)
    - **toCurrency** (string) (required)
    - **name** (string) (required)
    - **high** (string) (required)
    - **low** (string) (required)
    - **bidVariation** (string) (required)
    - **percentageChange** (string) (required)
    - **bidPrice** (string) (required)
    - **askPrice** (string) (required)
    - **updatedAtTimestamp** (string) (required)
    - **updatedAtDate** (string) (required)
- **requestedAt** (string (date-time)) (required): Data e hora da requisição em formato ISO 8601 (example: "2025-01-24T17:32:38.000Z")
- **took** (integer) (required): Tempo de processamento em milissegundos (example: 45)

#### 400 - **Requisição Inválida.** Parâmetro `currency` não fornecido ou formato inválido.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 401 - **Não Autorizado.** Token de autenticação não fornecido ou inválido.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 403 - **Acesso Proibido.** Seu plano não tem acesso ao módulo de câmbio.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 500 - **Erro Interno.** Erro interno ao processar a requisição.

**ErrorResponse**
- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

#### 503 - **Serviço Indisponível.** Serviço externo temporariamente indisponível.

- **error** (boolean) (required) ("true")
- **message** (string) (required)
- **code** (string)

### Example Usage

```bash
curl -X GET "https://brapi.dev/api/v2/currency?currency=USD-BRL"
```

```