API - Commercial
Consulting Monthly Request Consumption
How to check the number of monthly requests made in the CNPJ.ws Commercial API.
In this endpoint, you can check the number of requests made per month. You must send the x_api_token header with the token or pass the token via query string in the URL.
You can also pass the token as a parameter in the URL, example:
https://comercial.cnpj.ws/consumo?token=YOUR_TOKEN
Method: GET
Endpoint: https://comercial.cnpj.ws/consumo
Attention: Queries to this endpoint also count as an API request.
Request Example
AuthorizationBearer <token>
Token de API (Bearer). Ex.: Authorization: Bearer <seu_token>
In: header
Query Parameters
token?string
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/consumo"{ "filtros_disponiveis": [ "string" ], "filtros_aplicados": {}, "ordenacao": [ "string" ], "data": [ { "mes": 0, "ano": 0, "quantidade": 0, "atualizado_em": "2019-08-24T14:15:22Z", "cnpjws_usuario_id": "string" } ]}{ "status": 0, "titulo": "string", "detalhes": "string", "validacao": [ "string" ], "statusCode": 0, "message": "string", "error": "string"}{ "status": 0, "titulo": "string", "detalhes": "string", "validacao": [ "string" ], "statusCode": 0, "message": "string", "error": "string"}We have a package that can help you integrate with JavaScript:
yarn add consultar-cnpjconst consultarCNPJ = require("consultar-cnpj");
async function getCNPJ() {
const token = "INFORME O SEU TOKEN DE ACESSO";
const consumo = await consultarCNPJ.consumo(token);
console.log(consumo);
}Return Example
Below is an example of the JSON returned:
{
"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"
}
]
}