API Reference

Consultando o saldo de créditos

Saiba quantas consultas você ainda tem disponível a cada resposta

Cada vez que você realiza uma consulta em nossa API, informamos na resposta a quantidade de consultas que você ainda tem disponível para realizar dentro do plano atual.

Response Header

Para obter o número de consultas disponíveis, basta realizar a leitura do parâmetro no Header chamado remainingcredits, desta forma será possível se preparar para não ficar sem créditos de consulta antes do término do mês.

Dashboard

Existe também uma alternativa a este método, basta que você acesse nossa plataforma e confira a quantidade de consultas disponíveis no dashboard, lá também será possível consultar outros dados como o plano atual, a quantidade de consultas realizadas nos últimos dias e o histórico completo.

Saldo de créditos insuficiente

Caso não haja mais créditos de consultas disponíveis, você receberá uma resposta do tipo HTTP 405 com a seguinte mensagem

{
  "status": "Error",
  "code": 1004,
  "message": "No remaining credits left."
}

Consulte nossa documentação de tratamento de erros


Restaram dúvidas, entre em contato com a nossa equipe através do e-mail [email protected]