1. HG Console
  2. HG Finance
  3. Documentação

HG Finance Documentação

API de dados financeiros

Documentação

Índice

Autenticação e chave

A autenticação exigida para o uso da API é super simples.
Basta você fazer o registro de sua chave aqui, e informar via parâmetro em suas consultas.

Recomendamos que sempre utilize uma chave, seus limites de consulta serão maiores, e mais recursos serão habilitados.
Você pode consultar os limites neste link.

Sua chave deve ser informada em toda requisição, utilizando o parâmetro key.

https://api.hgbrasil.com/finance?key=SUA-CHAVE

Obtendo contações de moedas, índices dos mercados, criptomoedas e taxas

O HG Finance é uma API que fornece dados dados financeiros com o foco em trazer o máximo de informações em uma só requisição.
API fácil de implementar, com respostas e parâmetros objetivos, com bibliotecas em PHP, Ruby e JavaScript. (em breve)

Mesmo que sua aplicação não seja com essas linguagens, abaixo você pode conferir como integrar a API.
Todos esses dados são retornados na mesma requisição de uma só vez, sendo esses dados:

Em uma só requisição, você pode obter:
- as posições dos principais índices como IBOVESPA, IFIX, NASDAQ, Dow Jones, CAC 40 e NIKKEI;
- a cotação de diversas moedas em relação ao real como Dólar (USD), Euro (EUR), Libra (GBP), Peso (ARS), Dólar Canadense (CAD), Dólar Australiano (AUD), Iene do Japão (JPY), Renminbi da China (CNY) e Bitcoin (BTC);
- cotação do bitcoin nas principais exchanges como Coinbase, Blockchain.info, BitStamp, FoxBit e Mercado Bitcoin;
- as principais taxas de juros do Brasil como CDI e Selic.

Tudo isso em uma só requisição.

Recomendamos que sempre use sua chave, algumas informações só estão disponíveis com o uso da chave.

Criar nova chave

Todas as requisições em como base o seguinte endpoint:

https://api.hgbrasil.com/finance

Estrutura de dados

Os dados referentes à consulta chegam no parâmetro results, você também pode conferir a autenticação de sua chave no parâmetro de retorno valid_key.

  • currencies - cotação das moedas
    • source - moeda base de cotação
    • ISO da moeda
      • name - nome da moeda
      • buy - valor para compra
      • sell - valor para venda (não disponível para algumas moedas)
      • variation - variação em percentual referente à última hora útil anterior
  • stocks - posições dos principais mercados
    • índice
      • name - nome do índice
      • location - localização do mercado
      • points - pontos (somente IBOVESPA)
      • variation - variação em percentual referente à última hora útil anterior
  • bitcoin - cotação nas principais corretoras
    • corretora
      • name - nome do índice
      • format - array, moeda base de câmbio
        • 0 - ISO da moeda
        • 1 - idioma da moeda
      • last - última posição
      • buy - valor para compra (pode não estar disponível)
      • sell - valor para venda (pode não estar disponível)
      • variation - variação em percentual referente à última hora útil anterior
  • taxes - taxas de juros do Brasil
    • date - data de referência
    • cdi - taxa CDI em percentual
    • selic - taxa Selic em percentual
    • daily_factor - fator diário
    • selic_daily - taxa Selic diária em percentual
    • cdi_daily - taxa CDI diária em percentual

Você pode personalizar o resultado da consulta omitindo alguns dados veja como.

Exemplo de resposta JSON
{"by":"default","valid_key":true,"results":{"currencies":{"source":"BRL","USD":{"name":"Dollar","buy":4.9868,"sell":4.9868,"variation":0.0},"EUR":{"name":"Euro","buy":5.5496,"sell":5.5489,"variation":0.334},"GBP":{"name":"Pound Sterling","buy":6.2679,"sell":null,"variation":0.0},"ARS":{"name":"Argentine Peso","buy":0.0226,"sell":null,"variation":0.975},"CAD":{"name":"Canadian Dollar","buy":3.6524,"sell":null,"variation":-0.287},"AUD":{"name":"Australian Dollar","buy":3.2988,"sell":null,"variation":-0.001},"JPY":{"name":"Japanese Yen","buy":0.0366,"sell":null,"variation":-0.042},"CNY":{"name":"Renminbi","buy":0.7214,"sell":null,"variation":0.007},"BTC":{"name":"Bitcoin","buy":154563.561,"sell":154563.561,"variation":-0.441}},"stocks":{"IBOVESPA":{"name":"BM\u0026F BOVESPA","location":"Sao Paulo, Brazil","points":104431.63,"variation":1.47},"IFIX":{"name":"Índice de Fundos de Investimentos Imobiliários B3","location":"Sao Paulo, Brazil","points":2858.23,"variation":1.1},"NASDAQ":{"name":"NASDAQ Stock Market","location":"New York City, United States","points":12226.58,"variation":0.69},"DOWJONES":{"name":"Dow Jones Industrial Average","location":"New York City, United States","points":34098.16,"variation":0.8},"CAC":{"name":"CAC 40","location":"Paris, French","points":7491.5,"variation":0.1},"NIKKEI":{"name":"Nikkei 225","location":"Tokyo, Japan","points":28856.44,"variation":1.4}},"available_sources":["BRL"],"bitcoin":{"blockchain_info":{"name":"Blockchain.info","format":["USD","en_US"],"last":29273.54,"buy":29273.54,"sell":29273.54,"variation":-0.327},"coinbase":{"name":"Coinbase","format":["USD","en_US"],"last":29292.36,"variation":-0.299},"bitstamp":{"name":"BitStamp","format":["USD","en_US"],"last":29277.0,"buy":29283.0,"sell":29277.0,"variation":-0.354},"foxbit":{"name":"FoxBit","format":["BRL","pt_BR"],"last":146496.0028,"variation":-0.793},"mercadobitcoin":{"name":"Mercado Bitcoin","format":["BRL","pt_BR"],"last":146809.0,"buy":146854.02249774,"sell":146890.29,"variation":-0.599}},"taxes":[{"date":"2023-04-27","cdi":13.75,"selic":13.75,"daily_factor":1.00050788,"selic_daily":13.65,"cdi_daily":13.65}]},"execution_time":0.0,"from_cache":true}

Obtendo o preço de ações ou FIIs listados no IBOVESPA

API gratuita para obter preço de ações na bolsa de valores BOVESPA!

Novidade!

Consulte também fundos imobiliários!

Com esse endpoint você pode obter o preço de uma ação listada no IBOVESPA através do símbolo desse título.
Atenção! É necessário ser membro à partir do plano Member Premium para realizar essa consulta.
Planos acima oferencem um maior número de títulos ao mesmo tempo, confira aqui nossos planos.

Delay:
API para fins informativos, os dados podem estar atrasados entre 15 minutos e 1 hora.
É possível conferir o horário de atualização do dado no updated_at.

Títulos disponíveis: veja a lista.

Requer chave: sim
Requer plano: sim, plano Member Premium ou superior

Os dados são obtidos a partir do símbolo de uma empresa (veja a lista), através do parâmetro symbol.

https://api.hgbrasil.com/finance/stock_price?key=SUA-CHAVE&symbol=embr3


Nos planos Professional ou Enterprise é possível obter vários símbolos nas mesma consulta, separando por vírgula.

https://api.hgbrasil.com/finance/stock_price?key=SUA-CHAVE&symbol=embr3,hglg11,itsa4
Estrutura de dados

Os dados referentes à consulta chegam no parâmetro results, você também pode conferir a autenticação de sua chave no parâmetro de retorno valid_key.

  • kind - tipo do título
    • stock - ação
    • fii - fundo imobiliário
  • symbol - símbolo / ticker da ação
  • name - nome da empresa
  • company_name - razão social
  • document - documento / CNPJ da empresa
  • description - descrição da empresa
  • website - sita da empresa / relação com investidores
  • region - região de operação da bolsa
  • currency - moeda base
  • market_time - horário de negociação
    • open - horário de abertura
    • close - horário de fechamento
    • timezone - fuso horário
  • logo - logotipo da empresa
    • small - URL para imagem em PNG 256 x 256
    • big - URL para imagem em PNG 1.280 x 1.280
  • market_cap - valor de mercado (em milhões)
  • price - preço por ação
  • change_percent - percentual de mudança do dia
  • updated_at - última atualização

Atenção! Exoneração de responsabilidade

Exemplo de resposta JSON
{"by":"symbol","valid_key":true,"results":{"EMBR3":{"kind":"stock","symbol":"EMBR3","name":"Embraer","company_name":"Embraer S.A.","document":"07.689.002/0001-89","description":"Projeto. Desenvolvimento. Fabricação. Comercialização de Aeronaves E Sistemas E Fornecimento de Suporte E Serviços de Pós-venda.","website":"http://www.embraer.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/embraer.png","big":"https://assets.hgbrasil.com/finance/companies/big/embraer.png"},"market_cap":14379.8,"price":19.42,"change_percent":1.2,"updated_at":"2023-04-29 20:51:16"},"HGLG11":{"kind":"fii","symbol":"HGLG11","name":"FII CSHG Log","company_name":"CSHG Logstica Fundo Investimento Imobiliario FII","document":"11.728.688/0001-47","description":"Financeiro e Outros/Fundos/Fundos Imobiliários","website":"https://www.cshg.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":null,"market_cap":3811.71,"price":162.5,"change_percent":0.0,"updated_at":"2023-04-29 20:51:17"},"ITSA4":{"kind":"stock","symbol":"ITSA4","name":"ItauSA","company_name":"ItauSA S.A.","document":"61.532.644/0001-15","description":"Gestão de Participações Societárias (holding)","website":"http://www.itausa.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/itausa.png","big":"https://assets.hgbrasil.com/finance/companies/big/itausa.png"},"market_cap":84720.1,"price":8.68,"change_percent":1.05,"updated_at":"2023-04-29 20:51:16"}},"execution_time":0.17,"from_cache":false}

Obtendo as ações com as maiores altas ou baixas no IBOVESPA

Com esse endpoint você pode obter a lista de títulos que estão em maiores altas ou baixas.
Atenção! É necessário ser membro à partir do plano Member Premium para realizar essa consulta.
Planos acima oferencem um maior número de títulos ao mesmo tempo, confira aqui nossos planos.

Conheça nossos planos

Delay:
API para fins informativos, os dados podem estar atrasados entre 15 minutos e 1 hora.
É possível conferir o horário de atualização do dado no updated_at.

Títulos disponíveis: veja a lista.

Requer chave: sim
Requer plano: sim, plano Member Premium ou superior

A lista é gerada apenas com os símbolo que fazem estão em nossa plataforma, veja a lista aqui.

Para obter as maiores altas, informe no parâmetro symbol a opção get-high, exemplo:

https://api.hgbrasil.com/finance/stock_price?key=SUA-CHAVE&symbol=get-high


E para obter as maiores baixas, informe no parâmetro symbol a opção get-low, exemplo:

https://api.hgbrasil.com/finance/stock_price?key=SUA-CHAVE&symbol=get-low


A estrutura de dados é a mesma para o retorno de títulos do IBOVESPA.

Atenção! Exoneração de responsabilidade

