Documentação da API

Referência completa para a API BR Market Data

Primeiros Passos

A API BR Market Data fornece acesso a dados do mercado de ações brasileiro e indicadores financeiros. Todas as requisições da API devem ser enviadas para a URL base:

https://api.brmarketdata.com

Todos os endpoints retornam dados no formato JSON. Não é necessária autenticação no momento.

Endpoint de Preços Históricos

Obtenha dados históricos de preços para uma ação específica

Endpoint

GET /prices/history

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
ticker	string	Sim	Código da ação (ex: BBAS3)
start	string	Sim	Data inicial no formato AAAA-MM-DD
end	string	Sim	Data final no formato AAAA-MM-DD

Exemplo de Requisição

https://api.brmarketdata.com/prices/history?ticker=BBAS3&start=2010-01-01&end=2026-01-01

Exemplo de Resposta

{
  "ticker": "BBAS3",
  "prices": [
    {
      "date": "2010-01-04",
      "open": 26.45,
      "high": 26.89,
      "low": 26.12,
      "close": 26.62,
      "volume": 5782300
    }
    // Entradas adicionais de preços...
  ]
}

Endpoint de Preços por Data

Obtenha preços de todas as ações disponíveis em uma determinada data. Se não for informado uma data, será retornado o preço mais recente disponível.

Endpoint

GET /prices/by-date

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
ticker	string	Sim	Código da ação (ex: BBAS3)
start	string	Sim	Data inicial no formato AAAA-MM-DD
end	string	Sim	Data final no formato AAAA-MM-DD

Exemplo de Requisição

https://api.brmarketdata.com/prices/by-date?date=2024-06-30

Exemplo de Resposta

{
  "ticker": "BBAS3",
  "prices": [
    {
      "date": "2024-06-30",
      "open": 26.45,
      "high": 26.89,
      "low": 26.12,
      "close": 26.62,
      "volume": 5782300
    }
    // Entradas adicionais de tickers...
  ]
}

Endpoint de Histórico de Indicadores

Obtenha dados históricos para um indicador e ticker específicos

Endpoint

GET /fundamentals/history

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
ticker	string	Sim	Código da ação (ex: BBAS3)
fundamental	string	Sim	Código do indicador financeiro (ex: p_l)

Exemplo de Requisição

https://api.brmarketdata.com/fundamentals/history?ticker=BBAS3&fundamental=p_l

Exemplo de Resposta

{
  "ticker": "BBAS3",
  "fundamental": "p_l",
  "history": [
    {
      "date": "2020-01-01",
      "value": 8.45
    },
    {
      "date": "2020-02-01",
      "value": 8.76
    }
    // Entradas adicionais...
  ]
}

Endpoint de Indicadores por Ticker

Obtenha todos os indicadores disponíveis para um ticker específico

Endpoint

GET /fundamentals/by-ticker

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
ticker	string	Sim	Código da ação (ex: BBAS3)

Exemplo de Requisição

https://api.brmarketdata.com/fundamentals/by-ticker?ticker=BBAS3

Exemplo de Resposta

{
  "ticker": "BBAS3",
  "fundamentals": {
    "p_l": 8.92,
    "p_vp": 0.87,
    "dy": 5.23,
    "roe": 12.8
    // Indicadores adicionais...
  },
  "last_updated": "2023-09-15"
}

Endpoint de Ações por Indicador

Obtenha o valor do indicador para todas as ações disponíveis

Endpoint

GET /fundamentals/by-fundamental

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
fundamental	string	Sim	Código do indicador financeiro (ex: p_l)

Exemplo de Requisição

https://api.brmarketdata.com/fundamentals/by-fundamental?fundamental=p_l

Exemplo de Resposta

{
  "fundamental": "p_l",
  "stocks": {
    "BBAS3": 8.92,
    "ITUB4": 9.45,
    "PETR4": 6.78,
    "VALE3": 5.23
    // Ações adicionais...
  },
  "last_updated": "2023-09-15"
}