Cotações de todas as ações, fundos, índices e BDRs

Esse endpoint fornece informações detalhadas sobre cotações de ações, fundos, índices e BDRs permitindo que você obtenha um resumo de todos os tickers disponíveis. Ela oferece flexibilidade para ordenar, filtrar e buscar os tickers que você deseja.

Endpoint

O endpoint que você deve utilizar para obter a cotação de todos os tickers disponíveis é o seguinte:

GET /api/quote/list

Parâmetros da Solicitação

Para utilizar este endpoint, você deve fornecer os seguintes parâmetros na solicitação:

token (obrigatório)

Um token de autenticação exclusivo. Você pode obtê-lo em https://brapi.dev/dashboard (opens in a new tab). A autenticação é necessária para acessar os recursos da API.

Esse token pode ser passado como parâmetro de query ou como header Authorization: Bearer {token}.

search (opcional)

Permite buscar por um ticker específico. Você pode usar este parâmetro para encontrar um ticker com base em uma consulta.

Exemplo de uso: ?search=ibo

sortBy (opcional)

Este parâmetro permite que você ordene os tickers por um tipo específico. Os valores aceitáveis são:

• name - Nome do ticker
• close - Preço de fechamento
• change - Variação percentual
• change_abs - Variação no preço absoluto
• volume - Volume de negociação
• market_cap_basic - Capitalização de mercado
• sector - Setor da ação

Exemplo de uso: ?sortBy=close

sortOrder (opcional)

Este parâmetro determina se os filtro de sortBy será ordenado em ordem crescente ou decrescente. Os valores aceitáveis são:

• desc - Ordem decrescente
• asc - Ordem crescente

Exemplo de uso: ?sortOrder=desc

limit (opcional)

Limite a quantidade de tickers retornados por página. Este parâmetro define o número máximo de tickers que serão exibidos em uma única resposta.

Exemplo de uso: ?limit=10

page (opcional)

Especifica a página atual dos resultados. Útil para a paginação dos resultados quando há muitos tickers disponíveis.

Exemplo de uso: ?page=1

Esta flexibilidade permite que você ajuste suas solicitações para atender a uma variedade de necessidades, desde a obtenção de uma lista completa de tickers até a obtenção de uma lista de tickers específicos.

type (opcional)

Este parâmetro permite que você filtre os tickers por tipo. Os valores aceitáveis são:

• stock - Ações
• fund - Fundos
• bdr - BDRs

Exemplo de uso: ?type=stock

sector (opcional)

Este parâmetro permite que você filtre os tickers por setor. Os valores aceitáveis são:

• Retail Trade - Comércio Varejista
• Energy Minerals - Minerais Energéticos
• Health Services - Serviços de Saúde
• Utilities - Utilidades
• Finance - Finanças
• Consumer Services - Serviços ao Consumidor
• Consumer Non-Durables - Bens de Consumo Não Duráveis
• Non-Energy Minerals - Minerais não Energéticos
• Commercial Services - Serviços Comerciais
• Distribution Services - Serviços de Distribuição
• Transportation - Transporte
• Technology Services - Serviços de Tecnologia
• Process Industries - Indústrias de Processo
• Communications - Comunicações
• Producer Manufacturing - Manufatura de Produtores
• null - Outros
• Miscellaneous - Diversos
• Electronic Technology - Tecnologia Eletrônica
• Industrial Services - Serviços Industriais
• Health Technology - Tecnologia de Saúde
• Consumer Durables - Bens de Consumo Duráveis

Exemplo de uso: ?sector=Finance ou ?sector=Retail Trade ou ?sector=Retail

Exemplo de Solicitação

Para uma requisição que busca por um ticker que contenha as letras TR, ordenado pelo preço de fechamento em ordem decrescente, com limite de 10 tickers por página e na página 1, a solicitação ficaria assim:

curl -X GET \
"https://brapi.dev/api/quote/list?search=TR&sortBy=close&sortOrder=desc&limit=10&sector=finance&token=eJGEyu8vVHctULdVdHYzQd"

Resposta da Solicitação

200 OK

A solicitação foi bem-sucedida.

{
  "indexes": [
    {
      "stock": "^DJI",
      "name": "Dow Jones Industrial Average"
    },
    {
      "stock": "^JN0U.JO",
      "name": "Top 40 USD Net TRI Index"
    }
  ],
  "stocks": [
    {
      "stock": "N1TR34",
      "name": "NORTHERN TRUDRN ED",
      "close": 209.42999,
      "change": 0.129083,
      "volume": 5,
      "market_cap": 87580484054.45544,
      "logo": "https://s3-symbol-logo.tradingview.com/northern-trust--big.svg",
      "sector": "Finance",
      "type": "bdr"
    },
    {
      "stock": "MTRE3",
      "name": "MITRE REALTYON",
      "close": 5.24,
      "change": 1.15830116,
      "volume": 1189300,
      "market_cap": 547913502,
      "logo": "https://brapi.dev/favicon.svg",
      "sector": "Finance",
      "type": "stock"
    },
    {
      "stock": "MTRE3F",
      "name": "MITRE REALTYON",
      "close": 5.16,
      "change": 0,
      "volume": 9080,
      "market_cap": 547913502,
      "logo": "https://brapi.dev/favicon.svg",
      "sector": "Finance",
      "type": "stock"
    }
  ],
  "availableSectors": [
    "Retail Trade",
    "Energy Minerals",
    "Health Services",
    "Utilities",
    "Finance",
    "Consumer Services",
    "Consumer Non-Durables",
    "Non-Energy Minerals",
    "Commercial Services",
    "Distribution Services",
    "Transportation",
    "Technology Services",
    "Process Industries",
    "Communications",
    "Producer Manufacturing",
    "Miscellaneous",
    "Electronic Technology",
    "Industrial Services",
    "Health Technology",
    "Consumer Durables"
  ],
  "availableStockTypes": ["stock", "fund", "bdr"],
  "currentPage": 1,
  "totalPages": 1,
  "itemsPerPage": 10,
  "totalCount": 3,
  "hasNextPage": false
}

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"
}

417 Bad Request

A solicitação foi malformada ou inválida.

{
  "error": true,
  "message": "Campo 'sortBy' inválido. sortBy válidos: name, close, change, change_abs, volume, market_cap_basic"
}