Skip to content

Commit bc65837

Browse files
feat(api): api update
1 parent 4d2bc0a commit bc65837

7 files changed

Lines changed: 226 additions & 898 deletions

File tree

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 11
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson/brapi-359f89054dab22e3dffa5cafe68b850e29aa8ae5db8255c05b7725eb62f7de35.yml
3-
openapi_spec_hash: 601cd66134e2fbafe8a4b5af630696e6
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson/brapi-6c102060673bc8962504a7e74d88104e79435ac406ba732b58337b7255e4efa2.yml
3+
openapi_spec_hash: a602ef75a89ae4b3fb3da40fa6d9992d
44
config_hash: 14da4c1963f3e0764a3e82d626a1d762

‎src/brapi/resources/available.py‎

Lines changed: 12 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -57,54 +57,19 @@ def list(
5757
timeout: float | httpx.Timeout | None | NotGiven = not_given,
5858
) -> AvailableListResponse:
5959
"""
60-
Retorna a lista completa de **ações e índices** disponíveis para consulta na API
61-
brapi.
60+
Lista todos os ativos que a API aceita: ações, FIIs, BDRs e ETFs da B3, mais os
61+
índices com cotação disponível.
6262
63-
### Funcionalidades
64-
65-
- **Ações brasileiras:** Todas as ações, FIIs, BDRs e ETFs negociados na bolsa
66-
brasileira
67-
- **Índices:** Índices do mercado brasileiro com cotação disponível na API
68-
- **Filtro por Nome:** Use `search` para filtrar por código ou nome do ativo
69-
70-
### Características
71-
72-
- **Sem Autenticação:** Este endpoint é **público** e não requer token
73-
- **Cache:** Dados cacheados por 15 minutos
74-
- **Atualização automática:** Conforme novos ativos são listados na bolsa
75-
brasileira
76-
77-
### Exemplos de Uso
63+
Filtre por código ou nome com `search`.
7864
7965
```bash
80-
# Listar todos os ativos
81-
curl "https://brapi.dev/api/available"
82-
83-
# Buscar por código de ticker
8466
curl "https://brapi.dev/api/available?search=PETR"
85-
86-
# Buscar por nome da empresa
87-
curl "https://brapi.dev/api/available?search=banco"
8867
```
8968
90-
### Índices Disponíveis
91-
92-
- `^BVSP` - Ibovespa (Índice Bovespa)
93-
- `IFIX.SA` - Índice de Fundos Imobiliários
94-
95-
### Campos da Resposta
96-
97-
- `stocks` - Array com códigos das ações (ex: ["PETR4", "VALE3", "ITUB4", ...])
98-
- `indexes` - Array com códigos dos índices (ex: ["^BVSP", "IFIX.SA"])
99-
100-
### Como Usar
101-
102-
Use os códigos retornados como parâmetro no endpoint `/api/quote/{tickers}` para
103-
obter cotações detalhadas.
104-
105-
**Fonte:** Bolsa de Valores do Brasil
69+
Endpoint público, sem token. A resposta fica em cache por 15 minutos e é
70+
atualizada conforme novos ativos entram na bolsa.
10671
107-
**Plano Mínimo:** Gratuito **Autenticação:** Não necessária (Público)
72+
Para busca com filtros por setor e tipo, `/api/v2/tickers` é mais completo.
10873
10974
Args:
11075
search: Filtrar ações e índices por nome ou código
@@ -166,54 +131,19 @@ async def list(
166131
timeout: float | httpx.Timeout | None | NotGiven = not_given,
167132
) -> AvailableListResponse:
168133
"""
169-
Retorna a lista completa de **ações e índices** disponíveis para consulta na API
170-
brapi.
134+
Lista todos os ativos que a API aceita: ações, FIIs, BDRs e ETFs da B3, mais os
135+
índices com cotação disponível.
171136
172-
### Funcionalidades
173-
174-
- **Ações brasileiras:** Todas as ações, FIIs, BDRs e ETFs negociados na bolsa
175-
brasileira
176-
- **Índices:** Índices do mercado brasileiro com cotação disponível na API
177-
- **Filtro por Nome:** Use `search` para filtrar por código ou nome do ativo
178-
179-
### Características
180-
181-
- **Sem Autenticação:** Este endpoint é **público** e não requer token
182-
- **Cache:** Dados cacheados por 15 minutos
183-
- **Atualização automática:** Conforme novos ativos são listados na bolsa
184-
brasileira
185-
186-
### Exemplos de Uso
137+
Filtre por código ou nome com `search`.
187138
188139
```bash
189-
# Listar todos os ativos
190-
curl "https://brapi.dev/api/available"
191-
192-
# Buscar por código de ticker
193140
curl "https://brapi.dev/api/available?search=PETR"
194-
195-
# Buscar por nome da empresa
196-
curl "https://brapi.dev/api/available?search=banco"
197141
```
198142
199-
### Índices Disponíveis
200-
201-
- `^BVSP` - Ibovespa (Índice Bovespa)
202-
- `IFIX.SA` - Índice de Fundos Imobiliários
203-
204-
### Campos da Resposta
205-
206-
- `stocks` - Array com códigos das ações (ex: ["PETR4", "VALE3", "ITUB4", ...])
207-
- `indexes` - Array com códigos dos índices (ex: ["^BVSP", "IFIX.SA"])
208-
209-
### Como Usar
210-
211-
Use os códigos retornados como parâmetro no endpoint `/api/quote/{tickers}` para
212-
obter cotações detalhadas.
213-
214-
**Fonte:** Bolsa de Valores do Brasil
143+
Endpoint público, sem token. A resposta fica em cache por 15 minutos e é
144+
atualizada conforme novos ativos entram na bolsa.
215145
216-
**Plano Mínimo:** Gratuito **Autenticação:** Não necessária (Público)
146+
Para busca com filtros por setor e tipo, `/api/v2/tickers` é mais completo.
217147
218148
Args:
219149
search: Filtrar ações e índices por nome ou código

0 commit comments

Comments
 (0)