Playground
Experimente cada requisição no navegador e copie o código.
No API Playground, você experimenta qualquer requisição no navegador, sem código. Você vê a resposta real da API e depois copia a requisição como código.
Requisições sem código
O Playground precisa de uma conta com endereço de e-mail confirmado. Ele tem uma aba para cada endpoint:
| Aba | Endpoint | O que você experimenta |
|---|---|---|
| Perfil da empresa | fetch-organization | Dados básicos, recursos, Modo IA e Tempo real |
| Perfil de pessoa | fetch-person | Cargos e participações de uma pessoa, a partir do Plus |
| Documentos | fetch-document | Extratos do registro, listas de sócios e contratos sociais |
| Busca & Exportação | search-organizations | Busca com filtros e exportação como arquivo |
| Signals | signals | Alterações no registro por tema e período |
À esquerda, você monta a requisição. Cada campo é um parâmetro da API e mostra seu nome real, por exemplo q, feature ou ai_search=on-default.
À direita fica a resposta. “Visualização” a mostra formatada, “JSON” exatamente como a API a retorna, erros incluídos.
Copiar o código
Acima da resposta está a requisição com o método e a URL completa. Um clique em “Código” a abre como exemplo em cURL, Python, JavaScript e PHP; para o perfil de pessoa, em cURL, Python e JavaScript.
Os exemplos usam HTTP simples e o placeholder YOUR_API_KEY. Substitua-o pela sua chave de API de Conta › Chaves de API.
Exportar listas de empresas
Na aba Busca & Exportação, você baixa uma lista de resultados inteira como arquivo, em CSV, Excel ou JSON. Uma exportação abrange até 5.000 empresas.
Você vê os custos antes de começar. O preço base de 50 créditos inclui as primeiras 17 páginas com 30 empresas cada; cada página adicional custa 6 créditos.
A exportação continua rodando em segundo plano, mesmo se você sair da página. O arquivo fica depois em Conta › Exportações.
Uma exportação só lê os resultados quando roda, então alterações até lá estão incluídas. Por padrão, ela deixa de fora empresas sem endereço publicado; você pode mudar isso antes de começar.
Pela API, você percorre os mesmos resultados com skip e limit, veja Montar listas de empresas.