Exemplo de resposta JSON
{"by":"get_high_symbols","valid_key":true,"results":{"CORR4":{"kind":"stock","symbol":"CORR4","name":"Cor Ribeiro","company_name":"Correa Ribeiro S.A. Comercio E Industria","document":"15.101.405/0001-93","description":"","website":"http://www.crci.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":null,"market_cap":0.0,"price":82.0,"change_percent":8224.03,"updated_at":"2023-04-28 17:07:59"},"LIGT3":{"kind":"stock","symbol":"LIGT3","name":"Light S/A","company_name":"Light S.A.","document":"03.378.521/0001-75","description":"Participação em Sociedades P/ Exploração Serviços de Energia Elétrica","website":"http://www.light.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/light-s-a.png","big":"https://assets.hgbrasil.com/finance/companies/big/light-s-a.png"},"market_cap":1199.63,"price":3.22,"change_percent":18.38,"updated_at":"2023-04-29 20:51:18"},"DASA3":{"kind":"stock","symbol":"DASA3","name":"DaSA","company_name":"Diagnosticos Da America S.A.","document":"61.486.650/0001-83","description":"Análises Clínicas E Medicina Diagnóstica","website":"http://www.dasa3.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/dasa.png","big":"https://assets.hgbrasil.com/finance/companies/big/dasa.png"},"market_cap":4697.71,"price":8.45,"change_percent":17.69,"updated_at":"2023-04-29 20:51:18"},"SNSY3":{"kind":"stock","symbol":"SNSY3","name":"Sansuy","company_name":"Sansuy S.A. Industria De Plasticos","document":"14.807.945/0001-24","description":"Indústria E Comércio de Artefatos Plásticos","website":"http://www.sansuy.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/sansuy.png","big":"https://assets.hgbrasil.com/finance/companies/big/sansuy.png"},"market_cap":22.32,"price":4.4,"change_percent":17.02,"updated_at":"2023-04-29 20:51:19"},"PETR4":{"kind":"stock","symbol":"PETR4","name":"Petrobras","company_name":"Petroleo Brasileiro S.A. Petrobras","document":"33.000.167/0001-01","description":"Pesquisa. Lavra. Refinação. Processamento. Comércio E Transporte de Petróleo. de Seus Derivados. de Gás Natural E de Outros Hidrocarbonetos Fluidos. Além Das Atividades Vinculadas à Energia.","website":"http://www.petrobras.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/petrobras.png","big":"https://assets.hgbrasil.com/finance/companies/big/petrobras.png"},"market_cap":328541.0,"price":23.7,"change_percent":16.14,"updated_at":"2023-04-29 20:51:16"},"SOND3":{"kind":"stock","symbol":"SOND3","name":"Sondotecnica","company_name":"Sondotecnica Engenharia Solos S.A.","document":"33.386.210/0001-19","description":"Serviços de Engenharia.","website":"http://www.sondotecnica.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/sondotecnica.png","big":"https://assets.hgbrasil.com/finance/companies/big/sondotecnica.png"},"market_cap":98.5,"price":46.01,"change_percent":15.08,"updated_at":"2023-04-29 20:51:19"},"PETR3":{"kind":"stock","symbol":"PETR3","name":"Petrobras","company_name":"Petroleo Brasileiro S.A. Petrobras","document":"33.000.167/0001-01","description":"Pesquisa. Lavra. Refinação. Processamento. Comércio E Transporte de Petróleo. de Seus Derivados. de Gás Natural E de Outros Hidrocarbonetos Fluidos. Além Das Atividades Vinculadas à Energia.","website":"http://www.petrobras.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/petrobras.png","big":"https://assets.hgbrasil.com/finance/companies/big/petrobras.png"},"market_cap":328541.0,"price":26.67,"change_percent":14.93,"updated_at":"2023-04-29 20:51:16"},"USIM5":{"kind":"stock","symbol":"USIM5","name":"Usiminas","company_name":"Usinas Sid De Minas Gerais S.A. Usiminas","document":"60.894.730/0001-05","description":"Venda de Produtos Siderúrgicos. Como Chapas Grossas. Laminados A Quente. A Frio. Placas. Galvanizados. Entre Outros.","website":"http://www.usiminas.com/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/usiminas.png","big":"https://assets.hgbrasil.com/finance/companies/big/usiminas.png"},"market_cap":9051.8,"price":7.2,"change_percent":11.41,"updated_at":"2023-04-29 20:51:16"},"IRBR3":{"kind":"stock","symbol":"IRBR3","name":"Irbbrasil Re","company_name":"Irb Brasil Resseguros S.A.","document":"33.376.989/0001-91","description":"Operações de Resseguro E Retrocessão","website":"http://ri.irbbrasilre.com/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/irbbrasil-re.png","big":"https://assets.hgbrasil.com/finance/companies/big/irbbrasil-re.png"},"market_cap":2588.82,"price":31.47,"change_percent":11.4,"updated_at":"2023-04-29 20:51:16"},"ESPA3":{"kind":"stock","symbol":"ESPA3","name":"Espacolaser","company_name":"Mpm Corpóreos S.A.","document":"26.659.061/0001-59","description":"Participação Como Sócia de Sociedades Empresárias Que Desenvolvam Atividades de Depilação. Estética Facial. Capilar E Corporal E A Comercialização de Produtos Cosméticos E de Cuidados Corporais.","website":null,"region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/espacolaser.png","big":"https://assets.hgbrasil.com/finance/companies/big/espacolaser.png"},"market_cap":430.09,"price":1.19,"change_percent":11.21,"updated_at":"2023-04-29 20:51:20"},"EPAR3":{"kind":"stock","symbol":"EPAR3","name":"Embpar","company_name":"Embpar Participacoes S.A.","document":"42.331.462/0001-31","description":"Com.de Caminhões E ónibus Scania. Seus Acessórios E Prest.serv.assist.técnica; Industrializ.e Com. de Madeiras; Prestação de Serviços Sob A Forma de Trading Company; Partic. em Outras Sociedades.","website":"http://www.battistella.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":null,"market_cap":194.23,"price":13.07,"change_percent":10.76,"updated_at":"2023-04-29 20:51:17"},"GSHP3":{"kind":"stock","symbol":"GSHP3","name":"Generalshopp","company_name":"General Shopping E Outlets Do Brasil S.A.","document":"08.764.621/0001-53","description":"Administração de Shopping Centers","website":"http://www.generalshopping.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":null,"market_cap":32.17,"price":16.68,"change_percent":9.52,"updated_at":"2023-04-29 20:51:18"},"GOLL4":{"kind":"stock","symbol":"GOLL4","name":"Gol","company_name":"Gol Linhas Aereas Inteligentes S.A.","document":"06.164.253/0001-87","description":"Gestão de Participação Societária","website":"http://www.voegol.com.br/ri/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/gol.png","big":"https://assets.hgbrasil.com/finance/companies/big/gol.png"},"market_cap":2779.86,"price":6.64,"change_percent":9.03,"updated_at":"2023-04-29 20:51:16"},"EQPA6":{"kind":"stock","symbol":"EQPA6","name":"Eqtl Para","company_name":"Equatorial Para Distribuidora De Energia S.A.","document":"04.895.728/0001-80","description":"Distribuição de Energia Elétrica","website":"http://www.celpa.com.br/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/eqtl-para.png","big":"https://assets.hgbrasil.com/finance/companies/big/eqtl-para.png"},"market_cap":0.0,"price":10.69,"change_percent":9.01,"updated_at":"2023-04-28 20:53:20"},"BRFS3":{"kind":"stock","symbol":"BRFS3","name":"Brf Sa","company_name":"Brf S.A.","document":"01.838.723/0001-27","description":"Holding Operacional","website":"http://www.brf-br.com/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/brf-sa.png","big":"https://assets.hgbrasil.com/finance/companies/big/brf-sa.png"},"market_cap":6862.88,"price":6.34,"change_percent":8.93,"updated_at":"2023-04-29 20:51:16"},"DESK3":{"kind":"stock","symbol":"DESK3","name":"Desktop","company_name":"Desktop Sigmanet Comunicação Multimídia S.A.","document":"08.170.849/0001-15","description":"Serviços de Telefonia Fixa. Telecomunicações Sem Fio. Televisão Por Assinatura. Provedores de Acesso às Redes de Comunicações E Voz. Tratamento de Dados. Provedores de Serviços de Aplicação.","website":null,"region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/desktop.png","big":"https://assets.hgbrasil.com/finance/companies/big/desktop.png"},"market_cap":1016.14,"price":8.82,"change_percent":8.89,"updated_at":"2023-04-29 20:51:20"},"PEAB4":{"kind":"stock","symbol":"PEAB4","name":"Par Al Bahia","company_name":"Cia Participacoes Alianca Da Bahia","document":"01.938.783/0001-11","description":"Participações em Outras Sociedades. Na Qualidade de Sócia E/ou Quotista E Administração de Bnes Próprios","website":"http://www.aliancaparticipacoes.com.br","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":null,"market_cap":626.73,"price":65.0,"change_percent":8.33,"updated_at":"2023-04-28 20:53:21"},"CRPG3":{"kind":"stock","symbol":"CRPG3","name":"Cristal","company_name":"Tronox Pigmentos Do Brasil S.A.","document":"15.115.504/0001-24","description":"","website":"http://www.cristal-al.com.br","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/cristal.png","big":"https://assets.hgbrasil.com/finance/companies/big/cristal.png"},"market_cap":1086.17,"price":55.0,"change_percent":8.17,"updated_at":"2023-04-28 17:07:59"},"TEND3":{"kind":"stock","symbol":"TEND3","name":"Tenda","company_name":"Construtora Tenda S.A.","document":"71.476.527/0001-35","description":"","website":"http://www.tenda.com/","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":{"small":"https://assets.hgbrasil.com/finance/companies/small/tenda.png","big":"https://assets.hgbrasil.com/finance/companies/big/tenda.png"},"market_cap":609.37,"price":5.84,"change_percent":8.15,"updated_at":"2023-04-29 20:51:19"},"JOPA3":{"kind":"stock","symbol":"JOPA3","name":"JoSApar","company_name":"JoSApar Joaquim Oliveira S.A. Particip","document":"87.456.562/0001-22","description":"Beneficiamento de Arroz E Participações","website":"http://www.josapar.com.br","region":"Brazil/Sao Paulo","currency":"BRL","market_time":{"open":"10:00","close":"17:30","timezone":-3},"logo":null,"market_cap":239.76,"price":22.5,"change_percent":7.88,"updated_at":"2023-04-29 20:51:18"}},"execution_time":0.57,"from_cache":false}

