Empresas Brasileiras

Contar empresas

Contagem de empresas brasileiras pelos filtros do permit. Sem group_by, data é inteiro; com group_by da whitelist, data é o objeto valor→contagem (contagens inteiras). As três chaves filter, group_by e data estão sempre presentes. group_by é null quando o cliente não envia o parâmetro. filter ecoa filter_attributes (chaves vazias omitidas).

Autenticação: Authorization: Bearer <token_digest> (preferida) ou query api_token (legado). Recusas 400/401/403/429 usam o JSON literal do controller e dos concerns.

Disponível conforme o plano (api_search_enabled). Cada chamada conta 1 na quota mensal. Limite de 30 chamadas por minuto por conta neste grupo de endpoints; eligible devolve até 1.000 CNPJs por página.

get/api/v1/brazilian_companies/count

Request

  • Base URL: https://app.oportunidados.com.br
  • URL: https://app.oportunidados.com.br/api/v1/brazilian_companies/count
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Query parameters

api_tokenstring

Digest do ApiToken (legado). Prefira Authorization: Bearer.

namestring

Escalar

nomestring

Escalar

razaostring

Escalar

cnpjstring

Escalar

include_cnae_secundariostring

Escalar

cnae_fiscalstring[]

Array de string; CSV na query (campo=a,b).

munstring[]

Array de string; CSV na query (campo=a,b).

natureza_juridicastring[]

Array de string; CSV na query (campo=a,b).

opcao_meistring[]

Array de string; CSV na query (campo=a,b).

opcao_simplesstring[]

Array de string; CSV na query (campo=a,b).

portestring[]

Array de string; CSV na query (campo=a,b).

situacao_cadastralstring[]

Array de string; CSV na query (campo=a,b).

situacao_especialstring[]

Array de string; CSV na query (campo=a,b).

ufstring[]

Array de string; CSV na query (campo=a,b).

categoria_natureza_juridicastring[]

Array de string; CSV na query (campo=a,b).

contact_fieldsstring[]

Array de string; CSV na query (campo=a,b).

matriz_filialstring[]

Array de string; CSV na query (campo=a,b).

motivo_situacaostring[]

Array de string; CSV na query (campo=a,b).

mun_excludestring[]

Array de string; CSV na query (campo=a,b).

numero_filiais_rangestring[]

Array de string; CSV na query (campo=a,b).

regime_tributariostring[]

Array de string; CSV na query (campo=a,b).

data_inicio_interval[]string[]

Array de string; repita o parâmetro (campo[]=a&campo[]=b). CSV NÃO funciona aqui: o controller só faz split(",") nos nomes de FILTER_ARRAY_PARAMS, e o permit descarta a string.

data_situacao_interval[]string[]

Array de string; repita o parâmetro (campo[]=a&campo[]=b). CSV NÃO funciona aqui: o controller só faz split(",") nos nomes de FILTER_ARRAY_PARAMS, e o permit descarta a string.

bairro[]string[]

Array de string; repita o parâmetro (campo[]=a&campo[]=b). CSV NÃO funciona aqui: o controller só faz split(",") nos nomes de FILTER_ARRAY_PARAMS, e o permit descarta a string.

cep[]string[]

Array de string; repita o parâmetro (campo[]=a&campo[]=b). CSV NÃO funciona aqui: o controller só faz split(",") nos nomes de FILTER_ARRAY_PARAMS, e o permit descarta a string.

capital_social_range[]string[]

Array de string; repita o parâmetro (campo[]=a&campo[]=b). CSV NÃO funciona aqui: o controller só faz split(",") nos nomes de FILTER_ARRAY_PARAMS, e o permit descarta a string.

group_by'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' | 'bairro'

Agrupamento por uma coluna. Ausente → data inteiro; presente → data é o objeto valor→contagem.

group_by[]string[]

Agrupamento por mais de uma coluna: repita group_by[] (group_by[]=uf&group_by[]=porte). O eco de group_by na resposta vem como array.

Response

sucesso

Changes

No recorded changes to this operation across all 1 revision of this API.