Documentação da API

A API do Dados de Mercado oferece um conjunto de recursos para acessar dados financeiros de empresas e mercados brasileiros, bem como indicadores financeiros, de risco, técnicos, e de mercado. A API também disponibiliza dados macroeconômicos divulgados pelos principais orgãos públicos. Alguns conjuntos de dados estão disponíveis publicamente e podem ser acessados livremente, sem necessidade de assinatura e com um pequeno limite no número de requisições, através de um token de autenticação.

Referência

Introdução

Nessa documentação você vai encontrar uma descrição dos conjuntos de dados disponíveis e exemplos de como utilizar a API do Dados de Mercado.

O acesso é feito através dos métodos HTTP padrões, conforme os exemplos de chamadas nessa documentação. Um token de autenticação é necessário em todas as requisições. Todas as respostas, incluindo erros, são codificadas em JSON.

Versão atual: 1

URL base: https://api.dadosdemercado.com.br/v1

Autenticação

Todas as chamadas feitas para os recursos da API, devem incluir uma chave (token) de API como forma de autenticação. Utilize o formulário abaixo para obter uma chave para utilização dos recursos livres da API.

Para acesso completo aos recursos da API e ajuste dos limites de requisição, entre em contato conosco, através do e-mail api@dadosdemercado.com.br

Guarde sua chave de autenticação com segurança, por exemplo, não compartilhe a chave de API em repositórios do GitHub ou código que rode no lado do cliente.

Pedir uma chave de autenticação

Inscreva-se abaixo para receber uma chave de autenticação da API.

No momento não estamos enviando novas chaves de autenticação.

Exemplo de utilização

Em todas as chamadas, inclua a chave em um cabeçalho HTTP no seguinte formato:

Authorization: Bearer token

Por exemplo,

Authorization: Bearer 8cb7a3a5529cec195ed3adc5cd994e66

Códigos de resposta

Veja abaixo os códigos de resposta HTTP que utilizamos para indicar sucesso ou falha em uma requisição.

Código Descrição
200 OK: tudo certo com a requisição
400 Requisição inválida: possivelmente por um parâmetro inválido ou faltante
401 Não autorizado: token inválido
403 Proibido: o usuário não tem acesso ao recurso solicitado
404 Não encontrado: o recurso requisitado não existe
429 Pedidos em excesso: muitas solicitações em pouco tempo. Use backoff exponencial e consulte a documentação para saber os limites de requisições

Suporte

Entre em contato pelo e-mail api@dadosdemercado.com.br

Empresas

Dados de cadastro, balanços, resultados, indicadores, dividendos, e outras informações sobre empresas abertas com cadastro na CVM ou B3.

Lista de empresas

Retorna a lista de empresas disponíveis na plataforma.

GET /companies

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies

Objeto company

Código Descrição
name
string
Razão social da empresa
trade_name
string
Nome de negociação, como aparece na B3 ou CVM
cvm_code
integer
Código CVM da empresa
cnpj
string
CNPJ da empresa
founding_date
date
Data de fundação da empresa
main_activity
string
Descrição da atividade principal da empresa
website
string
URL da página de relações com investidores ou do site oficial da empresa
controlling_interest
enum controlling_interest
Tipo de controle acionário da empresa
is_state_owned
boolean
Se é uma empresa estatal
is_foreign
boolean
Se é uma empresa estrangeira
is_b3_listed
boolean
Se a empresa está listada na B3
b3_issuer_code
string
Código de emissor da empresa na B3
b3_listing_segment
enum b3_listing_segment
Segmento de listagem da empresa na B3
b3_sector
string
Setor de atuação da empresa segundo a B3
b3_subsector
string
Subsetor de atuação da empresa segundo a B3
b3_segment
string
Segmento de atuação da empresa segundo a B3

Ativos de uma empresa

Retorna a lista de ativos em mercado de uma empresa.

GET /companies/:cvm_code/tickers

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/tickers

Objeto ticker

Código Descrição
ticker
string
Ticker que representa o ativo no mercado
type
enum ticker_type
Tipo de ativo
market_type
enum market_type
Tipo de mercado
market
string
Código do mercado (MIC, ISO 10383)
issuer_code
string
Código da empresa emissora do ativo
currency
string
Moeda de negociação do ativo (ISO 4217)
isin
string
Código ISIN do ativo
name
string
Nome do ativo
last_quote
object quote_summary
Última cotação
penultimate_quote
object quote_summary
Penúltima cotação
change
float
Variação