Obtendo os dividendos de Fundos Imobiliários

Novidade!

Este endpoint acabou de sair do forno!

Com esse endpoint você pode obter os dividendos de Fundos Imobiliários listados no IBOVESPA através do símbolo desse título.
Atenção! É necessário ser membro à partir do plano Professional para realizar essa consulta.
Planos acima do Professional oferencem um maior número de títulos ao mesmo tempo, confira aqui nossos planos.

Conheça nossos planos

Títulos disponíveis: veja a lista (somente para fundos imobiliários).

Requer chave: sim
Requer plano: sim, plano Professional ou superior

Os dados são obtidos a partir do símbolo de um fundo imobiliário, através do parâmetro symbol.

É possível obter vários símbolos nas mesma consulta, separando por vírgula.

https://api.hgbrasil.com/finance/stock_dividends?key=SUA-CHAVE&symbol=hglg11,alzr11,tgar11,visc11
Estrutura de dados

Os dados referentes à consulta chegam no parâmetro results, você também pode conferir a autenticação de sua chave no parâmetro de retorno valid_key.

  • kind - tipo do título
    • cash - pagamento em dinheiro
    • stock - pagamento em cotas
  • currency - moeda
  • isin_code - padronização internacional na codificação de títulos financeiros
  • label - referência
  • amount - valor
  • approved_in - aprovado em
  • traded_until - para negócios até
  • payment_date - data do pagamento (pode ser uma data futura)

Atenção! Exoneração de responsabilidade

Exemplo de resposta JSON
{"by":"symbol_dividends","valid_key":true,"results":{"HGLG11":[{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2023-03-31","traded_until":"2023-03-31","payment_date":"2023-04-17"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2023-02-28","traded_until":"2023-02-28","payment_date":"2023-03-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2023-01-31","traded_until":"2023-01-31","payment_date":"2023-02-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":2.2,"approved_in":"2022-12-29","traded_until":"2022-12-29","payment_date":"2023-01-13"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-11-30","traded_until":"2022-11-30","payment_date":"2022-12-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-10-31","traded_until":"2022-10-31","payment_date":"2022-11-16"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-09-30","traded_until":"2022-09-30","payment_date":"2022-10-17"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-08-31","traded_until":"2022-08-31","payment_date":"2022-09-15"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-07-29","traded_until":"2022-07-29","payment_date":"2022-08-12"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":3.3,"approved_in":"2022-06-30","traded_until":"2022-06-30","payment_date":"2022-07-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-05-31","traded_until":"2022-05-31","payment_date":"2022-06-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGR12M13","label":"Rendimento","amount":0.17,"approved_in":"2022-05-31","traded_until":"2022-05-31","payment_date":"2022-06-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGR13M12","label":"Rendimento","amount":1.14,"approved_in":"2022-05-31","traded_until":"2022-05-31","payment_date":"2022-06-14"},{"kind":"cash","currency":"brl","isin_code":"BRHGLGCTF004","label":"Rendimento","amount":1.1,"approved_in":"2022-04-29","traded_until":"2022-04-29","payment_date":"2022-05-13"}],"ALZR11":[{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.815755,"approved_in":"2023-04-17","traded_until":"2023-04-17","payment_date":"2023-04-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.815755,"approved_in":"2023-03-17","traded_until":"2023-03-17","payment_date":"2023-03-24"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.80556,"approved_in":"2023-02-15","traded_until":"2023-02-15","payment_date":"2023-02-24"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.783682,"approved_in":"2023-01-18","traded_until":"2023-01-18","payment_date":"2023-01-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.725452,"approved_in":"2022-12-16","traded_until":"2022-12-16","payment_date":"2022-12-23"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.775096,"approved_in":"2022-11-18","traded_until":"2022-11-18","payment_date":"2022-11-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRR12M14","label":"Rendimento","amount":0.905424,"approved_in":"2022-10-18","traded_until":"2022-10-18","payment_date":"2022-10-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRR14M12","label":"Rendimento","amount":0.217023,"approved_in":"2022-10-18","traded_until":"2022-10-18","payment_date":"2022-10-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRR13M13","label":"Rendimento","amount":0.689916,"approved_in":"2022-10-18","traded_until":"2022-10-18","payment_date":"2022-10-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRR11M15","label":"Rendimento","amount":0.905424,"approved_in":"2022-10-18","traded_until":"2022-10-18","payment_date":"2022-10-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.7955,"approved_in":"2022-10-18","traded_until":"2022-10-18","payment_date":"2022-10-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":5.6507,"approved_in":"2022-09-16","traded_until":"2022-09-16","payment_date":"2022-09-23"},{"kind":"cash","currency":"brl","isin_code":"BRALZRR12M14","label":"Rendimento","amount":0.647945,"approved_in":"2022-09-16","traded_until":"2022-09-16","payment_date":"2022-09-23"},{"kind":"cash","currency":"brl","isin_code":"BRALZRR11M15","label":"Rendimento","amount":1.01954,"approved_in":"2022-09-16","traded_until":"2022-09-16","payment_date":"2022-09-23"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.781923,"approved_in":"2022-08-18","traded_until":"2022-08-18","payment_date":"2022-08-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.784729,"approved_in":"2022-07-18","traded_until":"2022-07-18","payment_date":"2022-07-25"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.780682,"approved_in":"2022-06-17","traded_until":"2022-06-17","payment_date":"2022-06-24"},{"kind":"cash","currency":"brl","isin_code":"BRALZRCTF006","label":"Rendimento","amount":0.77561,"approved_in":"2022-05-18","traded_until":"2022-05-18","payment_date":"2022-05-25"}],"TGAR11":[{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.35,"approved_in":"2023-04-28","traded_until":"2023-04-28","payment_date":"2023-05-15"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.34,"approved_in":"2023-03-31","traded_until":"2023-03-31","payment_date":"2023-04-17"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.34,"approved_in":"2023-03-31","traded_until":"2023-03-31","payment_date":"2023-04-11"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.31,"approved_in":"2023-02-28","traded_until":"2023-02-28","payment_date":"2023-03-14"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.31,"approved_in":"2023-02-28","traded_until":"2023-02-28","payment_date":"2023-03-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.3,"approved_in":"2023-01-31","traded_until":"2023-01-31","payment_date":"2023-02-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.3,"approved_in":"2022-12-29","traded_until":"2022-12-29","payment_date":"2023-01-09"},{"kind":"cash","currency":"brl","isin_code":"BRTGARR12M19","label":"Rendimento","amount":1.02,"approved_in":"2022-11-30","traded_until":"2022-11-30","payment_date":"2022-12-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARR14M17","label":"Rendimento","amount":0.47,"approved_in":"2022-11-30","traded_until":"2022-11-30","payment_date":"2022-12-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARR13M18","label":"Rendimento","amount":0.94,"approved_in":"2022-11-30","traded_until":"2022-11-30","payment_date":"2022-12-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.5,"approved_in":"2022-11-30","traded_until":"2022-11-30","payment_date":"2022-12-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARR12M19","label":"Rendimento","amount":0.35,"approved_in":"2022-10-31","traded_until":"2022-10-31","payment_date":"2022-11-09"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.55,"approved_in":"2022-10-31","traded_until":"2022-10-31","payment_date":"2022-11-09"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.59,"approved_in":"2022-09-30","traded_until":"2022-09-30","payment_date":"2022-10-10"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.59,"approved_in":"2022-08-31","traded_until":"2022-08-31","payment_date":"2022-09-09"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.58,"approved_in":"2022-07-29","traded_until":"2022-07-29","payment_date":"2022-08-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.57,"approved_in":"2022-06-30","traded_until":"2022-06-30","payment_date":"2022-07-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.53,"approved_in":"2022-05-31","traded_until":"2022-05-31","payment_date":"2022-06-08"},{"kind":"cash","currency":"brl","isin_code":"BRTGARCTF009","label":"Rendimento","amount":1.44,"approved_in":"2022-04-29","traded_until":"2022-04-29","payment_date":"2022-05-09"}],"VISC11":[{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.82,"approved_in":"2023-04-28","traded_until":"2023-04-28","payment_date":"2023-05-15"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.82,"approved_in":"2023-03-31","traded_until":"2023-03-31","payment_date":"2023-04-17"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.8,"approved_in":"2023-02-28","traded_until":"2023-02-28","payment_date":"2023-03-14"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.82,"approved_in":"2023-01-31","traded_until":"2023-01-31","payment_date":"2023-02-14"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.85,"approved_in":"2022-12-29","traded_until":"2022-12-29","payment_date":"2023-01-13"},{"kind":"cash","currency":"brl","isin_code":"BRVISCR11M11","label":"Rendimento","amount":1.37,"approved_in":"2022-12-08","traded_until":"2022-12-08","payment_date":"2022-12-15"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.76,"approved_in":"2022-11-30","traded_until":"2022-11-30","payment_date":"2022-12-14"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.75,"approved_in":"2022-10-31","traded_until":"2022-10-31","payment_date":"2022-11-16"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.74,"approved_in":"2022-09-30","traded_until":"2022-09-30","payment_date":"2022-10-17"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.72,"approved_in":"2022-08-31","traded_until":"2022-08-31","payment_date":"2022-09-15"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.71,"approved_in":"2022-07-29","traded_until":"2022-07-29","payment_date":"2022-08-12"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.7,"approved_in":"2022-06-30","traded_until":"2022-06-30","payment_date":"2022-07-14"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.7,"approved_in":"2022-05-31","traded_until":"2022-05-31","payment_date":"2022-06-14"},{"kind":"cash","currency":"brl","isin_code":"BRVISCCTF005","label":"Rendimento","amount":0.7,"approved_in":"2022-04-29","traded_until":"2022-04-29","payment_date":"2022-05-13"}]},"execution_time":0.19,"from_cache":false}

