Listagem de Todos os Tickers Disponíveis
Nesta seção, você encontrará informações sobre como listar todos os tickers disponíveis para consulta na API da brapi. Isso permite que você tenha acesso a uma ampla variedade de ativos financeiros e facilite a busca por informações específicas.
Endpoint
O endpoint que você deve utilizar para obter a cotação de todos os tickers disponíveis é o seguinte:
GET /api/available
Parâmetros da Solicitação
Para usar este endpoint, você precisa fornecer um parâmetro na solicitação:
search (opcional)
O parâmetro de pesquisa (search) é opcional, mas muito útil. Ele permite que você busque ações por ticker, facilitando a localização de ativos específicos. Você pode fornecer parte ou todo o ticker da ação que deseja encontrar.
Exemplo de uso: ?search=bv
Isso torna a busca por tickers mais rápida e eficiente, especialmente quando você está interessado em ativos específicos, por exemplo para autocompletar um campo de busca em seu site ou aplicativo.
Exemplo de Solicitação
Para uma requisição que busca por um ticker que contenha as letras TR
, a
solicitação ficaria assim:
curl -X GET \
"https://brapi.dev/api/available?search=TR&token=eJGEyu8vVHctULdVdHYzQd"
Parâmetro | Valor |
---|---|
search | TR |
token | eJGEyu8vVHctULdVdHYzQd |
Resposta da Solicitação
200 OK
A solicitação foi bem-sucedida.
{
"indexes": [],
"stocks": [
"PETR4",
"PETR3",
"TRPL4",
"MTRE3",
"TRIS3",
"TRAD3",
"PETR4F",
"CPTR11",
"TRPL4F",
"HCTR11",
"TRXF11",
"PETR3F",
"MTRE3F",
"RZTR11",
"NUTR3",
"TRBL11",
"TRIS3F",
"TRIG11",
"BTRA11",
"TRPL3",
"TRAD3F",
"EKTR4",
"TRPL3F",
"NUTR3F",
"EKTR4F",
"TRVC34",
"TRXB11",
"ESTR4F"
]
}
200 Empty Response
Não encontramos nenhum ativo com o ticker informado.
{
"indexes": [],
"stocks": []
}
401 Unauthorized
O token de autenticação não foi informado ou é inválido.
{
"error": true,
"message": "O seu token é inválido, por favor, verifique o seu token em brapi.dev/dashboard"
}