Balanços

Retorna a lista de balanços divulgados pela empresa.

GET /companies/:cvm_code/balances

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/balances

Objeto balance

Código Descrição
cvm_code
integer
Código CVM da empresa
statement_type
enum statement_type
Tipo de resultado, se consolidado ou individual
reference_date
date
Data de referência do balanço
assets
integer
Ativo total
current_assets
integer
Ativo circulante
cash
integer
Caixa e equivalentes de caixa
financial_investments
integer
Aplicações financeiras
receivables
integer
Contas a receber
inventories
integer
Estoques
biological_assets
integer
Ativos biológicos
noncurrent_assets
integer
Ativo não circulante
investments
integer
Investimentos
fixed_assets
integer
Imobilizado
intangible_assets
integer
Intangível
liabilities
integer
Passivo total
current_liabilities
integer
Passivo circulante
suppliers
integer
Fornecedores
loans
integer
Empréstimos e financiamentos
noncurrent_liabilities
integer
Passivo não circulante
long_term_loans
integer
Empréstimos e financiamentos
equity
integer
Patrimônio líquido
equity_non_controlling
integer
Patrimônio líquido atribuído aos não controladores

Resultados

Retorna a lista de resultados divulgados pela empresa.

GET /companies/:cvm_code/incomes

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/incomes

Objeto income

Código Descrição
cvm_code
integer
Código CVM da empresa
statement_type
enum statement_type
Tipo de resultado, se consolidado ou individual
period_init
date
Data de início do período de divulgação do balanço
period_end
date
Data de fim do período divulgação do balanço
period_type
enum income_period_type
Tipo de período considerado na consolidação dos resultados
net_sales
integer
Receita de venda de bens e/ou serviços
costs
integer
Custo dos bens e/ou serviços vendidos
gross_income
integer
Resultado bruto
operating_expenses
integer
Despesas/receitas operacionais
ebit
integer
Resultado antes do resultado financeiro e dos tributos
non_operating_income
integer
Resultado não operacional (resultado financeiro)
profit_before_taxes
integer
Resultado antes dos tributos sobre o lucro
taxes
integer
Imposto de renda e contribuição social sobre o lucro
continued_operations
integer
Resultado líquido das operações continuadas
discontinued_operations
integer
Resultado líquido de operações descontinuadas
net_income
integer
Lucro/prejuízo consolidado do período
net_income_controlling
integer
Resultado atribuído a sócios da empresa controladora
net_income_non_controlling
integer
Resultado atribuído a sócios não controladores

Fluxos de caixa

Retorna a lista de fluxos de caixa divulgados pela empresa.

GET /companies/:cvm_code/cash_flows

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/cash_flows

Objeto cash_flow

Código Descrição
cvm_code
integer
Código CVM da empresa
statement_type
enum statement_type
Tipo de resultado, se consolidado ou individual
period_init
date
Data de início do período de divulgação do balanço
period_end
date
Data de fim do período divulgação do balanço
period_type
enum income_period_type
Tipo de período considerado na consolidação dos resultados
operating
integer
FCO: fluxo de caixa operacional
investing
integer
FCI: fluxo de caixa de investimentos
financing
integer
FCF: fluxo de caixa de financiamentos

Indicadores financeiros

Retorna a lista de indicadores financeiros por período da empresa.

GET /companies/:cvm_code/ratios

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/ratios

Objeto ratios

Código Descrição
cvm_code
integer
Código CVM da empresa
statement_type
enum statement_type
Tipo de resultado considerado no cálculo, se consolidado ou individual
period_init
date
Data de início do período dos resultados considerados
period_end
date
Data de fim do período dos resultados considerados
period_type
enum ratios_period_type
Tipo de período dos resultados considerados
gross_margin
float
Margem bruta
net_margin
float
Margem líquida
ebit_margin
float
Margem EBIT
operating_margin
float
Margem operacional
return_on_equity
float
ROE: retorno sobre o patrimônio líquido
return_on_assets
float
ROA: retorno sobre o ativo total
asset_turnover
float
Giro do ativo
current_liquidity
float
Liquidez corrente
quick_liquidity
float
Liquidez seca
cash_liquidity
float
Liquidez imediata
working_capital
integer
Capital de giro
gross_debt
integer
Dívida bruta
net_debt
integer
Dívida líquida
total_debt
float
Endividamento geral
ebitda
integer
EBITDA
ebitda_margin
float
Margem EBITDA