Formatos de retorno

Você pode escolher o formato de resposta da API através do parâmetro format na sua requisição.

https://api.hgbrasil.com/finance?format=json-cors&key=SUA-CHAVE
Formatos disponíveis
  • json - retorno em JSON, padrão
  • json-cors - retorno em JSON com headers CORS, chave exposta requerida
  • php-serialize - serialização do PHP (antigo formato da API)
  • debug - JSON visual para humanos, apenas para testes, não utilizar em produção

Aumente seus limites na API ou obtenha suporte

 

Conheça as vantagens de ser membro da API

Sendo assinante, além de ajudar a manter o serviço para a comunidade, você terá acesso ao nosso suporte, maiores limites de consulta e recursos exclusivos.

Quero conhecer

Obter todos os dados em uma só requisição

Com este método, todos os dados são retornados em uma só requisição.

Dados retornados:

Câmbio das moedas: Dólar USD, Euro EUR, Libra (GBP), Peso (ARS) e Bitcoin (BTC) para Real (BRL);
Valores de exchanges de Bitcoin (BTC) como Coinbase, Blockchain.info, BitStamp, FoxBit e Mercado Bitcoin;
Variação dos índices: IBOVESPA, IFIX, NASDAQ, Dow Jones, CAC 40 e NIKKEI;
Taxas brasileiras: CDI, SELIC e fator diário.

Requer chave: sim, para que todos os dados sejam exibidos

https://api.hgbrasil.com/finance?key=SUA-CHAVE

Obter somente cotações de moedas e bolsas

Com este método, apenas as cotações de moedas e bolsa de valores são retornados.

Dados retornados:

Câmbio das moedas: Dólar (USD), Euro (EUR), Libra (GBP), Peso (ARS) e Bitcoin (BTC) para Real (BRL);
Valores de exchanges de Bitcoin (BTC) como Coinbase, Blockchain.info, BitStamp, FoxBit e Mercado Bitcoin;
Variação das bolsas de valores: IBOVESPA, NASDAQ, CAC 40 e NIKKEI.

Requer chave: sim, para que todos os dados sejam exibidos

https://api.hgbrasil.com/finance/quotations?key=SUA-CHAVE

Obter somente taxas CDI e SELIC

Com este método, apenas as taxas de juros, CDI e Selic são retornadas.

Dados retornados:

Taxas brasileiras: CDI, SELIC e fator diário.

Requer chave: sim

https://api.hgbrasil.com/finance/taxes?key=SUA-CHAVE

Obtendo dados históricos

Com este método, você pode acessar dados históricos registrados pela API.
Esse método necessita da contratação de um plano que tenha suporte à dados históricos.

Conheça nossos planos

Requer chave: sim
Requer plano: sim (com suporte à dados históricos)

Os dados históricos são obtidos a partir de uma data passada.

