{ "openapi": "3.0.1", "info": { "title": "New Company Registrations Feed", "description": "Get companies newly registered in official business registers: UK Companies House, Norway Brreg, Finland PRH, and France BODACC. Filter by date, industry code, activity, name, and place. One row per company with number, type, address, industry, and website when listed. Only new on a schedule.", "version": "0.1", "x-build-id": "tMcO2xq1XCHNJm59d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mambalabs~new-company-registrations-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mambalabs-new-company-registrations-feed", "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/mambalabs~new-company-registrations-feed/runs": { "post": { "operationId": "runs-sync-mambalabs-new-company-registrations-feed", "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/mambalabs~new-company-registrations-feed/run-sync": { "post": { "operationId": "run-sync-mambalabs-new-company-registrations-feed", "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": { "registers": { "title": "Registers", "type": "array", "description": "Which official registers to read. Empty: all four. UK Companies House is read only when you give your own free Companies House API key below.", "items": { "type": "string", "enum": [ "uk_companies_house", "norway_brreg", "finland_prh", "france_bodacc" ], "enumTitles": [ "UK Companies House (needs your free API key)", "Norway Brreg (Enhetsregisteret)", "Finland PRH (YTJ)", "France BODACC (company creation notices)" ] } }, "registered_within_days": { "title": "Registered within (days)", "minimum": 1, "maximum": 90, "type": "integer", "description": "Only companies registered in the last this many days, today included. France: the day BODACC published the creation notice.", "default": 7 }, "industry_codes": { "title": "Industry codes", "type": "array", "description": "Industry code prefixes, for example 62 (computer programming and IT), 70.2 (management consultancy), or 56 (food and beverage service). UK SIC 2007, Norway SN2007, and Finland TOL 2008 all follow the EU NACE codes, so one prefix works across the three. France BODACC publishes no industry code and is skipped when this is set; use Activity keywords for France.", "items": { "type": "string" } }, "activity_keywords": { "title": "Activity keywords", "type": "array", "description": "Words to find in the activity text the register publishes, in its own language, for example logiciel or conseil (France) or programvare (Norway). Matched against the activity text and the industry code description. A register entry with neither is dropped.", "items": { "type": "string" } }, "name_keywords": { "title": "Company name keywords", "type": "array", "description": "Keep only companies whose name contains one of these words, for example consulting or studio.", "items": { "type": "string" } }, "locations": { "title": "Places", "type": "array", "description": "Keep only companies whose registered city or region equals one of these (any case), or whose postal code starts with a short code you give, for example London, Oslo, Helsinki, Lyon, EC1, or 75.", "items": { "type": "string" } }, "active_only": { "title": "Active companies only", "type": "boolean", "description": "Drop entries the register already marks dissolved, bankrupt, or in liquidation.", "default": true }, "companies_house_api_key": { "title": "Companies House API key", "type": "string", "description": "Your own free UK Companies House REST API key, from developer.company-information.service.gov.uk. Without it, UK Companies House is skipped and the run says so. The key is used for this run only and is never stored by the actor." }, "max_companies": { "title": "Max companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Company rows per run, newest registration first. Each company row is one company-row charge.", "default": 200 }, "only_new": { "title": "Only new results", "type": "boolean", "description": "For scheduled runs. Skip companies an earlier run with the same state key already returned. Skipped companies are free. The seen list is kept in a key-value store in your account.", "default": false }, "state_key": { "title": "State key", "type": "string", "description": "Names the seen list for Only new results. Use one key per schedule. Empty: a key made from the input." }, "max_charge_usd": { "title": "Max charge per run (USD)", "type": "string", "description": "Stop before a row would push this run past this amount. Empty: no limit beyond the one you set in Apify." }, "source_tag": { "title": "Source tag", "type": "string", "description": "Internal attribution tag for published tasks. Leave empty." } } }, "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 } } } } } } } } } }