{ "openapi": "3.0.1", "info": { "title": "North Data Scraper: German & European Companies", "description": "Look up companies on North Data by name, register number or URL: register ID, legal form, status, address, LEI, purpose, capital and published financials, one row per company. Company data only: officers are counted, never returned. Plain requests, no proxy. You pay only for companies found.", "version": "0.1", "x-build-id": "a788lgGdaBAxMstGw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/enisbodlli~northdata-company-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-enisbodlli-northdata-company-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/enisbodlli~northdata-company-scraper/runs": { "post": { "operationId": "runs-sync-enisbodlli-northdata-company-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/enisbodlli~northdata-company-scraper/run-sync": { "post": { "operationId": "run-sync-enisbodlli-northdata-company-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", "required": [ "queries" ], "properties": { "queries": { "title": "Companies to look up", "minItems": 1, "maxItems": 1000, "type": "array", "description": "One entry per line. Three kinds are understood: a company name, best with its town (\"Siemens AG München\"); a German register number with the town of its court (\"HRB 6684 München\"); or the URL of a company page on northdata.com. A company counts as found only when every word of the entry is in its name, its town or an earlier name, so a misspelt name gives \"not found\" instead of a wrong company. Up to 1,000 entries per run; repeated entries are looked up once.", "items": { "type": "string", "maxLength": 1000 } }, "maxResultsPerQuery": { "title": "Companies per entry", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many matching companies to return for one entry, best match first. 1 returns the best match only. A register number with its court and a URL always name one company. Each company returned is charged once.", "default": 1 }, "includeFinancials": { "title": "Include published financials", "type": "boolean", "description": "Return revenue, earnings and total assets per year, newest year first, where the public North Data page shows them. Employee numbers are a paid feature of the source and stay empty. When switched off, \"financials\" is an empty list. The price is the same either way.", "default": true }, "includeHistory": { "title": "Include register history", "type": "boolean", "description": "Return the dated events of the company's history, newest first, as a date and an event type (registration, name change, capital change, merger and so on). The source's text for an event is not returned, because it can name people. When switched off, \"history\" is an empty list.", "default": false }, "maxResults": { "title": "Maximum companies in the run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The run stops once this many companies have been returned, which also caps what the run can cost. Entries that were not reached are listed in the run summary.", "default": 1000 }, "requestDelaySeconds": { "title": "Pause between requests", "minimum": 1, "maximum": 30, "type": "number", "description": "Seconds to wait after each request to North Data. Requests are sent one at a time, never in parallel. The default of 1.5 gives about 12 to 25 companies a minute; a longer pause is slower and gentler on the source. It cannot be set under 1 second.", "default": 1.5 } } }, "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 } } } } } } } } } }