Receitaws

Brazil Receita WS

A API do [receitaws.com.br](https://receitaws.com.br) é disponibilizada em duas versões, sendo uma versão gratuita e aberta (chamada de API Pública), e outra…

Government & public#government

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A API do receitaws.com.br é disponibilizada em duas versões, sendo uma versão gratuita e aberta (chamada de API Pública), e outra versão autenticada (chamada de API Comercial) que deve ser acessada através de uma assinatura de um dos planos disponíveis em nosso site.

API Pública

O acesso à API Pública não requer autenticação, e permite até 3 consultas por minuto. Esta API retorna dados apenas para CNPJs que já existem em nosso banco de dados (cache). Caso o CNPJ consultado não esteja em nosso banco de dados, a API retornará um erro indicando que a informação não está disponível em cache.

API Comercial

Uso da defasagem máxima

Ao realizar uma consulta utilizando esta API, o sistema irá primeiramente verificar se o CNPJ consultado existe em nossa base de dados (cache).
No caso em que o CNPJ não está no cache: a consulta é considerada em tempo real.
No caso em que o CNPJ está no cache: é feita uma comparação entre a data da última atualização deste CNPJ (campo ultima_atualizacao) e o parâmetro days utilizado na requisição. Se o CNPJ foi atualizado há menos de days dias em nossa base de dados, o retorno será dos dados do cache, caso contrário é realizada uma consulta em tempo real.

Uso do fallback

É possível controlar o comportamento da API em caso de erros ou indisponibilidade da consulta em tempo real através do parâmetro fallback. Caso o valor seja cacheOnError, que é o valor padrão, e a consulta em tempo real não tenha sido resolvida em até 30 segundos, o retorno será dos dados do cache, caso estejam disponíveis. Caso o valor seja noCache, a API não retornará dados do cache em casos de erros ou indisponibilidade da consulta em tempo real.

Consumo dos Limites

O limite que será consumido durante a consulta é determinado de acordo com a lógica descrita acima, que pode resultar em uma consulta de nosso cache ou uma consulta em tempo real. O limite correspondente será verificado antes da execução da consulta, e será debitado no retorno das informações.
No caso da requisição precisar de um limite que a conta não tem disponível, o código HTTP de retorno será o 402.

Timeouts

Consultas em tempo real podem gerar timeouts devido a natureza da consulta a fonte de dados de terceiros. Nestes casos o código HTTP de retorno será 504 após 50 segundos de execução. Caso a consulta não seja resolvida neste período e este código seja retornado, não há dedução do limite de consultas.

Endpoints 6

API Pública

  • GETReceita Federal/cnpj/:cnpjMétodo para recuperar as informações de uma empresa brasileira através do seu CNPJ. As informações são exatamente as mesmas informações retornadas pelo site…

API Comercial

  • GETReceita Federal/cnpj/:cnpj/days/:daysMétodo para recuperar as informações da Receita Federal sobre uma empresa brasileira através do seu CNPJ e respeitando a defasagem máxima dos dados de acordo…
  • GETCadastro de Contribuinte (IE)/ccc/:cnpj/days/:daysMétodo para recuperar as informações do Cadastro Centralizado de Contribuinte (CCC) de uma empresa brasileira através do seu CNPJ e respeitando a defasagem…
  • GETSimples Nacional/simples/:cnpj/days/:daysMétodo para recuperar as informações do Simples Nacional de uma empresa brasileira através do seu CNPJ e respeitando a defasagem máxima dos dados de acordo…
  • GETQuota da Conta/account/quotaRecuperar informações sobre a quota de consultas disponíveis no ciclo atual. As quotas são divididos em consultas realizadas diretamente do nosso banco de…
  • GETRelatório de Consultas Realizadas/account/calls/reportRecuperar informações sobre os chamadas de API realizadas. Esta API retorna as 10mil requisições mais recentes, excluindo consultas realizadas nos últimos 2…

API details

Base URL
https://receitaws.com.br/v1
Authentication
A bearer token in the Authorization header
Operations
6 operations on 6 pathsGET 6
Main resources
API Comercial 5API Pública 1
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0

How to test the Brazil Receita WS in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Brazil Receita WS collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Receita Federal” (GET /cnpj/:cnpj), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Brazil Receita WS?

A API do [receitaws.com.br](https://receitaws.com.br) é disponibilizada em duas versões, sendo uma versão gratuita e aberta (chamada de API Pública), e outra… It is listed under Government & public and has 6 endpoints.

Who publishes the Brazil Receita WS?

It is listed from Receitaws's public API description (an OpenAPI document), not published by Receitaws on Swastik Codes. Anyone who controls receitaws.com.br can claim the profile by adding a DNS TXT record.

What is the base URL of the Brazil Receita WS?

Requests go to https://receitaws.com.br/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Brazil Receita WS?

With A bearer token in the Authorization header.

How many endpoints does the Brazil Receita WS have?

6 operations on 6 paths (6 GET). The largest groups are API Comercial, API Pública.

Is forking the Brazil Receita WS free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.