{ "openapi": "3.0.1", "info": { "title": "Company Registry — New Companies, Insolvencies & Search", "description": "Official company registers: new companies in France (BODACC), Norway and Finland daily, French insolvencies, deregistrations and sales, and company search with officers, plus the worldwide LEI index. From $2.50 per 1,000.", "version": "0.2", "x-build-id": "dJvEcD2nJegWaNc2O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tacps126~company-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tacps126-company-registry", "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/tacps126~company-registry/runs": { "post": { "operationId": "runs-sync-tacps126-company-registry", "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/tacps126~company-registry/run-sync": { "post": { "operationId": "run-sync-tacps126-company-registry", "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": { "mode": { "title": "What to do", "enum": [ "new", "search" ], "type": "string", "description": "Follow what the registers publish (new registrations; in France also insolvencies, deregistrations and sales), or look companies up by name.", "default": "new" }, "names": { "title": "Company names (search)", "type": "array", "description": "Names or words to search, e.g. Nokia, Equinor, Boulangerie Paul.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Empty = France, Norway, Finland and Estonia (and, for searches, the worldwide LEI index). US = the state registers of New York, Colorado, Connecticut and Oregon (searches also use the LEI index). Other countries are searched in the LEI index.", "items": { "type": "string", "enum": [ "FR", "NO", "FI", "EE", "CZ", "US", "US-NY", "US-CO", "US-CT", "US-OR", "DE", "GB", "ES", "IT", "NL", "SE", "DK", "IE", "CH", "IN", "SG", "AE" ], "enumTitles": [ "France (SIREN directory, BODACC)", "Norway (Brønnøysund)", "Finland (PRH / YTJ)", "Estonia (e-Business Register)", "Czechia (ARES, search only)", "United States (New York, Colorado, Connecticut, Oregon registers + LEI index)", "United States — New York only", "United States — Colorado only", "United States — Connecticut only", "United States — Oregon only", "Germany (LEI index)", "United Kingdom (LEI index)", "Spain (LEI index)", "Italy (LEI index)", "Netherlands (LEI index)", "Sweden (LEI index)", "Denmark (LEI index)", "Ireland (LEI index)", "Switzerland (LEI index)", "India (LEI index)", "Singapore (LEI index)", "United Arab Emirates (LEI index)" ] } }, "events": { "title": "Events (France)", "type": "array", "description": "Which BODACC announcements to follow (default: new companies). Norway, Finland, Estonia and the US states report new registrations.", "items": { "type": "string", "enum": [ "registration", "insolvency", "deregistration", "sale" ], "enumTitles": [ "New companies", "Insolvency judgments (receivership, liquidation)", "Deregistrations", "Business sales and transfers" ] } }, "registeredWithinDays": { "title": "Within the last N days", "minimum": 1, "maximum": 365, "type": "integer", "description": "New mode: registrations and announcements from this window.", "default": 7 }, "keywords": { "title": "Keywords", "type": "array", "description": "Only companies whose name or activity contains one of these words (e.g. restaurant, software, transport).", "items": { "type": "string" } }, "industryCodes": { "title": "Industry codes", "type": "array", "description": "NACE / NAF / TOL code prefixes, dots optional (e.g. 56.10 restaurants, 62 software and IT, 49.41 road freight). Connecticut uses NAICS (e.g. 7225 restaurants).", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Cities, regions, US states or counties, or postcode prefixes (e.g. Oslo, Bouches-du-Rhône, 75 for Paris, Brooklyn, Kings).", "items": { "type": "string" } }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Directors, managers and registered agents as published by the register.", "default": true }, "maxItemsPerSource": { "title": "Max per register", "minimum": 1, "type": "integer", "description": "Most records read from each register.", "default": 500 }, "maxItems": { "title": "Max in total", "minimum": 1, "type": "integer", "description": "Most companies returned.", "default": 500 }, "onlyNew": { "title": "Only new companies", "type": "boolean", "description": "Schedule the Actor (daily or weekly) and each run returns only companies and announcements earlier runs with the same settings did not deliver.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional name for the “only new” history, so several monitors can run side by side." }, "tenantId": { "title": "Tenant ID", "type": "string", "description": "Optional label used to keep separate histories for different clients or teams." }, "debug": { "title": "Debug", "type": "boolean", "description": "Save extra diagnostics with the run (for support requests).", "default": false } } }, "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 } } } } } } } } } }