{ "openapi": "3.0.1", "info": { "title": "OpenCorporates Scraper", "description": "Scrape OpenCorporates company records from 140+ jurisdictions by country or state code, or by company URL. Get status, type, address, industry codes, EIN/CIK, previous names, filings and officer counts. Add your own OpenCorporates login for directors, owners and incorporation dates.", "version": "0.0", "x-build-id": "Rx7orrKLvxgDMqCV7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~opencorporates-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-opencorporates-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/memo23~opencorporates-scraper/runs": { "post": { "operationId": "runs-sync-memo23-opencorporates-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/memo23~opencorporates-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-opencorporates-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": { "jurisdictions": { "title": "Jurisdictions", "type": "array", "description": "Jurisdiction codes: a two-letter country (gb, fr, nl, fi) or country_state (us_ca, us_ny, ca_on). A country code alone (us, ca) matches all of its states and provinces.", "items": { "type": "string" } }, "startUrls": { "title": "Company URLs", "type": "array", "description": "OpenCorporates company pages, e.g. https://opencorporates.com/companies/gb/05957738. Use this to look up specific companies. Can be combined with jurisdictions.", "items": { "type": "string" } }, "includeOfficers": { "title": "Include directors and officers", "type": "boolean", "description": "Add directors, officers, beneficial owners and incorporation dates to each company record. Charged additionally per enriched record, on top of the base company record. Rows that could not be enriched come with the public fields and no enrichment charge.", "default": false }, "maxItems": { "title": "Maximum companies", "minimum": 1, "type": "integer", "description": "Stop after this many company records. Each record is one billed result (plus the enrichment charge if officers are on).", "default": 1000 }, "startOffset": { "title": "Skip first companies", "minimum": 0, "type": "integer", "description": "Skip this many companies of the jurisdictions above, to continue where an earlier run stopped (e.g. 1000 after a run of 1000). Company URLs are never skipped. The order can change when OpenCorporates updates its listings, so a long-ago offset may repeat or miss some companies.", "default": 0 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many company pages to load in parallel.", "default": 15 }, "recordMaxAgeDays": { "title": "Reuse recent results (days)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Companies collected for any run in the last N days are returned at once instead of being loaded again; each row's scrapedAt shows when it was collected. Set 0 to always load fresh data.", "default": 30 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Leave empty to use the built-in residential proxy." } } }, "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 } } } } } } } } } }