https://api.hgbrasil.com/finance/historical?key=SUA-CHAVE&days_ago=3&mode=all


Você pode escolher a data por 3 tipos de filtros diferentes:
Por intervalo de datas:
  • start_date - data de inicio, string yyyy-mm-dd
  • end_date - data de término, string yyyy-mm-dd

Por data única:
  • date - data de inicio, string yyyy-mm-dd

Por número de dias atrás:
  • days_ago - número de dias atrás, inteiro

Somente um filtro desses 3 acima pode ser escolhido.

Juntamente com uma das datas acima, você pode:

Obter todos os dados, ou somente um usando o filtro mode:
  • mode - string, disponíveis: all, currencies, stocks, bitcoin, taxes

Somente um filtro acima pode ser utilizado.

Exemplo de resposta
{"by":"days_ago","mode":"all","valid_key":true,"results":{"2023-04-28":{"currencies":{"USD":{"name":"Dollar","first":4.9775,"last":4.9868,"max":5.0085,"min":4.9775,"avg":4.9924},"EUR":{"name":"Euro","first":5.4887,"last":5.5311,"max":5.5311,"min":5.4756,"avg":5.5034},"GBP":{"name":"Pound Sterling","first":6.2193,"last":6.2679,"max":6.2978,"min":6.2193,"avg":6.2618},"ARS":{"name":"Argentine Peso","first":0.0224,"last":0.0224,"max":0.0225,"min":0.0224,"avg":0.0224},"CAD":{"name":"Canadian Dollar","first":3.6612,"last":3.6629,"max":3.6918,"min":3.6571,"avg":3.6769},"AUD":{"name":"Australian Dollar","first":3.2985,"last":3.2988,"max":3.3105,"min":3.283,"avg":3.3002},"JPY":{"name":"Japanese Yen","first":0.0372,"last":0.0366,"max":0.0372,"min":0.0366,"avg":0.0368},"CNY":{"name":"Renminbi","first":0.7189,"last":0.7214,"max":0.7243,"min":0.7189,"avg":0.7219},"BTC":{"name":"Bitcoin","first":154654.509,"last":155178.218,"max":155569.361,"min":153267.835,"avg":154735.7386}},"stocks":{"IBOVESPA":{"name":"BM\u0026F BOVESPA","first":0.6,"last":1.47,"max":1.47,"min":-0.35,"avg":0.7932},"IFIX":{"name":"Índice de Fundos de Investimentos Imobiliários B3","first":0.36,"last":1.1,"max":1.1,"min":0.0,"avg":0.5991},"NASDAQ":{"name":"NASDAQ Stock Market","first":2.43,"last":0.69,"max":2.43,"min":-0.31,"avg":0.9145},"DOWJONES":{"name":"Dow Jones Industrial Average","first":1.57,"last":0.8,"max":1.57,"min":0.0,"avg":0.6873},"CAC":{"name":"CAC 40","first":0.23,"last":0.1,"max":0.23,"min":-0.58,"avg":-0.0064},"NIKKEI":{"name":"Nikkei 225","first":0.15,"last":1.4,"max":1.4,"min":0.15,"avg":1.1727}},"bitcoin":{"blockchain_info":{"name":"Blockchain.info","first":29298.29,"last":29369.52,"max":29380.7,"min":29038.16,"avg":29247.2691},"coinbase":{"name":"Coinbase","first":29319.41,"last":29380.27,"max":29384.42,"min":29045.53,"avg":29262.2282},"bitstamp":{"name":"BitStamp","first":29294.0,"last":29381.0,"max":29381.0,"min":29039.0,"avg":29249.3636},"foxbit":{"name":"FoxBit","first":147054.111,"last":147666.3336,"max":148853.9115,"min":146169.5389,"avg":147066.619},"mercadobitcoin":{"name":"Mercado Bitcoin","first":146897.99171237,"last":147694.0,"max":147900.0,"min":145578.25289973,"avg":147014.2961}},"taxes":{}},"2023-04-27":{"currencies":{"USD":{"name":"Dollar","first":5.0445,"last":4.9782,"max":5.0445,"min":4.9719,"avg":5.0078},"EUR":{"name":"Euro","first":5.569,"last":5.489,"max":5.569,"min":5.4833,"avg":5.5201},"GBP":{"name":"Pound Sterling","first":6.2895,"last":6.2213,"max":6.2895,"min":6.2113,"avg":6.248},"ARS":{"name":"Argentine Peso","first":0.0228,"last":0.0224,"max":0.0228,"min":0.0224,"avg":0.0226},"CAD":{"name":"Canadian Dollar","first":3.7005,"last":3.6606,"max":3.7005,"min":3.6574,"avg":3.6786},"AUD":{"name":"Australian Dollar","first":3.3337,"last":3.2988,"max":3.3337,"min":3.297,"avg":3.3141},"JPY":{"name":"Japanese Yen","first":0.0378,"last":0.0372,"max":0.0378,"min":0.0371,"avg":0.0374},"CNY":{"name":"Renminbi","first":0.7283,"last":0.719,"max":0.7283,"min":0.7181,"avg":0.7231},"BTC":{"name":"Bitcoin","first":155006.117,"last":156905.376,"max":157217.915,"min":154110.101,"avg":155302.4395}},"stocks":{"IBOVESPA":{"name":"BM\u0026F BOVESPA","first":-0.88,"last":0.6,"max":0.61,"min":-0.88,"avg":0.0755},"IFIX":{"name":"Índice de Fundos de Investimentos Imobiliários B3","first":0.08,"last":0.36,"max":0.37,"min":0.08,"avg":0.2214},"NASDAQ":{"name":"NASDAQ Stock Market","first":0.47,"last":2.43,"max":2.49,"min":0.47,"avg":1.555},"DOWJONES":{"name":"Dow Jones Industrial Average","first":-0.68,"last":1.57,"max":1.62,"min":-0.68,"avg":0.6509},"CAC":{"name":"CAC 40","first":-0.86,"last":0.23,"max":0.5,"min":-0.86,"avg":0.0009},"NIKKEI":{"name":"Nikkei 225","first":-0.71,"last":0.15,"max":0.15,"min":-0.71,"avg":-0.0455}},"bitcoin":{"blockchain_info":{"name":"Blockchain.info","first":28993.18,"last":29716.1,"max":29831.41,"min":28892.21,"avg":29263.3109},"coinbase":{"name":"Coinbase","first":28977.1,"last":29731.23,"max":29825.33,"min":28859.49,"avg":29250.9127},"bitstamp":{"name":"BitStamp","first":28997.0,"last":29728.0,"max":29830.0,"min":28880.0,"avg":29271.5455},"foxbit":{"name":"FoxBit","first":146566.4521,"last":148808.7047,"max":149398.0851,"min":145632.0142,"avg":147402.7736},"mercadobitcoin":{"name":"Mercado Bitcoin","first":147013.52004001,"last":148773.12768301,"max":149244.28665911,"min":146065.79751305,"avg":147406.5031}},"taxes":{"cdi":13.65,"selic":13.65,"daily_factor":1.00050788}},"2023-04-26":{"currencies":{"USD":{"name":"Dollar","first":5.0544,"last":5.045,"max":5.0704,"min":5.0404,"avg":5.0533},"EUR":{"name":"Euro","first":5.5487,"last":5.5696,"max":5.6173,"min":5.5487,"avg":5.5754},"GBP":{"name":"Pound Sterling","first":6.2775,"last":6.2896,"max":6.3329,"min":6.2775,"avg":6.2968},"ARS":{"name":"Argentine Peso","first":0.0229,"last":0.0228,"max":0.023,"min":0.0227,"avg":0.0228},"CAD":{"name":"Canadian Dollar","first":3.7115,"last":3.7007,"max":3.7211,"min":3.7006,"avg":3.7082},"AUD":{"name":"Australian Dollar","first":3.3542,"last":3.3307,"max":3.3542,"min":3.3284,"avg":3.3398},"JPY":{"name":"Japanese Yen","first":0.0378,"last":0.0377,"max":0.0381,"min":0.0377,"avg":0.0378},"CNY":{"name":"Renminbi","first":0.7291,"last":0.7283,"max":0.7325,"min":0.7277,"avg":0.7295},"BTC":{"name":"Bitcoin","first":155478.927,"last":151135.842,"max":160391.894,"min":148679.631,"avg":157015.6612}},"stocks":{"IBOVESPA":{"name":"BM\u0026F BOVESPA","first":-0.7,"last":-0.88,"max":0.03,"min":-0.96,"avg":-0.4795},"IFIX":{"name":"Índice de Fundos de Investimentos Imobiliários B3","first":-0.04,"last":0.08,"max":0.17,"min":-0.04,"avg":0.0509},"NASDAQ":{"name":"NASDAQ Stock Market","first":-1.98,"last":0.47,"max":1.3,"min":-1.98,"avg":0.0214},"DOWJONES":{"name":"Dow Jones Industrial Average","first":-1.02,"last":-0.68,"max":0.14,"min":-1.02,"avg":-0.4618},"CAC":{"name":"CAC 40","first":-0.56,"last":-0.86,"max":-0.56,"min":-1.23,"avg":-0.8605},"NIKKEI":{"name":"Nikkei 225","first":0.09,"last":-0.71,"max":0.09,"min":-0.71,"avg":-0.5645}},"bitcoin":{"blockchain_info":{"name":"Blockchain.info","first":29019.91,"last":28261.84,"max":29886.93,"min":27731.08,"avg":29314.5936},"coinbase":{"name":"Coinbase","first":29015.73,"last":28271.61,"max":29983.44,"min":27705.63,"avg":29320.5818},"bitstamp":{"name":"BitStamp","first":29006.0,"last":28286.0,"max":29890.0,"min":27570.0,"avg":29303.2273},"foxbit":{"name":"FoxBit","first":147195.0488,"last":142726.6416,"max":151863.0,"min":140555.0513,"avg":148529.7701},"mercadobitcoin":{"name":"Mercado Bitcoin","first":147553.60194999,"last":143818.20871279,"max":151800.0,"min":141579.1557294,"avg":148730.5195}},"taxes":{"cdi":13.65,"selic":13.65,"daily_factor":1.00050788}}},"execution_time":0.76,"from_cache":false}