Indicadores de mercado

Retorna o histórico diário de indicadores de mercado da empresa.

GET /companies/:cvm_code/market_ratios

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/market_ratios

Objeto market_ratios

Código Descrição
cvm_code
integer
Código CVM da empresa
ticker
string
Ticker da ação considerada no cálculo dos indicadores
reference_date
date
Data de referência do cálculo dos indicadores
shares
integer
Quantidade de ações considerada no cálculo dos indicadores
price
float
Preço ajustado da ação considerado no cálculo dos indicadores
earnings_per_share
float
Lucro por ação (LPA)
equity_per_share
float
Valor patrimonial por ação (VPA)
ebit_per_share
float
EBIT por ação
assets_per_share
float
Ativo por ação
net_sales_per_share
float
Receita líquida por ação
price_earnings
float
Preço por lucro por ação (P/L)
price_to_book
float
Preço por valor patrimonial por ação (P/VP)
price_to_sales
float
Preço por receita por açao (PSR)
price_to_cash_flow
float
Preço por fluxo de caixa por ação (P/CF)

Dividendos

Retorna a lista de dividendos distribuídos pela empresa.

GET /companies/:cvm_code/dividends

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/dividends

Objeto dividend

Código Descrição
cvm_code
integer
Código CVM da empresa
ticker
string
Ticker da ação que recebeu dividendos
type
string
Tipo de dividendo
approval_date
date
Data de aprovação do dividendo
record_date
date
Data com-dividendos
ex_date
date
Data ex-dividendos
payable_date
date
Data de pagamento do dividendo
amount
float
Valor bruto do dividendo pago por ação
notes
string
Notas relevantes sobre o dividendo pago

Desdobramentos

Retorna a lista de desdobramentos e agrupamentos feitos pela empresa.

GET /companies/:cvm_code/splits

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/splits

Objeto split

Código Descrição
cvm_code
integer
Código CVM da empresa
ticker
string
Ticker da ação que recebeu o desdobramento/agrupamento
approval_date
date
Data de aprovação do evento
record_date
date
Data com
ex_date
date
Data ex-evento
ratio
string
Razão do desdobramento/agrupamento no format X:Y
notes
string
Notas relevantes sobre o evento

Bonificações

Retorna a lista de bonificações da empresa.

GET /companies/:cvm_code/bonus

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/5410/bonus

Objeto bonus

Código Descrição
cvm_code
integer
Código CVM da empresa
ticker
string
Ticker da ação que recebeu o bônus
approval_date
date
Data de aprovação do evento
record_date
date
Data com
ex_date
date
Data ex-evento
ratio
string
Razão do bônus no format X:Y
notes
string
Notas relevantes sobre o evento

Documentos

Histórico de documentos entregues à CVM pelas companhias

GET /companies/docs

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/companies/docs

Objeto doc

Código Descrição
trade_name
string
Nome de negociação da companhia
cvm_code
integer
Código CVM
subjects
list string
Lista de assuntos do documento
sequence
integer
Número de sequencia do documento
delivered_at
datetime
Data e hora de envio do documento
tickers
list string
Lista de tickers da companhia
category
string
Categoria do documento
doc_type
string
Tipo do documento
specie
string
Espécie do documento
reason
string
Razão de cancelamento do documento

Mercados

Dados de ativos e cotações.

Lista de ativos

Retorna a lista de ativos disponíveis na plataforma.

GET /tickers

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/tickers

Objeto ticker

Código Descrição
ticker
string
Ticker que representa o ativo no mercado
type
enum ticker_type
Tipo de ativo
market_type
enum market_type
Tipo de mercado
market
string
Código do mercado (MIC, ISO 10383)
issuer_code
string
Código da empresa emissora do ativo
currency
string
Moeda de negociação do ativo (ISO 4217)
isin
string
Código ISIN do ativo
name
string
Nome do ativo
last_quote
object quote_summary
Última cotação
penultimate_quote
object quote_summary
Penúltima cotação
change
float
Variação

Cotações

Retorna uma lista de cotações para um ativo.

GET /tickers/:ticker/quotes

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/tickers/WEGE3/quotes

Objeto quote

Código Descrição
ticker
string
Ticker
date
date
Data da cotação
open
float
Preço de abertura
close
float
Preço de fechamento
min
float
Preço mínimo registrado
max
float
Preço máximo registrado
adj_close
float
Preço de fechamento ajustado
volume
integer
Total de negócios

