Skip to content

Commit ea7470f

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent bb222bb commit ea7470f

8 files changed

Lines changed: 214 additions & 214 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-370d96602e1e139c7cc679fa26ebd1f021ac755f6d51c56377dd8a418db215f7.yml
3-
openapi_spec_hash: b788a91e141e37b39f9dded445f127fc
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson/brapi-7f4fc756afdb44ce8ec65abd1029ad0e99a35ad6a54ab03bb6e32e4c39a916eb.yml
3+
openapi_spec_hash: 85b858ecdb85ed7116d79672a7108784
44
config_hash: 14da4c1963f3e0764a3e82d626a1d762

‎src/brapi/resources/available.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,13 @@ def list(
8989
9090
### Índices Disponíveis
9191
92-
- `^BVSP` — Ibovespa (Índice Bovespa)
93-
- `IFIX.SA` — Índice de Fundos Imobiliários
92+
- `^BVSP` - Ibovespa (Índice Bovespa)
93+
- `IFIX.SA` - Índice de Fundos Imobiliários
9494
9595
### Campos da Resposta
9696
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"])
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"])
9999
100100
### Como Usar
101101
@@ -198,13 +198,13 @@ async def list(
198198
199199
### Índices Disponíveis
200200
201-
- `^BVSP` — Ibovespa (Índice Bovespa)
202-
- `IFIX.SA` — Índice de Fundos Imobiliários
201+
- `^BVSP` - Ibovespa (Índice Bovespa)
202+
- `IFIX.SA` - Índice de Fundos Imobiliários
203203
204204
### Campos da Resposta
205205
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"])
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"])
208208
209209
### Como Usar
210210

‎src/brapi/resources/quote.py‎

Lines changed: 122 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -120,78 +120,78 @@ def retrieve(
120120
121121
### Módulos Disponíveis:
122122
123-
- `summaryProfile` — Perfil da empresa (CNPJ, setor, descrição, website,
123+
- `summaryProfile` - Perfil da empresa (CNPJ, setor, descrição, website,
124124
funcionários)
125-
- `balanceSheetHistory` — Balanço Patrimonial anual
126-
- `balanceSheetHistoryQuarterly` — Balanço Patrimonial trimestral
127-
- `incomeStatementHistory` — DRE anual (Demonstração de Resultado do Exercício)
128-
- `incomeStatementHistoryQuarterly` — DRE trimestral
129-
- `financialData` — Indicadores financeiros atuais (TTM - Trailing Twelve
125+
- `balanceSheetHistory` - Balanço Patrimonial anual
126+
- `balanceSheetHistoryQuarterly` - Balanço Patrimonial trimestral
127+
- `incomeStatementHistory` - DRE anual (Demonstração de Resultado do Exercício)
128+
- `incomeStatementHistoryQuarterly` - DRE trimestral
129+
- `financialData` - Indicadores financeiros atuais (TTM - Trailing Twelve
130130
Months)
131-
- `financialDataHistory` — Histórico anual de indicadores financeiros
132-
- `financialDataHistoryQuarterly` — Histórico trimestral de indicadores
131+
- `financialDataHistory` - Histórico anual de indicadores financeiros
132+
- `financialDataHistoryQuarterly` - Histórico trimestral de indicadores
133133
financeiros
134-
- `defaultKeyStatistics` — Estatísticas-chave (P/L, P/VP, ROE, Dividend Yield,
134+
- `defaultKeyStatistics` - Estatísticas-chave (P/L, P/VP, ROE, Dividend Yield,
135135
etc)
136-
- `defaultKeyStatisticsHistory` — Histórico anual de estatísticas-chave
137-
- `defaultKeyStatisticsHistoryQuarterly` — Histórico trimestral de
136+
- `defaultKeyStatisticsHistory` - Histórico anual de estatísticas-chave
137+
- `defaultKeyStatisticsHistoryQuarterly` - Histórico trimestral de
138138
estatísticas-chave
139-
- `cashflowHistory` — Fluxo de Caixa anual
140-
- `cashflowHistoryQuarterly` — Fluxo de Caixa trimestral
141-
- `valueAddedHistory` — DVA anual (Demonstração de Valor Adicionado)
142-
- `valueAddedHistoryQuarterly` — DVA trimestral
139+
- `cashflowHistory` - Fluxo de Caixa anual
140+
- `cashflowHistoryQuarterly` - Fluxo de Caixa trimestral
141+
- `valueAddedHistory` - DVA anual (Demonstração de Valor Adicionado)
142+
- `valueAddedHistoryQuarterly` - DVA trimestral
143143
144144
### Intervalos Válidos (histórico):
145145
146-
- `1d` — Diário
147-
- `5d` — 5 dias
148-
- `1wk` — Semanal
149-
- `1mo` — Mensal
150-
- `3mo` — Trimestral
146+
- `1d` - Diário
147+
- `5d` - 5 dias
148+
- `1wk` - Semanal
149+
- `1mo` - Mensal
150+
- `3mo` - Trimestral
151151
152152
### Períodos Válidos (range):
153153
154-
- `1d` — Último dia
155-
- `5d` — Últimos 5 dias
156-
- `1mo` — Último mês
157-
- `3mo` — Últimos 3 meses
158-
- `6mo` — Últimos 6 meses
159-
- `1y` — Último ano
160-
- `2y` — Últimos 2 anos
161-
- `5y` — Últimos 5 anos
162-
- `10y` — Últimos 10 anos
163-
- `ytd` — Ano até hoje
164-
- `max` — Máximo disponível
154+
- `1d` - Último dia
155+
- `5d` - Últimos 5 dias
156+
- `1mo` - Último mês
157+
- `3mo` - Últimos 3 meses
158+
- `6mo` - Últimos 6 meses
159+
- `1y` - Último ano
160+
- `2y` - Últimos 2 anos
161+
- `5y` - Últimos 5 anos
162+
- `10y` - Últimos 10 anos
163+
- `ytd` - Ano até hoje
164+
- `max` - Máximo disponível
165165
166166
### Campos Principais da Resposta:
167167
168-
- `symbol` — Ticker do ativo (ex: PETR4)
169-
- `shortName` — Nome curto da empresa
170-
- `currency` — Moeda (BRL)
171-
- `regularMarketPrice` — Preço atual em BRL
172-
- `regularMarketChange` — Variação absoluta
173-
- `regularMarketChangePercent` — Variação percentual (%)
174-
- `regularMarketVolume` — Volume de negociação do dia
175-
- `regularMarketDayHigh` — Máxima do dia
176-
- `regularMarketDayLow` — Mínima do dia
177-
- `fiftyTwoWeekHigh` — Máxima de 52 semanas
178-
- `fiftyTwoWeekLow` — Mínima de 52 semanas
179-
- `marketCap` — Capitalização de mercado
180-
- `historicalDataPrice` — Array de dados OHLCV (quando `range`/`interval`
168+
- `symbol` - Ticker do ativo (ex: PETR4)
169+
- `shortName` - Nome curto da empresa
170+
- `currency` - Moeda (BRL)
171+
- `regularMarketPrice` - Preço atual em BRL
172+
- `regularMarketChange` - Variação absoluta
173+
- `regularMarketChangePercent` - Variação percentual (%)
174+
- `regularMarketVolume` - Volume de negociação do dia
175+
- `regularMarketDayHigh` - Máxima do dia
176+
- `regularMarketDayLow` - Mínima do dia
177+
- `fiftyTwoWeekHigh` - Máxima de 52 semanas
178+
- `fiftyTwoWeekLow` - Mínima de 52 semanas
179+
- `marketCap` - Capitalização de mercado
180+
- `historicalDataPrice` - Array de dados OHLCV (quando `range`/`interval`
181181
fornecidos)
182-
- `dividendsData` — Histórico de dividendos (quando `dividends=true`)
182+
- `dividendsData` - Histórico de dividendos (quando `dividends=true`)
183183
184184
### Tickers Populares (Teste):
185185
186-
- `PETR4` — Petrobras (Energia)
187-
- `VALE3` — Vale (Mineração)
188-
- `ITUB4` — Itaú Unibanco (Financeiro)
189-
- `BBDC4` — Bradesco (Financeiro)
190-
- `ABEV3` — Ambev (Consumo)
191-
- `WEGE3` — WEG (Indústria)
192-
- `RENT3` — Localiza (Transporte)
193-
- `BBAS3` — Banco do Brasil (Financeiro)
194-
- `MGLU3` — Magazine Luiza (Varejo)
186+
- `PETR4` - Petrobras (Energia)
187+
- `VALE3` - Vale (Mineração)
188+
- `ITUB4` - Itaú Unibanco (Financeiro)
189+
- `BBDC4` - Bradesco (Financeiro)
190+
- `ABEV3` - Ambev (Consumo)
191+
- `WEGE3` - WEG (Indústria)
192+
- `RENT3` - Localiza (Transporte)
193+
- `BBAS3` - Banco do Brasil (Financeiro)
194+
- `MGLU3` - Magazine Luiza (Varejo)
195195
196196
### Fonte dos Dados:
197197
@@ -313,16 +313,16 @@ def list(
313313
314314
### Parâmetros de Ordenação:
315315
316-
- `volume` — Volume de negociação do dia
317-
- `close` — Preço de fechamento
318-
- `market_cap_basic` — Capitalização de mercado
319-
- `name` — Nome da empresa (alfabético)
316+
- `volume` - Volume de negociação do dia
317+
- `close` - Preço de fechamento
318+
- `market_cap_basic` - Capitalização de mercado
319+
- `name` - Nome da empresa (alfabético)
320320
321321
### Tipos de Ativo:
322322
323-
- `stock` — Ações (Ações ordinárias e preferenciais)
324-
- `fund` — Fundos Imobiliários (FIIs) e ETFs
325-
- `bdr` — BDRs (Brazilian Depositary Receipts)
323+
- `stock` - Ações (Ações ordinárias e preferenciais)
324+
- `fund` - Fundos Imobiliários (FIIs) e ETFs
325+
- `bdr` - BDRs (Brazilian Depositary Receipts)
326326
327327
**Plano Mínimo:** Gratuito **Autenticação:** Necessária (Bearer Token)
328328
@@ -479,78 +479,78 @@ async def retrieve(
479479
480480
### Módulos Disponíveis:
481481
482-
- `summaryProfile` — Perfil da empresa (CNPJ, setor, descrição, website,
482+
- `summaryProfile` - Perfil da empresa (CNPJ, setor, descrição, website,
483483
funcionários)
484-
- `balanceSheetHistory` — Balanço Patrimonial anual
485-
- `balanceSheetHistoryQuarterly` — Balanço Patrimonial trimestral
486-
- `incomeStatementHistory` — DRE anual (Demonstração de Resultado do Exercício)
487-
- `incomeStatementHistoryQuarterly` — DRE trimestral
488-
- `financialData` — Indicadores financeiros atuais (TTM - Trailing Twelve
484+
- `balanceSheetHistory` - Balanço Patrimonial anual
485+
- `balanceSheetHistoryQuarterly` - Balanço Patrimonial trimestral
486+
- `incomeStatementHistory` - DRE anual (Demonstração de Resultado do Exercício)
487+
- `incomeStatementHistoryQuarterly` - DRE trimestral
488+
- `financialData` - Indicadores financeiros atuais (TTM - Trailing Twelve
489489
Months)
490-
- `financialDataHistory` — Histórico anual de indicadores financeiros
491-
- `financialDataHistoryQuarterly` — Histórico trimestral de indicadores
490+
- `financialDataHistory` - Histórico anual de indicadores financeiros
491+
- `financialDataHistoryQuarterly` - Histórico trimestral de indicadores
492492
financeiros
493-
- `defaultKeyStatistics` — Estatísticas-chave (P/L, P/VP, ROE, Dividend Yield,
493+
- `defaultKeyStatistics` - Estatísticas-chave (P/L, P/VP, ROE, Dividend Yield,
494494
etc)
495-
- `defaultKeyStatisticsHistory` — Histórico anual de estatísticas-chave
496-
- `defaultKeyStatisticsHistoryQuarterly` — Histórico trimestral de
495+
- `defaultKeyStatisticsHistory` - Histórico anual de estatísticas-chave
496+
- `defaultKeyStatisticsHistoryQuarterly` - Histórico trimestral de
497497
estatísticas-chave
498-
- `cashflowHistory` — Fluxo de Caixa anual
499-
- `cashflowHistoryQuarterly` — Fluxo de Caixa trimestral
500-
- `valueAddedHistory` — DVA anual (Demonstração de Valor Adicionado)
501-
- `valueAddedHistoryQuarterly` — DVA trimestral
498+
- `cashflowHistory` - Fluxo de Caixa anual
499+
- `cashflowHistoryQuarterly` - Fluxo de Caixa trimestral
500+
- `valueAddedHistory` - DVA anual (Demonstração de Valor Adicionado)
501+
- `valueAddedHistoryQuarterly` - DVA trimestral
502502
503503
### Intervalos Válidos (histórico):
504504
505-
- `1d` — Diário
506-
- `5d` — 5 dias
507-
- `1wk` — Semanal
508-
- `1mo` — Mensal
509-
- `3mo` — Trimestral
505+
- `1d` - Diário
506+
- `5d` - 5 dias
507+
- `1wk` - Semanal
508+
- `1mo` - Mensal
509+
- `3mo` - Trimestral
510510
511511
### Períodos Válidos (range):
512512
513-
- `1d` — Último dia
514-
- `5d` — Últimos 5 dias
515-
- `1mo` — Último mês
516-
- `3mo` — Últimos 3 meses
517-
- `6mo` — Últimos 6 meses
518-
- `1y` — Último ano
519-
- `2y` — Últimos 2 anos
520-
- `5y` — Últimos 5 anos
521-
- `10y` — Últimos 10 anos
522-
- `ytd` — Ano até hoje
523-
- `max` — Máximo disponível
513+
- `1d` - Último dia
514+
- `5d` - Últimos 5 dias
515+
- `1mo` - Último mês
516+
- `3mo` - Últimos 3 meses
517+
- `6mo` - Últimos 6 meses
518+
- `1y` - Último ano
519+
- `2y` - Últimos 2 anos
520+
- `5y` - Últimos 5 anos
521+
- `10y` - Últimos 10 anos
522+
- `ytd` - Ano até hoje
523+
- `max` - Máximo disponível
524524
525525
### Campos Principais da Resposta:
526526
527-
- `symbol` — Ticker do ativo (ex: PETR4)
528-
- `shortName` — Nome curto da empresa
529-
- `currency` — Moeda (BRL)
530-
- `regularMarketPrice` — Preço atual em BRL
531-
- `regularMarketChange` — Variação absoluta
532-
- `regularMarketChangePercent` — Variação percentual (%)
533-
- `regularMarketVolume` — Volume de negociação do dia
534-
- `regularMarketDayHigh` — Máxima do dia
535-
- `regularMarketDayLow` — Mínima do dia
536-
- `fiftyTwoWeekHigh` — Máxima de 52 semanas
537-
- `fiftyTwoWeekLow` — Mínima de 52 semanas
538-
- `marketCap` — Capitalização de mercado
539-
- `historicalDataPrice` — Array de dados OHLCV (quando `range`/`interval`
527+
- `symbol` - Ticker do ativo (ex: PETR4)
528+
- `shortName` - Nome curto da empresa
529+
- `currency` - Moeda (BRL)
530+
- `regularMarketPrice` - Preço atual em BRL
531+
- `regularMarketChange` - Variação absoluta
532+
- `regularMarketChangePercent` - Variação percentual (%)
533+
- `regularMarketVolume` - Volume de negociação do dia
534+
- `regularMarketDayHigh` - Máxima do dia
535+
- `regularMarketDayLow` - Mínima do dia
536+
- `fiftyTwoWeekHigh` - Máxima de 52 semanas
537+
- `fiftyTwoWeekLow` - Mínima de 52 semanas
538+
- `marketCap` - Capitalização de mercado
539+
- `historicalDataPrice` - Array de dados OHLCV (quando `range`/`interval`
540540
fornecidos)
541-
- `dividendsData` — Histórico de dividendos (quando `dividends=true`)
541+
- `dividendsData` - Histórico de dividendos (quando `dividends=true`)
542542
543543
### Tickers Populares (Teste):
544544
545-
- `PETR4` — Petrobras (Energia)
546-
- `VALE3` — Vale (Mineração)
547-
- `ITUB4` — Itaú Unibanco (Financeiro)
548-
- `BBDC4` — Bradesco (Financeiro)
549-
- `ABEV3` — Ambev (Consumo)
550-
- `WEGE3` — WEG (Indústria)
551-
- `RENT3` — Localiza (Transporte)
552-
- `BBAS3` — Banco do Brasil (Financeiro)
553-
- `MGLU3` — Magazine Luiza (Varejo)
545+
- `PETR4` - Petrobras (Energia)
546+
- `VALE3` - Vale (Mineração)
547+
- `ITUB4` - Itaú Unibanco (Financeiro)
548+
- `BBDC4` - Bradesco (Financeiro)
549+
- `ABEV3` - Ambev (Consumo)
550+
- `WEGE3` - WEG (Indústria)
551+
- `RENT3` - Localiza (Transporte)
552+
- `BBAS3` - Banco do Brasil (Financeiro)
553+
- `MGLU3` - Magazine Luiza (Varejo)
554554
555555
### Fonte dos Dados:
556556
@@ -672,16 +672,16 @@ async def list(
672672
673673
### Parâmetros de Ordenação:
674674
675-
- `volume` — Volume de negociação do dia
676-
- `close` — Preço de fechamento
677-
- `market_cap_basic` — Capitalização de mercado
678-
- `name` — Nome da empresa (alfabético)
675+
- `volume` - Volume de negociação do dia
676+
- `close` - Preço de fechamento
677+
- `market_cap_basic` - Capitalização de mercado
678+
- `name` - Nome da empresa (alfabético)
679679
680680
### Tipos de Ativo:
681681
682-
- `stock` — Ações (Ações ordinárias e preferenciais)
683-
- `fund` — Fundos Imobiliários (FIIs) e ETFs
684-
- `bdr` — BDRs (Brazilian Depositary Receipts)
682+
- `stock` - Ações (Ações ordinárias e preferenciais)
683+
- `fund` - Fundos Imobiliários (FIIs) e ETFs
684+
- `bdr` - BDRs (Brazilian Depositary Receipts)
685685
686686
**Plano Mínimo:** Gratuito **Autenticação:** Necessária (Bearer Token)
687687

0 commit comments

Comments
 (0)