Endpoints do token

Ficha de um CNPJ

GET/brazilian_companies/{cnpj}/company

Devolve a ficha da empresa: cadastro, endereço, CNAEs, sócios com CPF mascarado, contatos disponíveis e contexto de mercado.

curl "https://app.oportunidados.com.br/api/v1/brazilian_companies/12345678000190/company" \
  -H "Authorization: Bearer $OPORTUNIDADOS_API_TOKEN"

Resposta 200 com quatro chaves: company, socios, contatos_extras e contexto, descritas em Campos da ficha. CNPJ fora da base responde 404 {"error": "Record not Found"}.

Custo: 1 chamada por requisição admitida, inclusive quando a resposta é 404.

Contagem de empresas

GET/brazilian_companies/count

Conta as empresas de um recorte e, se você pedir, agrupa a contagem por uma ou mais colunas.

Os valores aceitos em group_by são: uf, cod_municipio, cnae_fiscal, cnae_divisao, cnae_grupo, cnae_classe, porte, situacao_cadastral, opc_simples, opc_mei, cod_nat_juridica, data_inicio_atividade, matriz_filial e bairro. A lista completa de filtros está no Swagger.

curl -G "https://app.oportunidados.com.br/api/v1/brazilian_companies/count" \
  -H "Authorization: Bearer $OPORTUNIDADOS_API_TOKEN" \
  --data-urlencode "uf=SP" \
  --data-urlencode "cnae_fiscal=6201501" \
  --data-urlencode "group_by=porte"

A resposta sempre traz filter (o eco dos filtros aplicados), group_by e data. Sem agrupamento, group_by é null e data é um número; com agrupamento, data é um objeto do valor para a contagem:

{
  "filter": { "uf": ["SP"], "cnae_fiscal": ["6201501"] },
  "group_by": "porte",
  "data": { "01": 18240, "03": 5120, "05": 2310 }
}

Erros próprios da contagem:

• 400 invalid_filter: parâmetro desconhecido. A mensagem cita as chaves recusadas. Não consome chamada.
• 400 Invalid group_by: agrupamento fora da lista acima. A mensagem traz os valores aceitos.
• 403 com errors: combinação de filtros recusada. O valor de errors é um texto com JSON dentro.

Custo: 1 chamada por requisição admitida, não importa quantas empresas o recorte tenha.

Ranking do recorte

GET/brazilian_companies/top

Lista as empresas com maior capital social e as abertas mais recentemente numa atividade, num município ou nos dois.

curl -G "https://app.oportunidados.com.br/api/v1/brazilian_companies/top" \
  -H "Authorization: Bearer $OPORTUNIDADOS_API_TOKEN" \
  --data-urlencode "cnae_fiscal=6201501" \
  --data-urlencode "limit=5"

A resposta traz filter, maiores_capital_social e abertas_recentes. Cada empresa das listas tem cnpj, razao_social, nome_fantasia, capital_social, data_inicio_atividade, cnae_fiscal e opc_mei (verdadeiro ou falso).

Erros próprios do ranking:

• 400 Missing filter: faltou cnae_fiscal e cod_municipio.
• 400 Invalid opc_mei: opc_mei com valor diferente de 0.

Custo: 1 chamada por requisição admitida, com as duas listas na mesma resposta.

Contagem de obras

GET/constructions/count

Conta as obras do Cadastro Nacional de Obras (CNO) de um recorte, com agrupamento opcional.

curl -G "https://app.oportunidados.com.br/api/v1/constructions/count" \
  -H "Authorization: Bearer $OPORTUNIDADOS_API_TOKEN" \
  --data-urlencode "uf=PR" \
  --data-urlencode "group_by=situacao"

Sem agrupamento, a resposta é {"filter": {...}, "total": ...}. Com agrupamento, vem também group_by e data, uma lista de {"code", "label", "count"} da maior contagem para a menor. Em cod_municipio, o code da resposta é o código IBGE.

Erros próprios da contagem de obras:

• 422 Unsupported filter combination: cno ou ni_responsavel junto com situacao ou cnae_responsavel.
• 400 Invalid group_by: agrupamento fora da lista acima.

Custo: 1 chamada por requisição admitida, não importa quantas obras o recorte tenha.