SDKs
SDKs oficiais
Carregando conteúdo...
FOR LLMs: add .md to any documentation URL to get the page as Markdown. Example: /docs/acoes/dividendos.md. The index of all pages is at /llms.txt.
Carregando documentação...
Nesta página
A brapi tem SDKs oficiais para TypeScript/JavaScript e Python. Eles trazem tipos, retry automático e erros separados por status HTTP. Usam a mesma chave da API REST.
| TypeScript/JS | Python | |
|---|---|---|
| Pacote | brapi no npm | brapi no PyPI |
| Tipos | TypeScript | Type hints |
| Cliente | Assíncrono | Síncrono e assíncrono |
| Ambiente | Node.js e navegador | Python 3.8+ |
| Código | brapi-typescript | brapi-python |
Os dois SDKs são gerados a partir do OpenAPI e têm licença MIT.
npm install brapiimport Brapi from 'brapi';
const client = new Brapi({
apiKey: process.env.BRAPI_API_KEY,
});
const quote = await client.quote.retrieve('PETR4');
console.log(quote.results[0].regularMarketPrice);Veja o guia do SDK TypeScript.
pip install brapiimport os
from brapi import Brapi
client = Brapi(api_key=os.environ.get("BRAPI_API_KEY"))
quote = client.quote.retrieve(tickers="PETR4")
print(quote.results[0].regular_market_price)Veja o guia do SDK Python.
Os SDKs lançam uma exceção para cada tipo de erro:
try {
const quote = await client.quote.retrieve('INVALID');
} catch (error) {
if (error instanceof Brapi.NotFoundError) {
console.log('Ticker não encontrado');
} else if (error instanceof Brapi.RateLimitError) {
console.log('Limite de requisições atingido');
} else if (error instanceof Brapi.AuthenticationError) {
console.log('Chave inválida');
}
}from brapi import NotFoundError, RateLimitError
try:
quote = client.quote.retrieve(tickers="INVALID")
except NotFoundError:
print("Ticker não encontrado")
except RateLimitError:
print("Limite de requisições atingido")const client = new Brapi({
apiKey: process.env.BRAPI_API_KEY,
maxRetries: 3,
timeout: 10000, // milissegundos
});client = Brapi(
api_key=os.environ.get("BRAPI_API_KEY"),
max_retries=3,
timeout=10.0, # segundos
)Abra uma issue no repositório do SDK ou escreva para [email protected].