{ "openapi": "3.0.1", "info": { "title": "Company Financials and Ownership Data API - Global", "description": "Query a global company reference database by name, country, industry code, legal form, listing status, LEI, ISIN or entity ID. Returns firmographics, financial statements, shareholders, beneficial owners, ESG scores and sanctions flags as flat rows. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "JhJx8acJhGINVGDd6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~company-ownership-financials-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-ownership-financials-api", "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/nabeelbaghoor~company-ownership-financials-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-company-ownership-financials-api", "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/nabeelbaghoor~company-ownership-financials-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-company-ownership-financials-api", "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": { "companyName": { "title": "Company name", "type": "string", "description": "Company name to search for, for example Melexis N.V." }, "includeBranches": { "title": "Include branches", "type": "boolean", "description": "Also match branch entities of the named company, not only the registered head entity.", "default": false }, "includePreviousNames": { "title": "Match former and alternative names", "type": "boolean", "description": "Also match the company's previous names and its also-known-as names. Useful when your list predates a rebrand.", "default": false }, "bvdIds": { "title": "BvD ID numbers", "type": "array", "description": "Provider entity IDs to fetch directly, one per line, for example BE0435604729. This is the fastest and cheapest way to re-pull companies you already identified.", "items": { "type": "string" } }, "orbisIds": { "title": "Orbis IDs", "type": "array", "description": "Provider Orbis IDs, one per line.", "items": { "type": "string" } }, "recordIds": { "title": "Record IDs", "type": "array", "description": "Full record IDs including the account type suffix, one per line, for example NL34179503_C.", "items": { "type": "string" } }, "leis": { "title": "Legal Entity Identifiers", "type": "array", "description": "Twenty character LEI codes, one per line.", "items": { "type": "string" } }, "isins": { "title": "ISINs", "type": "array", "description": "International Securities Identification Numbers, one per line.", "items": { "type": "string" } }, "tickers": { "title": "Stock tickers", "type": "array", "description": "Listed ticker symbols, one per line.", "items": { "type": "string" } }, "countryRegions": { "title": "Countries or regions", "type": "array", "description": "Country, world region or country region names, one per line, for example Denmark or Brussels. The provider resolves the name against its own geography list.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names, one per line.", "items": { "type": "string" } }, "streetAddress": { "title": "Street address", "type": "string", "description": "A street address to match, for example AVENUE LOUISE 250." }, "nutsCodes": { "title": "NUTS regions", "type": "array", "description": "European statistical region codes or labels, one per line, for example BE310 - Nivelles.", "items": { "type": "string" } }, "status": { "title": "Company status", "enum": [ "Active", "Inactive", "Unknown" ], "type": "string", "description": "Restrict to companies with this status. Active is the usual choice for a prospecting or supplier list." }, "listingStatus": { "title": "Listing status", "enum": [ "Listed", "Delisted", "Unlisted" ], "type": "string", "description": "Restrict to publicly listed, delisted or unlisted companies." }, "standardisedLegalForms": { "title": "Standardised legal form codes", "type": "array", "description": "Standardised legal form codes, one per line, for example 050. Run once with Dump available fields to list the codes your subscription accepts.", "items": { "type": "string" } }, "entityTypeIds": { "title": "Entity type IDs", "type": "array", "description": "Entity type IDs, one per line, for example 040.", "items": { "type": "string" } }, "nace2": { "title": "NACE Rev. 2 codes or labels", "type": "array", "description": "European industry classification codes or their labels, one per line, for example 62.01 or Computer programming activities.", "items": { "type": "string" } }, "nace2CodeType": { "title": "NACE code scope", "enum": [ "All", "Core", "Primary", "Secondary" ], "type": "string", "description": "Which NACE assignment the filter should match: the core code only, the primary code, the secondary codes, or all of them.", "default": "All" }, "naics2017": { "title": "NAICS 2017 codes or labels", "type": "array", "description": "North American industry classification codes or labels, one per line.", "items": { "type": "string" } }, "usSic": { "title": "US SIC codes or labels", "type": "array", "description": "US SIC industry codes or labels, one per line.", "items": { "type": "string" } }, "websiteDomainEmail": { "title": "Websites, domains or emails", "type": "array", "description": "Values matched across the company's website, domain and email fields, one per line. This is how you resolve a domain list to registered entities.", "items": { "type": "string" } }, "phones": { "title": "Phone numbers", "type": "array", "description": "Phone numbers to match, one per line.", "items": { "type": "string" } }, "fieldPreset": { "title": "Field preset", "enum": [ "identity", "firmographics", "financials", "ownership", "risk", "esg" ], "type": "string", "description": "Which set of fields to request. Each preset is a field list drawn from the provider's own published examples. Add more with the extra fields box below.", "default": "firmographics" }, "extraFields": { "title": "Extra fields", "type": "array", "description": "Additional field names to add to the preset, one per line, for example GUO_NAME. Your subscription's own dictionary is the authority on which exist: turn on Dump available fields to list them.", "items": { "type": "string" } }, "preferences": { "title": "Global preferences", "type": "array", "description": "Values passed as GLOBALS.Preferences, one per line, for example AnnualReport or AllStatement. These control which accounting statements financial fields are read from.", "items": { "type": "string" } }, "advancedWhere": { "title": "Advanced WHERE", "type": "string", "description": "A raw WHERE document as JSON, for use when you need boolean trees, financial screens, update windows or a filter this form does not list. An array is appended to the criteria above; an object using AND, OR or NOT is combined with them. Example: {\"AND\":[{\"Status\":\"Active\"},{\"NOT\":[{\"CountryRegion\":{\"Text\":\"Russia\"}}]}]}" }, "advancedSelect": { "title": "Advanced SELECT", "type": "string", "description": "A raw SELECT list as a JSON array, which replaces the preset entirely. Use this for nested field objects such as year-indexed financials. Example: [\"NAME\",{\"OPRE\":{\"IndexOrYear\":\"2023\",\"Currency\":\"USD\"}}]" }, "entity": { "title": "Entity", "enum": [ "Companies", "Contacts", "News" ], "type": "string", "description": "Which entity endpoint to query. Companies is the default; the others need a subscription that includes them.", "default": "Companies" }, "dumpFields": { "title": "Dump available fields", "type": "boolean", "description": "Instead of collecting records, fetch the provider's own filter and field dictionaries for the selected entity and write them to the key-value store. Nothing is collected and nothing is charged. Run this once first if you are unsure which fields your subscription carries.", "default": false }, "useBearerToken": { "title": "Send credential as a bearer token", "type": "boolean", "description": "Send the credential as an Authorization bearer header instead of the ApiToken header. Turn this on if your account was set up with OAuth or JWT rather than a static API token.", "default": false }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Records per request. Large field lists make large responses, so lower this if requests time out.", "default": 50 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Stop after this many companies. This is the cap on both spend and run time.", "default": 100 }, "apiKey": { "title": "API token", "type": "string", "description": "Your own company reference data API token, sent in the ApiToken header. The actor never ships a token of its own: your subscription, entitlement and terms apply." } } }, "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 } } }, "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 } } } } } } } } } }