{ "openapi": "3.0.1", "info": { "title": "Brazil Company Finder (CNPJ, English industry labels)", "description": "Search every active Brazilian company (CNPJ) by industry (CNAE), state, city, size, age and share capital. Pre-cleaned Receita Federal data with English CNAE labels, HTTP-verified websites and an accountant-contact filter. No 25 GB raw download.", "version": "0.1", "x-build-id": "eX89qjAPoh88euYPx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/latsouth~brazil-company-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-latsouth-brazil-company-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/latsouth~brazil-company-finder/runs": { "post": { "operationId": "runs-sync-latsouth-brazil-company-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/latsouth~brazil-company-finder/run-sync": { "post": { "operationId": "run-sync-latsouth-brazil-company-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "cnae_divisions": { "title": "Industry divisions (CNAE 2-digit)", "type": "array", "description": "Two-digit CNAE divisions of the main activity, e.g. 62 = IT services (software development, IT consulting), 47 = retail trade, 86 = human health. Combined with industry codes using OR.", "items": { "type": "string" } }, "cnae_codes": { "title": "Industry codes (CNAE subclass or prefix)", "type": "array", "description": "Full 7-digit CNAE subclasses (6201501 or 6201-5/01) or shorter prefixes (4-5 digits = class or group).", "items": { "type": "string" } }, "include_secondary_cnaes": { "title": "Also match secondary activities", "type": "boolean", "description": "If on, industry codes also match companies that list the code as a secondary activity.", "default": false }, "keyword": { "title": "Keyword", "type": "string", "description": "Case- and accent-insensitive substring searched in the English activity label and in the legal and trade names (e.g. software, clinic, logistica)." }, "states": { "title": "States (UF)", "type": "array", "description": "Leave empty for all of Brazil. Selecting states makes runs faster.", "items": { "type": "string", "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "enumTitles": [ "AC - Acre", "AL - Alagoas", "AM - Amazonas", "AP - Amapa", "BA - Bahia", "CE - Ceara", "DF - Distrito Federal", "ES - Espirito Santo", "GO - Goias", "MA - Maranhao", "MG - Minas Gerais", "MS - Mato Grosso do Sul", "MT - Mato Grosso", "PA - Para", "PB - Paraiba", "PE - Pernambuco", "PI - Piaui", "PR - Parana", "RJ - Rio de Janeiro", "RN - Rio Grande do Norte", "RO - Rondonia", "RR - Roraima", "RS - Rio Grande do Sul", "SC - Santa Catarina", "SE - Sergipe", "SP - Sao Paulo", "TO - Tocantins" ] } }, "cities": { "title": "Cities", "type": "array", "description": "City names as in the federal registry, accents optional (e.g. Sao Paulo, Campinas, Belo Horizonte).", "items": { "type": "string" } }, "company_size": { "title": "Company size (Receita 'porte')", "type": "array", "description": "Leave empty for all sizes.", "items": { "type": "string", "enum": [ "micro", "small", "other" ], "enumTitles": [ "Micro (ME, revenue up to BRL 360k/yr)", "Small (EPP, revenue up to BRL 4.8M/yr)", "Other (medium and large companies)" ] } }, "opened_after": { "title": "Opened on or after", "type": "string", "description": "YYYY-MM-DD" }, "opened_before": { "title": "Opened on or before", "type": "string", "description": "YYYY-MM-DD" }, "min_share_capital": { "title": "Minimum share capital (BRL)", "minimum": 0, "type": "integer", "description": "Declared share capital of the company, in Brazilian reais." }, "only_with_website": { "title": "Only companies with a website guess", "type": "boolean", "description": "Keep only companies whose registered e-mail uses a corporate domain (not Gmail/Hotmail/ISP/accounting firm).", "default": false }, "only_with_verified_website": { "title": "Only companies with a verified website", "type": "boolean", "description": "Keep only companies whose website answered an HTTP check with a 2xx/3xx status and is not a parked, for-sale, suspended, under-construction or hosting default page. The check is at most 90 days older than the dataset build; see website_checked_at.", "default": false }, "only_with_email": { "title": "Only companies with an e-mail", "type": "boolean", "description": "Keep only companies with a syntactically valid registered e-mail.", "default": false }, "only_with_phone": { "title": "Only companies with a phone", "type": "boolean", "description": "Keep only companies with a valid registered phone number.", "default": false }, "exclude_accountant_contacts": { "title": "Exclude accountant contacts", "type": "boolean", "description": "Many Brazilian companies register their accountant's e-mail or phone. When on, companies whose registered contact is shared by many unrelated companies (or looks like an accounting firm) are left out.", "default": true }, "headquarters_only": { "title": "Headquarters only", "type": "boolean", "description": "Return only head offices (matriz), not branches (filiais).", "default": false }, "sort_by": { "title": "Sort by", "enum": [ "share_capital_desc", "opening_date_desc", "opening_date_asc", "cnpj" ], "type": "string", "description": "Order of results. Largest share capital first is a good default for B2B prospecting.", "default": "share_capital_desc" }, "max_results": { "title": "Max results", "minimum": 1, "maximum": 500000, "type": "integer", "description": "You pay per company returned. The run also stops at your spending limit.", "default": 1000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }