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-typescript' && '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 @@ -37,7 +37,7 @@ jobs:
build:
timeout-minutes: 5
name: build
runs-on: ${{ github.repository == 'stainless-sdks/brapi-typescript' && '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')
permissions:
contents: read
Expand Down Expand Up @@ -77,7 +77,7 @@ jobs:
test:
timeout-minutes: 10
name: test
runs-on: ${{ github.repository == 'stainless-sdks/brapi-typescript' && '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.4.0"
".": "1.5.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
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Changelog

## 1.5.0 (2026-09-04)

Full Changelog: [v1.4.0...v1.5.0](https://github.com/brapi-dev/brapi-typescript/compare/v1.4.0...v1.5.0)

### Features

* **api:** api update ([fad401f](https://github.com/brapi-dev/brapi-typescript/commit/fad401f042a1d8d94fcb308f55fadff38b3375a4))
* **api:** api update ([89e0ed5](https://github.com/brapi-dev/brapi-typescript/commit/89e0ed542b4a227fac546703463ac9832f555137))
* **api:** api update ([43eec39](https://github.com/brapi-dev/brapi-typescript/commit/43eec39ce6e2cdedd03a50673b2a862fd71833c0))
* **api:** api update ([f34d87f](https://github.com/brapi-dev/brapi-typescript/commit/f34d87f4c523563956ab52a4c7f302c3f069698a))
* **api:** api update ([24739c3](https://github.com/brapi-dev/brapi-typescript/commit/24739c37994c72c61f4cfcea3bdc8cc3066ae2c0))
* **api:** api update ([fdcbfce](https://github.com/brapi-dev/brapi-typescript/commit/fdcbfce0b8e4b2879f2ccd13042349494c11a6d8))
* **api:** api update ([ce0ed22](https://github.com/brapi-dev/brapi-typescript/commit/ce0ed22b5c394bb5ecc2efbd41ddac4b5cebdf85))
* **api:** api update ([837c83e](https://github.com/brapi-dev/brapi-typescript/commit/837c83e5403b176d7eea50a183499780e146fcb3))
* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([2bc7dc6](https://github.com/brapi-dev/brapi-typescript/commit/2bc7dc6b25bc92651dc858541f91001f385b9da5))


### Bug Fixes

* **stlc:** stop hand-edited CI workflows from blocking seals and builds ([072806f](https://github.com/brapi-dev/brapi-typescript/commit/072806f05caf7820b5b804d1e0a29b7853f0cb18))


### Chores

* **internal:** codegen related update ([602c4d1](https://github.com/brapi-dev/brapi-typescript/commit/602c4d1ac58243cce40b36c713c6063e42e200cc))

## 1.4.0 (2026-07-11)

Full Changelog: [v1.3.0...v1.4.0](https://github.com/brapi-dev/brapi-typescript/compare/v1.3.0...v1.4.0)
Expand Down
4 changes: 2 additions & 2 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Types:
Methods:

- <code title="get /api/v2/inflation">client.v2.inflation.<a href="./src/resources/v2/inflation.ts">retrieve</a>({ ...params }) -> InflationRetrieveResponse</code>
- <code title="get /api/v2/inflation/available">client.v2.inflation.<a href="./src/resources/v2/inflation.ts">listAvailable</a>() -> InflationListAvailableResponse</code>
- <code title="get /api/v2/inflation/available">client.v2.inflation.<a href="./src/resources/v2/inflation.ts">listAvailable</a>({ ...params }) -> InflationListAvailableResponse</code>

## PrimeRate

Expand All @@ -70,4 +70,4 @@ Types:
Methods:

- <code title="get /api/v2/prime-rate">client.v2.primeRate.<a href="./src/resources/v2/prime-rate.ts">retrieve</a>({ ...params }) -> PrimeRateRetrieveResponse</code>
- <code title="get /api/v2/prime-rate/available">client.v2.primeRate.<a href="./src/resources/v2/prime-rate.ts">listAvailable</a>() -> PrimeRateListAvailableResponse</code>
- <code title="get /api/v2/prime-rate/available">client.v2.primeRate.<a href="./src/resources/v2/prime-rate.ts">listAvailable</a>({ ...params }) -> PrimeRateListAvailableResponse</code>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "brapi",
"version": "1.4.0",
"version": "1.5.0",
"description": "The official TypeScript library for the Brapi API",
"author": "Brapi <contact@brapi.dev>",
"types": "dist/index.d.ts",
Expand Down
47 changes: 6 additions & 41 deletions src/resources/available.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,54 +9,19 @@ import { RequestOptions } from '../internal/request-options';
*/
export class Available extends APIResource {
/**
* 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.
*
* @example
* ```ts
Expand Down
Loading
Loading