O sistema obtem os dados e faz o cálculo diário para cada retorno, a fim de obter o primeiro valor, último, maior, menor e média.

Obtendo dados históricos de ações e Fundos Imobiliários

Novidade!

Este endpoint acabou de sair do forno!

Com este método, você pode acessar dados históricos registrados pela API de ações e fundos imobiliários.
Esse método necessita da contratação de um plano que tenha suporte à dados históricos de finanças.

Conheça nossos planos

Requer chave: sim
Requer plano: sim (com suporte à dados históricos)

Os dados históricos são obtidos a partir de uma data passada.

https://api.hgbrasil.com/finance/historical/stocks?key=SUA-CHAVE&days_ago=3&symbols=embr3,itsa4,hglg11


Para buscar por ações ou fundos imobiliários, você pode utilizar as mesmas formas de busca da API:

Somente um é necessário.

* o número máximo de tickers em uma mesma consulta varia de acordo com o plano contratado

Você pode escolher a data por 3 tipos de filtros diferentes:
Por intervalo de datas:
  • start_date - data de inicio, string yyyy-mm-dd
  • end_date - data de término, string yyyy-mm-dd

Por data única:
  • date - data de inicio, string yyyy-mm-dd

Por número de dias atrás:
  • days_ago - número de dias atrás, inteiro

Somente um filtro desses 3 acima pode ser escolhido.

