npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cnpja

v1.0.0

Published

Enriqueça dados empresariais com nossa API de consultas a Receita, I.E. e Simples

Downloads

6

Readme

cnpja

npm npm bundle size NPM semantic-release

Enriqueça dados empresariais com nossa API de consultas a Receita, I.E. e Simples. Mais informações no site oficial.

Instalação

Para instalar o pacote rode:

npm install cnpja

ou

yarn add cnpja

Obtenha sua Chave de API

Acesse a página Minha Conta e copie sua Chave de API. Caso ainda não tenha confirmado seu e-mail, será necessário que o faça antes de poder visualizá-la.

import { CNPJa } from 'cnpja'

const cnpja = new CNPJa('<SUA-CHAVE-DE-API>')

;(async () => {
  try {
    const data = await cnpja.companies('00000000000191')
    console.log(data)
  } catch (error) {
    console.log(error)
  }
})()

Métodos disponíveis

Consulta CNPJ

Nossa consulta ao CNPJ visa retornar dados das seguintes fontes em uma requisição unificada:

  • Receita Federal: Informações institucionais, contato, endereço, atividades e membros.
  • Simples Nacional: Opção pelo Simples e SIMEI.
  • SINTEGRA: Inscrições estaduais de todas as UFs.
  • IBGE: Código do estado e município.

O primeiro argumento da função é o número do CNPJ. A consulta de CNPJ também aceita um segundo argumento em formato de objeto com as seguintes propriedades:

Opções

| Parâmetro | Descrição | Padrão | | --------------------- | ------------------------------------------------------------------------ | ------ | | company_max_age | Idade máxima em dias para retornar dados da empresa do Cache | 1 | | simples_max_age | Idade máxima em dias para retornar dados do Simples do Cache | | | sintegra_max_age | Idade máxima em dias para retornar dados do SINTEGRA | | | enable_cache_fallback | Habilita retorno em Cache no caso de uma requisição em Tempo Real falhar | false |

Exemplo

cnpja.companies('00000000000191', {
  company_max_age: 1,
  simples_max_age: 7,
  sintegra_max_age: 30,
  enable_cache_fallback: false,
})

Download de Arquivos

Esse método faz o download de arquivos.

Aceita o código do arquivo como parâmetro.

Exemplo

cnpja.files('file_token')

Dados da Conta

Provê informações sobre sua conta, incluindo cadastro, plano e créditos restantes.

Exemplo

cnpja.me()

Consulta CNPJ

Retorna seu histórico de requisições dentro do intervalo de data especificado.

O fornecimento das datas é mandatório e deve obedecer o formato YYYY-MM-DD.

Opções

| Parâmetro | Descrição | | ---------- | ---------------------------- | | start_date | Data de início do intervalo | | end_date | Data de término do intervalo |

Exemplo

cnpja.requests({
  start_date: '2020-12-01',
  end_date: '2020-12-10',
})

Contribuindo

Issues e Pull Requests são bem-vindos.

Licença

MIT