{ "openapi": "3.0.1", "info": { "title": "Brazil CNPJ Lookup & Company Registry Scraper", "description": "Look up any Brazilian CNPJ or search the Receita Federal company registry by state, CNAE, city, legal form, or partner CPF. Get status, address, phones, CNAEs, capital, Simples/MEI, tax regime, and partners (QSA). Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "HHYMGLR674Kwl6StY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~brazil-cnpj-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-brazil-cnpj-scraper", "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/parsebird~brazil-cnpj-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-brazil-cnpj-scraper", "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/parsebird~brazil-cnpj-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-brazil-cnpj-scraper", "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": { "cnpjs": { "title": "CNPJs to look up", "type": "array", "description": "Add CNPJs, one per line, to get the full registry record for each one. Dots, slashes, and dashes are ignored, and missing leading zeros are added back. When you add CNPJs, the search filters below are ignored.", "items": { "type": "string" } }, "cnpj": { "title": "Single CNPJ", "type": "string", "description": "Look up one CNPJ, for example 00.000.000/0001-91. Same as adding one line to 'CNPJs to look up'." }, "uf": { "title": "State (UF)", "type": "string", "description": "Two-letter state code such as SP, RJ, or DF. Separate several states with commas: SP, RJ, MG." }, "cnae": { "title": "CNAE activity code", "type": "string", "description": "7-digit CNAE code, for example 6209100 (IT support) or 62.01-5/01. Matches both the primary and the secondary activities unless 'Primary CNAE only' is on." }, "primaryCnaeOnly": { "title": "Primary CNAE only", "type": "boolean", "description": "Match the CNAE code against the company's primary activity only.", "default": false }, "municipio": { "title": "Municipality code", "type": "string", "description": "IBGE code (7 digits, e.g. 3550308 for São Paulo) or SIAFI code (4 digits, e.g. 7107). Digits only." }, "naturezaJuridica": { "title": "Legal form code", "type": "string", "description": "4-digit natureza jurídica code, e.g. 2135 (Empresário Individual, used by MEIs), 2062 (Sociedade Empresária Limitada), 2054 (Sociedade Anônima Fechada)." }, "partnerCpf": { "title": "Partner CPF or CNPJ", "type": "string", "description": "Find every company where this person or company is a partner (sócio). Enter a full CPF (123.456.789-01), a masked CPF as Receita shows it (***456789**), or a partner company's CNPJ. Add a state to make the search faster." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Save only companies whose registration status is ATIVA.", "default": false }, "headOfficeOnly": { "title": "Head offices only", "type": "boolean", "description": "Save only head offices (MATRIZ) and skip branches (FILIAL).", "default": false }, "maxItems": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "Stop after saving this many companies.", "default": 100 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 1024, "type": "integer", "description": "Records requested per page from the registry API (1 to 1,024). You rarely need to change this.", "default": 500 } } }, "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 } } } } } } } } } }