{ "openapi": "3.0.1", "info": { "title": "Company Check API: identity, financials & SEC filings in 1 call", "description": "One company report per call: legal name, LEI, registration number, status, address and industry, plus years of revenue, profit, equity, assets and cash, and SEC filings for US issuers. Look up by name, LEI, UK, Danish, Norwegian, French or Finnish number, ticker or CIK. Sourced values.", "version": "0.1", "x-build-id": "t5OcbabECWxF0cDUW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bosco_labs~company-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bosco_labs-company-check", "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/bosco_labs~company-check/runs": { "post": { "operationId": "runs-sync-bosco_labs-company-check", "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/bosco_labs~company-check/run-sync": { "post": { "operationId": "run-sync-bosco_labs-company-check", "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": [ "query" ], "properties": { "query": { "title": "Company (name or identifier)", "pattern": "^[^\\[\\]{}<>\\r\\n]*$", "type": "string", "description": "The company to check: a name (e.g. \"Novo Nordisk\") or an identifier: LEI (20 characters, e.g. \"724500Y6DUVHQD6OXN27\"), UK company number (\"00445790\", \"SC123456\"), Danish CVR (\"24256790\"), Norwegian org number (\"923609016\"), French SIREN (9 digits, \"552032534\") or SIRET (14 digits, \"55203253400703\"), Finnish Business ID with its dash (\"0112038-9\"), Estonian registry code (8 digits, \"12417834\"), US ticker in capitals or with $ (\"AAPL\", \"$brk.b\"; foreign companies listed in the US resolve to their home country), SEC CIK (\"320193\") or FDIC certificate of a US bank (\"FDIC:628\"). The type is detected from format and check digits; an 8-digit number valid in several registers (UK, Danish CVR, Estonian) is settled by asking them, and `country` decides when given. Required." }, "country": { "title": "Country (optional)", "pattern": "^\\s*([A-Za-z]{2})?\\s*$", "type": "string", "description": "ISO 3166 alpha-2 country code to disambiguate, e.g. \"DK\", \"GB\", \"NO\", \"FR\", \"FI\", \"EE\", \"NL\", \"US\". With a name it limits the search to that country and, for NO, FR, FI and EE, also searches the national register (most companies there have no LEI); with a number it says which register the number belongs to (e.g. \"GB\" for a UK number without a leading zero, \"EE\" for an Estonian registry code, \"FI\" for a Business ID typed without its dash). Empty = detect from the query." }, "maxYears": { "title": "Financial years", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many fiscal years of key figures to return, newest first, e.g. 3. Default 3, maximum 10. Norway's open register holds the last 3 years only. The price is the same for any number of years.", "default": 3 }, "include": { "title": "Sections", "type": "array", "description": "Which sections to fill: any of \"identity\", \"financials\", \"us\" (SEC filings of US issuers), \"people\" (UK officers and owners from Companies House), e.g. [\"identity\", \"people\"]. Default (or empty) = all four. Fewer sections = fewer sources called, slightly faster; the price is the same.", "items": { "type": "string", "enumSuggestedValues": [ "identity", "financials", "us", "people" ], "enumTitles": [ "Identity (register, LEI, addresses)", "Financials (filed accounts)", "US (SEC filings of US issuers)", "People (UK officers and persons with significant control)" ] }, "default": [ "identity", "financials", "us", "people" ] } } }, "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 } } } } } } } } } }