Erros

Entenda o formato de erros retornados pela API e consulte a lista completa de códigos.

Quando uma requisição não pode ser processada, a API retorna um objeto errors contendo uma lista com os erros identificados. Cada erro possui um código, uma mensagem descritiva e um link para a documentação.

Formato

Os erros são retornados no array errors da resposta. Os códigos são sempre enviados em letras maiúsculas.

{
  "metadata": {
    "key_status": "invalid",
    "cached": false,
    "response_time_ms": 0.0,
    "language": "pt-br"
  },

  "results": [],

  "errors": [
    {
      "code": "INVALID_API_KEY",
      "message": "Chave de API inválida.",
      "help": "https://hgbrasil.com/docs"
    },
    {
      "code": "UNAUTHORIZED_KEY",
      "message": "Chave não possui acesso para este recurso.",
      "help": "https://hgbrasil.com/docs"
    }
  ]
}

code

string

Código identificador do erro, sempre em letras maiúsculas.

message

string

Mensagem descritiva explicando o motivo do erro.

help

string

Link para a documentação com mais informações.

Lista de Erros

Código	Mensagem
`INVALID_API_KEY`	Chave de API inválida.
`UNAUTHORIZED_KEY`	Chave não possui acesso para este recurso.
`REQUIRED_TICKER`	Ticker é obrigatório.
`INVALID_TICKER`	Ticker inválido.
`INVALID_TIME_SERIES`	Série temporal inválida.
`MAX_PER_REQUEST`	Máximo de itens por requisição excedido.
`INVALID_RANGE`	O dado informado está fora do intervalo permitido.
`HISTORICAL_DATE_LIMIT`	Data máxima do histórico deve estar dentro do limite.
`INVALID_DATE`	Data inválida.
`INVALID_DATE_RANGE`	Intervalo de datas inválido.
`INVALID_PARAMETER`	Parâmetro inválido.
`REQUIRED_DATE`	Data é obrigatório.

Boas Práticas

Recomendações para garantir uma integração eficiente, escalável e robusta.

Mercado Financeiro

Dados financeiros atualizados e precisos.