Exemplo de resposta
{"by":"days_ago","mode":"all","valid_key":true,"results":{"2023-04-26":{"EMBR3":{"10:06":19.45,"10:10":19.55,"10:30":19.8,"10:45":19.46,"10:56":19.55,"11:05":19.62,"11:26":19.51,"11:46":19.48,"11:58":19.53,"12:10":19.54,"12:20":19.56,"12:29":19.59,"12:55":19.65,"12:57":19.65,"13:16":19.61,"13:26":19.58,"13:36":19.58,"13:55":19.63,"14:05":19.7,"14:15":19.72,"14:36":19.75,"14:38":19.76,"14:55":19.73,"15:06":19.72,"15:16":19.74,"15:35":19.73,"15:40":19.73,"15:56":19.74,"15:57":19.7,"16:15":19.75,"16:20":19.73,"16:36":19.7,"16:45":19.62,"16:49":19.61,"16:56":19.61,"17:07":19.66},"ITSA4":{"10:06":8.59,"10:10":8.55,"10:30":8.53,"10:45":8.53,"10:56":8.51,"11:05":8.49,"11:26":8.49,"11:46":8.51,"11:58":8.51,"12:10":8.52,"12:20":8.52,"12:29":8.51,"12:55":8.51,"12:57":8.52,"13:16":8.52,"13:26":8.51,"13:36":8.52,"13:55":8.52,"14:05":8.51,"14:15":8.5,"14:36":8.52,"14:38":8.5,"14:55":8.49,"15:06":8.47,"15:16":8.51,"15:35":8.51,"15:40":8.47,"15:56":8.47,"15:57":8.47,"16:15":8.48,"16:20":8.46,"16:36":8.46,"16:45":8.47,"16:49":8.49,"16:56":8.48,"17:07":8.48},"HGLG11":{"10:10":161.74,"10:30":162.0,"10:50":162.1,"11:10":161.85,"11:31":161.58,"11:51":161.21,"12:10":161.0,"12:30":161.13,"12:51":161.31,"13:10":161.2,"13:31":161.15,"13:50":161.47,"14:11":161.44,"14:31":161.4,"14:51":161.54,"15:11":161.74,"15:31":161.63,"15:50":161.66,"16:10":161.75,"16:31":161.81,"16:51":161.83,"17:05":162.0}},"2023-04-27":{"HGLG11":{"10:10":162.0,"10:31":162.13,"10:50":162.18,"11:10":162.28,"11:31":162.32,"11:50":162.24,"12:10":162.29,"12:30":162.27,"12:50":162.3,"13:10":162.22,"13:30":162.33,"13:50":162.2,"14:10":162.15,"14:30":162.25,"14:51":162.28,"15:11":162.32,"15:30":162.3,"15:51":162.08,"16:10":162.25,"16:31":162.34,"16:50":162.42,"17:06":162.5},"ITSA4":{"10:31":8.49,"10:26":8.49,"10:36":8.55,"10:30":8.55,"10:52":8.55,"10:58":8.55,"11:16":8.57,"11:26":8.55,"11:38":8.55,"11:56":8.57,"12:05":8.56,"12:15":8.56,"12:23":8.57,"12:36":8.57,"12:56":8.54,"13:14":8.56,"13:31":8.54,"13:46":8.53,"13:56":8.53,"14:16":8.53,"14:36":8.52,"14:38":8.53,"14:56":8.52,"15:06":8.57,"15:25":8.57,"15:35":8.58,"15:50":8.56,"16:07":8.56,"16:10":8.56,"16:26":8.55,"16:45":8.58,"16:56":8.59,"17:07":8.59},"EMBR3":{"10:26":19.52,"10:36":19.21,"10:30":19.49,"10:52":19.3,"10:58":19.33,"11:16":19.19,"11:26":19.04,"11:38":19.02,"11:56":18.89,"12:05":18.86,"12:15":18.76,"12:23":18.76,"12:36":18.82,"12:56":18.88,"13:14":18.91,"13:31":19.04,"13:46":19.07,"13:56":19.09,"14:16":19.07,"14:25":19.03,"14:36":19.09,"14:38":19.08,"14:56":19.1,"15:06":19.09,"15:25":19.09,"15:35":19.07,"15:50":19.08,"16:07":19.13,"16:10":19.13,"16:26":19.16,"16:45":19.13,"16:56":19.1,"17:07":19.19}},"2023-04-28":{"HGLG11":{"10:10":162.44,"10:31":162.5,"10:51":162.5,"11:10":162.48,"11:30":162.5,"11:51":162.48,"12:11":162.5,"12:30":162.46,"12:50":162.5,"13:10":162.5,"13:30":162.5,"13:51":162.45,"14:10":162.49,"14:31":162.49,"14:50":162.5,"15:10":162.5,"15:30":162.5,"15:50":162.5,"16:11":162.5,"16:30":162.5,"16:49":162.5,"17:06":162.5},"ITSA4":{"10:20":8.55,"10:34":8.51,"10:50":8.55,"11:08":8.55,"11:26":8.6,"11:44":8.58,"11:58":8.58,"12:09":8.59,"12:32":8.61,"12:50":8.66,"13:31":8.66,"13:25":8.67,"13:45":8.68,"14:06":8.67,"14:19":8.66,"14:32":8.68,"14:46":8.68,"15:05":8.69,"15:08":8.68,"15:26":8.69,"15:46":8.67,"16:06":8.67,"16:26":8.65,"16:46":8.65,"16:49":8.62,"16:56":8.62,"17:07":8.68},"EMBR3":{"10:20":19.16,"10:34":19.03,"10:50":19.24,"11:08":19.31,"11:26":19.45,"11:44":19.43,"11:58":19.38,"12:09":19.39,"12:32":19.42,"12:50":19.39,"13:25":19.42,"13:45":19.48,"14:06":19.43,"14:19":19.38,"14:32":19.41,"14:46":19.37,"15:05":19.35,"15:08":19.35,"15:26":19.28,"15:46":19.22,"16:06":19.31,"16:26":19.35,"16:46":19.31,"16:49":19.32,"16:56":19.32,"17:07":19.42}}},"execution_time":0.32,"from_cache":false}

Personalizando a resposta

Algumas aplicações, como IOT, tem menos poder em processar e parsear dados. Por isso você pode em sua requisição, solicitar que alguns dados sejam omitidos, para que apenas os dados que você necessite sejam exibidos.

https://api.hgbrasil.com/finance?array_limit=1&fields=only_results,bitcoin&key=SUA-CHAVE

Você pode escolher quais campos são retornados, limitar arrays ou ignorar os retornos de status e chave. Este recurso é compatível apenas com o formato JSON e requer o uso de sua chave de API.

  • fields - neste parâmetro você configura o recurso e escolhe quais campos manter, dados válidos abaixo, você pode colocar mais de um, separados por vírgula
    • only_results - remove os dados de status, cache e chave, enviando apenas os resultados
    • nome-do-campo - nome do campo desejado
  • array_limit - inteiro limitando o número de itens em arrays do retorno

Qualquer forma de busca pode ser utilizada junto a este método.

Exemplo de resposta
{"bitcoin":{"blockchain_info":{"name":"Blockchain.info","format":["USD","en_US"],"last":29273.54,"buy":29273.54,"sell":29273.54,"variation":-0.327},"coinbase":{"name":"Coinbase","format":["USD","en_US"],"last":29292.36,"variation":-0.299},"bitstamp":{"name":"BitStamp","format":["USD","en_US"],"last":29303.0,"buy":29302.0,"sell":29299.0,"variation":-0.265},"foxbit":{"name":"FoxBit","format":["BRL","pt_BR"],"last":146673.4036,"variation":-0.672},"mercadobitcoin":{"name":"Mercado Bitcoin","format":["BRL","pt_BR"],"last":146878.74352001,"buy":146873.64711479,"sell":146918.06929592,"variation":-0.552}}}

Dicas de boas práticas

Faça cache
Para que seus limites de consulta sejam utilizados da melhor forma possível, faça cache de suas requisições.

Cada pageview do seu site ou aplicação, não necessita necessáriamente de uma nova consulta ao HG Finance.

Por exemplo, se seu usuário acabou de entrar, faça uma consulta (mesmo que seja no lado do cliente), mas assim que o dado for obtido, salve em um armazenamento local ou temporário para que na próxima página que seu usuário entrar, essa consulta não seja necessária.

Utilize rotinas
Se sua aplicação permitir, utilize rotinas ou threads para obter os dados. Isso pode melhorar o tempo final de resposta do seu serviço que utiliza a API.

Exoneração de responsabilidade

API para fins informativos. Não garantimos a precisão dos dados fornecidos pela API ou contidos nesta página, uma vez que devem ser utilizados apenas para efeitos informativos. Trabalhamos pela estabilidade e precisão dos dados, porém, os dados podem estar atrasados ou errados "no estado em que se encontram", confirme todos os dados antes de efetuar qualquer ação que possa ser afetada por estes valores, assim como demais endpoints da API.

Qualquer dúvida verifique nossos termos de uso ou entre em contato.