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
Exemplo de Requisição
Autorizações
Parâmetros de consulta
tokenstringOpcional
Token de autenticação (opcional, pode ser passado no header como x_api_token
)
Respostas
200
Sucesso
application/json
401
Não autenticado
application/json
404
Não encontrado
application/json
get
GET /consumo HTTP/1.1
Host: comercial.cnpj.ws
x_api_token: YOUR_API_KEY
Accept: */*
{
"filtros_disponiveis": [
"text"
],
"filtros_aplicados": {},
"ordenacao": [
"text"
],
"data": [
{
"mes": 1,
"ano": 1,
"quantidade": 1,
"atualizado_em": "2025-06-30T22:05:50.351Z",
"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);
}
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"
}
]
}
Atualizado
Isto foi útil?