{ "openapi": "3.0.1", "info": { "title": "Brazilian Company Registry Lookup", "description": "Look up Brazilian companies by CNPJ, or search a municipality by name, legal nature or activity code (CNAE), in the national CNPJ open data. Companies only: no partners, sole traders, addresses or contacts. One record per establishment, values as published. Pay per record.", "version": "0.1", "x-build-id": "3jQXpgbqnQWaPAuoG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thesjostrandproject~br-company-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thesjostrandproject-br-company-lookup", "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/thesjostrandproject~br-company-lookup/runs": { "post": { "operationId": "runs-sync-thesjostrandproject-br-company-lookup", "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/thesjostrandproject~br-company-lookup/run-sync": { "post": { "operationId": "run-sync-thesjostrandproject-br-company-lookup", "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": { "searchBy": { "title": "Search by", "enum": [ "cnpj", "place" ], "type": "string", "description": "cnpj looks up the numbers in the CNPJ list below. place searches one municipality (state and municipality below, with optional filters); the CNPJ list is then not used.", "default": "cnpj" }, "cnpjs": { "title": "CNPJ numbers (default: one example company)", "maxItems": 100, "type": "array", "description": "Company numbers: the 8-character base returns every establishment of that company, the full 14-character CNPJ returns that one establishment. Dots, slashes and dashes are fine, and new alphanumeric numbers are accepted. Up to 100 per run. The default is one large company's head office; replace it with your own.", "default": [ "00000000000191" ], "items": { "type": "string" } }, "state": { "title": "State", "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" ], "type": "string", "description": "For a place search: the state (UF) to search in.", "default": "" }, "city": { "title": "Municipality", "type": "string", "description": "For a place search: the municipality's name as the register writes it (accents and capitals do not matter, so São Paulo and SAO PAULO are the same), or the register's own 4-digit municipality code.", "default": "" }, "nameContains": { "title": "Company name contains", "type": "string", "description": "For a place search: only companies whose registered name contains this text. Accents and capitals do not matter. Leave empty for any name.", "default": "" }, "legalNatureCode": { "title": "Legal nature code", "type": "string", "description": "For a place search: only companies of this 4-digit legal nature, like 2062 (limited company) or 2046 (listed corporation). Leave empty for any.", "default": "" }, "mainActivityCode": { "title": "Main activity code (CNAE)", "type": "string", "description": "For a place search: only establishments whose main activity code starts with this, like 4711-3/02 or just 47 for all retail. Punctuation is ignored. Leave empty for any activity.", "default": "" }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many company records to return at most (1 to 1000). You pay only for records returned, so a first run stays cheap.", "default": 10 } } }, "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 } } } } } } } } } }