Índices de mercado

GET /indexes

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/indexes

Objeto ticker

Código Descrição
ticker
string
Ticker que representa o ativo no mercado
type
enum ticker_type
Tipo de ativo
market_type
enum market_type
Tipo de mercado
market
string
Código do mercado (MIC, ISO 10383)
issuer_code
string
Código da empresa emissora do ativo
currency
string
Moeda de negociação do ativo (ISO 4217)
isin
string
Código ISIN do ativo
name
string
Nome do ativo
last_quote
object quote_summary
Última cotação
penultimate_quote
object quote_summary
Penúltima cotação
change
float
Variação

Indicadores de risco

Retorna indicadores de risco para determinado ativo utilizando outro ativo como referência.

GET /tickers/:ticker/risk_measures/:benchmark

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/tickers/WEGE3/risk_measures/IBOV

Objeto risk_measures

Código Descrição
ticker
string
Ativo utilizado no cálculo dos indicadores
benchmark
string
Ativo de referência utilizado no cálculo dos indicadores
beta
float
Coeficiente beta
alpha
float
Alpha
r_squared
float
R-squared
period_init
date
Data de início do período de cotações considerado no cálculo
period_end
date
Data de fim do período cotações considerado no cálculo

Investidores estrangeiros

Histórico de fluxo de investidores estrangeiros na B3

GET /investors

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/investors

Objeto investor_flow

Código Descrição
date
date
Data do registro
flow
float
Fluxo de investimento

Fundos de investimento

Dados de cadastro e histórico de cotações de fundos de investimentos cadastrados na CVM.

Lista de fundos

Retorna a lista de fundos de investimento disponíveis na plataforma.

GET /funds

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/funds

Objeto fund

Código Descrição
id
uuid
Id do fundo de investimento na API
name
string
Razão social do fundo
trade_name
string
Nome do fundo
slug
string
Chave de identificação do fundo
cnpj
string
CNPJ do fundo
benchmark
string
Benchmark
begin_date
date
Data de início do fundo de investimento
type
string
Tipo do fundo de investimento
class
string
Classe do fundo de investimento
cvm_code
integer
Código CVM do fundo
shareholders
integer
Número de cotistas
net_worth
integer
Patrimônio líquido

Histórico de cotações

Retorna uma lista de valores das cotas dos fundos de investimento.

GET /funds/:id/quotes

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/funds

Objeto fund_quote

Código Descrição
fund_id
uuid
Id do fundo na API
date
date
Data da cotação
quote
integer
Valor da cota (em centavos)

Ativos

Retorna a lista de ativos de um fundo de investimento.

GET /funds/:id/assets

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/funds

Objeto fund_asset

Código Descrição
fund_id
uuid
Id do fundo na API
reference_date
date
Data de referência
asset_type
string
Tipo de ativo
value
integer
Valor do ativo

Macro

Expectativas

Esse recurso retorna as expectativas de preços de índices de acordo com as pesquisas realizadas pelo BC.

GET /macro/:index/estimates

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/macro/ipca/estimates

Objeto estimate

Código Descrição
index
string
Nome do índice da estimativa
target_period
string
Tipo de período para o qual a estimativa foi feita
target_date
string
Período para o qual a estimativa foi feita
date
date
Data de divulgação da estimativa
avg
float
Média das respostas da pesquisa
median
float
Mediana das respostas
std_dev
float
Desvio padrão das respostas
min
float
Valor mínimo das respostas
max
float
Valor máximo das respostas
cv
float
Covariância das respostas
answers
integer
Quantidade de respostas durante a pesquisa

Curvas de juros

GET /macro/yield_curves

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/macro/yield_curves/ettj_ipca

Objeto yield_curve

Código Descrição
curve
string
Identificação da curva de juros
date
date
Data de divulgação dos valores
vertex
integer
Número de dias após a data de divulgação
value
float
Valor dos juros para a data

Boletim Focus

Dados do último Boletim Focus divulgado pelo Banco Central

GET /macro/focus

Exemplo de chamada

https://api.dadosdemercado.com.br/v1/macro/focus

Objeto focus

Código Descrição
index
string
Indicador
target_date
integer
Data da previsão
date
date
Data do boletim
last
float
Último valor registrado
last_week
float
Valor registrado na última semana
last_month
float
Valor registrado no último mês