Consultando o Consumo de Requisições Mensais

Nesse endpoint é possível consultar a quantidade de requisições que foram feitas por mês. Você deve enviar o header x_api_token com o token ou passar o token por query string na URL.

Você também pode passar o token como um parâmetro na URL, exemplo:

https://comercial.cnpj.ws/consumo?token=SEU_TOKEN

Método: GET

Endpoint: https://comercial.cnpj.ws/consumo

Atenção: As consultas nesse endpoint também contam como uma requisição à API.

Exemplo de Requisição

Consultar a quantidade de requisições que foram feitas por mês.

GEThttps://comercial.cnpj.ws/consumo

Authorization

x_api_tokentoken

Query parameters

Response

200401404

Sucesso

Body

application/json

filtros_disponiveisarray of string

filtros_aplicadosobject

ordenacaoarray of string

dataarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://comercial.cnpj.ws/consumo', {
    method: 'GET',
    headers: {
      "x_api_token": "x_api_token <apiKey>"
    },
});
const data = await response.json();

Response

200401404

{
  "filtros_disponiveis": [
    "text"
  ],
  "filtros_aplicados": {},
  "ordenacao": [
    "text"
  ],
  "data": [
    {
      "mes": 1,
      "ano": 1,
      "quantidade": 1,
      "atualizado_em": "2025-02-05T06:56:15.828Z",
      "cnpjws_usuario_id": "text"
    }
  ]
}

Nós possuímos um pacote que pode te ajudar na integração com JavaScript:

yarn add consultar-cnpj

const consultarCNPJ = require("consultar-cnpj");

async function getCNPJ() {
  const token = "INFORME O SEU TOKEN DE ACESSO";

  const consumo = await consultarCNPJ.consumo(token);
  console.log(consumo);
}

Mais informações

Exemplo de Retorno

Abaixo um exemplo do JSON retornado:

{
  "filtros_disponiveis": ["ano", "mes"],
  "filtros_aplicados": {},
  "ordenacao": ["ano", "mes"],
  "data": [
    {
      "mes": 9,
      "ano": 2021,
      "quantidade": 1,
      "atualizado_em": "2021-09-29T20:41:55.144Z",
      "cnpjws_usuario_id": "d046b852-XXXX-XXXX-XXXX-8dccdf11d417"
    }
  ]
}