Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
lint:
timeout-minutes: 10
name: lint
runs-on: ${{ github.repository == 'stainless-sdks/brapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
Expand All @@ -44,7 +44,7 @@ jobs:
permissions:
contents: read
id-token: write
runs-on: ${{ github.repository == 'stainless-sdks/brapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

Expand Down Expand Up @@ -84,7 +84,7 @@ jobs:
test:
timeout-minutes: 10
name: test
runs-on: ${{ github.repository == 'stainless-sdks/brapi-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
Expand Down
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "1.6.0"
".": "1.7.0"
}
4 changes: 2 additions & 2 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 11
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson/brapi-763c52c3811b3a28985947ecdba690fa83368b40c6dbd27ac740c241d52ea2a8.yml
openapi_spec_hash: 4020950d95877b91e854f0e1917341b1
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson/brapi-cd497ed299df95a41e4d2132fd412d0fa7c4464e96594478869e8f02baf57d45.yml
openapi_spec_hash: d16e0ab2614dd2530cf3c8c350a4d8ca
config_hash: 14da4c1963f3e0764a3e82d626a1d762
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Changelog

## 1.7.0 (2026-09-04)

Full Changelog: [v1.6.0...v1.7.0](https://github.com/brapi-dev/brapi-python/compare/v1.6.0...v1.7.0)

### Features

* **api:** api update ([846d1cc](https://github.com/brapi-dev/brapi-python/commit/846d1cc7b3963e8253ba9aa0f534c7c0c5a15854))
* **api:** api update ([fd52eeb](https://github.com/brapi-dev/brapi-python/commit/fd52eebdf6030812a49dbd949418146de3b9eee9))
* **api:** api update ([4ad61a5](https://github.com/brapi-dev/brapi-python/commit/4ad61a5d636f09dc6ec038adcef069a61f6ccc59))
* **api:** api update ([bc65837](https://github.com/brapi-dev/brapi-python/commit/bc658373787b240ee985a587901aa8d9ad2532a3))
* **api:** api update ([4d2bc0a](https://github.com/brapi-dev/brapi-python/commit/4d2bc0aab3ce83a2ee54198df763edac1c338470))
* **api:** api update ([ea7470f](https://github.com/brapi-dev/brapi-python/commit/ea7470f791b60a043840d9ea5c7cc5e64832baa3))
* **api:** api update ([26541f2](https://github.com/brapi-dev/brapi-python/commit/26541f26d59fb1c56c09d3eb229dc3aaba57edc1))
* **api:** api update ([bb284b5](https://github.com/brapi-dev/brapi-python/commit/bb284b566f4543033d89fd10055457d7a6d7bd70))
* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([7e697d6](https://github.com/brapi-dev/brapi-python/commit/7e697d6099b1e28a9babeb18df7f81749d7f23f8))

## 1.6.0 (2026-07-10)

Full Changelog: [v1.5.0...v1.6.0](https://github.com/brapi-dev/brapi-python/compare/v1.5.0...v1.6.0)
Expand Down
4 changes: 2 additions & 2 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ from brapi.types.v2 import InflationRetrieveResponse, InflationListAvailableResp
Methods:

- <code title="get /api/v2/inflation">client.v2.inflation.<a href="./src/brapi/resources/v2/inflation.py">retrieve</a>(\*\*<a href="src/brapi/types/v2/inflation_retrieve_params.py">params</a>) -> <a href="./src/brapi/types/v2/inflation_retrieve_response.py">InflationRetrieveResponse</a></code>
- <code title="get /api/v2/inflation/available">client.v2.inflation.<a href="./src/brapi/resources/v2/inflation.py">list_available</a>() -> <a href="./src/brapi/types/v2/inflation_list_available_response.py">InflationListAvailableResponse</a></code>
- <code title="get /api/v2/inflation/available">client.v2.inflation.<a href="./src/brapi/resources/v2/inflation.py">list_available</a>(\*\*<a href="src/brapi/types/v2/inflation_list_available_params.py">params</a>) -> <a href="./src/brapi/types/v2/inflation_list_available_response.py">InflationListAvailableResponse</a></code>

## PrimeRate

Expand All @@ -80,4 +80,4 @@ from brapi.types.v2 import PrimeRateRetrieveResponse, PrimeRateListAvailableResp
Methods:

- <code title="get /api/v2/prime-rate">client.v2.prime_rate.<a href="./src/brapi/resources/v2/prime_rate.py">retrieve</a>(\*\*<a href="src/brapi/types/v2/prime_rate_retrieve_params.py">params</a>) -> <a href="./src/brapi/types/v2/prime_rate_retrieve_response.py">PrimeRateRetrieveResponse</a></code>
- <code title="get /api/v2/prime-rate/available">client.v2.prime_rate.<a href="./src/brapi/resources/v2/prime_rate.py">list_available</a>() -> <a href="./src/brapi/types/v2/prime_rate_list_available_response.py">PrimeRateListAvailableResponse</a></code>
- <code title="get /api/v2/prime-rate/available">client.v2.prime_rate.<a href="./src/brapi/resources/v2/prime_rate.py">list_available</a>(\*\*<a href="src/brapi/types/v2/prime_rate_list_available_params.py">params</a>) -> <a href="./src/brapi/types/v2/prime_rate_list_available_response.py">PrimeRateListAvailableResponse</a></code>
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "brapi"
version = "1.6.0"
version = "1.7.0"
description = "The official Python library for the brapi API"
dynamic = ["readme"]
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion src/brapi/_version.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

__title__ = "brapi"
__version__ = "1.6.0" # x-release-please-version
__version__ = "1.7.0" # x-release-please-version
94 changes: 12 additions & 82 deletions src/brapi/resources/available.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,54 +57,19 @@ def list(
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AvailableListResponse:
"""
Retorna a lista completa de **ações e índices** disponíveis para consulta na API
brapi.
Lista todos os ativos que a API aceita: ações, FIIs, BDRs e ETFs da B3, mais os
índices com cotação disponível.

### Funcionalidades

- **Ações brasileiras:** Todas as ações, FIIs, BDRs e ETFs negociados na bolsa
brasileira
- **Índices:** Índices do mercado brasileiro com cotação disponível na API
- **Filtro por Nome:** Use `search` para filtrar por código ou nome do ativo

### Características

- **Sem Autenticação:** Este endpoint é **público** e não requer token
- **Cache:** Dados cacheados por 15 minutos
- **Atualização automática:** Conforme novos ativos são listados na bolsa
brasileira

### Exemplos de Uso
Filtre por código ou nome com `search`.

```bash
# Listar todos os ativos
curl "https://brapi.dev/api/available"

# Buscar por código de ticker
curl "https://brapi.dev/api/available?search=PETR"

# Buscar por nome da empresa
curl "https://brapi.dev/api/available?search=banco"
```

### Índices Disponíveis

- `^BVSP` — Ibovespa (Índice Bovespa)
- `IFIX.SA` — Índice de Fundos Imobiliários

### Campos da Resposta

- `stocks` — Array com códigos das ações (ex: ["PETR4", "VALE3", "ITUB4", ...])
- `indexes` — Array com códigos dos índices (ex: ["^BVSP", "IFIX.SA"])

### Como Usar

Use os códigos retornados como parâmetro no endpoint `/api/quote/{tickers}` para
obter cotações detalhadas.

**Fonte:** Bolsa de Valores do Brasil
Endpoint público, sem token. A resposta fica em cache por 15 minutos e é
atualizada conforme novos ativos entram na bolsa.

**Plano Mínimo:** Gratuito **Autenticação:** Não necessária (Público)
Para busca com filtros por setor e tipo, `/api/v2/tickers` é mais completo.

Args:
search: Filtrar ações e índices por nome ou código
Expand Down Expand Up @@ -166,54 +131,19 @@ async def list(
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AvailableListResponse:
"""
Retorna a lista completa de **ações e índices** disponíveis para consulta na API
brapi.
Lista todos os ativos que a API aceita: ações, FIIs, BDRs e ETFs da B3, mais os
índices com cotação disponível.

### Funcionalidades

- **Ações brasileiras:** Todas as ações, FIIs, BDRs e ETFs negociados na bolsa
brasileira
- **Índices:** Índices do mercado brasileiro com cotação disponível na API
- **Filtro por Nome:** Use `search` para filtrar por código ou nome do ativo

### Características

- **Sem Autenticação:** Este endpoint é **público** e não requer token
- **Cache:** Dados cacheados por 15 minutos
- **Atualização automática:** Conforme novos ativos são listados na bolsa
brasileira

### Exemplos de Uso
Filtre por código ou nome com `search`.

```bash
# Listar todos os ativos
curl "https://brapi.dev/api/available"

# Buscar por código de ticker
curl "https://brapi.dev/api/available?search=PETR"

# Buscar por nome da empresa
curl "https://brapi.dev/api/available?search=banco"
```

### Índices Disponíveis

- `^BVSP` — Ibovespa (Índice Bovespa)
- `IFIX.SA` — Índice de Fundos Imobiliários

### Campos da Resposta

- `stocks` — Array com códigos das ações (ex: ["PETR4", "VALE3", "ITUB4", ...])
- `indexes` — Array com códigos dos índices (ex: ["^BVSP", "IFIX.SA"])

### Como Usar

Use os códigos retornados como parâmetro no endpoint `/api/quote/{tickers}` para
obter cotações detalhadas.

**Fonte:** Bolsa de Valores do Brasil
Endpoint público, sem token. A resposta fica em cache por 15 minutos e é
atualizada conforme novos ativos entram na bolsa.

**Plano Mínimo:** Gratuito **Autenticação:** Não necessária (Público)
Para busca com filtros por setor e tipo, `/api/v2/tickers` é mais completo.

Args:
search: Filtrar ações e índices por nome ou código
Expand Down
Loading