Respostas Formatadas

Suportamos diversos formatos de retorno em nossa API para melhor atender à sua aplicação.

Formatos

Basta aplicar o parâmetro format em qualquer endpoint.

GET
https://api.hgbrasil.com/finance?format=json-cors&key=suachave
format
string
Define o formato desejado de retorno.
  • json: Formato padrão.
  • json-cors: Para aplicações JavaScript com suporte a CORS.
  • php-serialize: Para integração com sistemas PHP.
  • debug: Uma visualização legível para testes (não recomendado para produção).

CORS (Cross-Origin Resource Sharing)

Para aplicações JavaScript que fazem requisições diretamente do navegador, é necessário configurar adequadamente o suporte a CORS. Isso evita erros relacionados à política de mesma origem dos navegadores.

Configuração necessária

Para usar CORS em suas requisições, basta adicionar format=json-cors nas suas requisições.

GET
https://api.hgbrasil.com/finance?format=json-cors&key=suachave
O formato json-cors inclui os cabeçalhos necessários para permitir requisições cross-origin de aplicações JavaScript rodando no navegador.

Filtrando Campos

Este recurso foi desenvolvido especialmente para otimizar o tráfego de rede e melhorar a performance em dispositivos com recursos limitados, como dispositivos IoT e aplicações móveis. Ao filtrar apenas os dados necessários, você reduz o consumo de banda e acelera o processamento.

Você pode personalizar a resposta com o parâmetro fields e limitar a quantidade de respostas com array_limit.

Finance

GET
https://api.hgbrasil.com/finance?fields=only_results,currencies,stocks,bitcoin,taxes&array_limit=2&key=suachave

Weather

Além dos campos básicos, você pode filtrar campos específicos como condition_slug, humidity, wind_speedy, forecast e outros dados meteorológicos:

GET
https://api.hgbrasil.com/weather?fields=only_results,temp,description,city&woeid=455827&key=suachave
GET
https://api.hgbrasil.com/weather?fields=only_results,temp,humidity,wind_speedy,condition_slug,forecast&woeid=455827&array_limit=3&key=suachave

Geo

GET
https://api.hgbrasil.com/geoip?fields=only_results,city,region,country_name,continent&address=remote&key=suachave

fields
string
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
number
Valor inteiro limitando o número de itens na resposta.

Compatível apenas com o formato JSON.