{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House Enricher",
    "description": "Enrich any UK company with profile, directors, shareholders, and financial data (cash, net worth, assets, liabilities). 5-year history included. Proxies included.",
    "version": "1.0",
    "x-build-id": "hvQ76jwSOc7tjZfU2"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~uk-companies-house-enricher/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-uk-companies-house-enricher",
        "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/silentflow~uk-companies-house-enricher/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-uk-companies-house-enricher",
        "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/silentflow~uk-companies-house-enricher/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-uk-companies-house-enricher",
        "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": {
          "query": {
            "title": "🏢 Company number or name",
            "type": "string",
            "description": "UK company number (8 characters, e.g. <code>00445790</code> or <code>SC045178</code>) or company name (e.g. <code>Tesco</code>). Leave it empty to only list companies from the register with the filters below."
          },
          "queries": {
            "title": "📋 More company numbers or names",
            "type": "array",
            "description": "A list of company numbers or names, all read in one run. Every company number of the list comes back, whatever the caps below.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "🔢 Max companies per name search",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many companies a name search returns (1 to 50). Company numbers are always read.",
            "default": 10
          },
          "sicCodes": {
            "title": "🏭 Industry (SIC code, prefix or keyword)",
            "type": "array",
            "description": "A SIC code (<code>62020</code>), a code prefix for a whole sector (<code>62</code> for every IT activity, <code>56</code> for restaurants and bars) or a word of the activity (<code>software</code>, <code>dental</code>). Each company comes with its SIC descriptions.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "📍 Location",
            "type": "array",
            "description": "Town, county, country or postcode of the registered office: <code>London</code>, <code>Greater Manchester</code>, <code>Scotland</code>, <code>EC1V</code>, <code>M</code> (every Manchester postcode), <code>SW1</code> (SW1A to SW1Y) or a full postcode.",
            "items": {
              "type": "string"
            }
          },
          "incorporatedFrom": {
            "title": "📅 Incorporated on or after",
            "type": "string",
            "description": "Only companies incorporated on or after this day: <code>2026-01-01</code>, or an age such as <code>7 days</code> or <code>1 month</code> for a scheduled run that lists the newly incorporated companies. Empty keeps every date."
          },
          "incorporatedTo": {
            "title": "📅 Incorporated on or before",
            "type": "string",
            "description": "Only companies incorporated on or before this day, e.g. <code>2015-12-31</code> for established companies. Empty means today."
          },
          "companyStatus": {
            "title": "🟢 Company status",
            "type": "array",
            "description": "Keep only these statuses, e.g. Active for prospect lists, Liquidation or Dissolved for due diligence. Empty keeps every status. On its own, a status lists the register only when no company number or name is given.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "administration",
                "receivership",
                "voluntary-arrangement",
                "insolvency-proceedings",
                "converted-closed",
                "open",
                "closed",
                "removed"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Liquidation",
                "Administration",
                "Receivership",
                "Voluntary arrangement",
                "Insolvency proceedings",
                "Converted or closed",
                "Open (overseas)",
                "Closed (overseas)",
                "Removed"
              ]
            }
          },
          "companyTypes": {
            "title": "🏛️ Company type",
            "type": "array",
            "description": "Keep only these legal forms, e.g. Public limited company or Limited liability partnership. Empty keeps every type.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "limited-partnership",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-limited-shares-section-30-exemption",
                "private-unlimited",
                "private-unlimited-nsc",
                "scottish-partnership",
                "charitable-incorporated-organisation",
                "scottish-charitable-incorporated-organisation",
                "registered-society-non-jurisdictional",
                "industrial-and-provident-society",
                "oversea-company",
                "uk-establishment",
                "registered-overseas-entity",
                "royal-charter",
                "european-public-limited-liability-company-se",
                "eeig",
                "icvc",
                "assurance-company",
                "protected-cell-company",
                "unregistered-company",
                "old-public-company",
                "further-education-or-sixth-form-college-corporation",
                "converted-or-closed"
              ],
              "enumTitles": [
                "Private limited company",
                "Public limited company",
                "Limited liability partnership",
                "Limited partnership",
                "Private limited by guarantee without share capital",
                "Private limited by guarantee, use of Limited exemption",
                "Private limited company, use of Limited exemption",
                "Private unlimited company",
                "Private unlimited company without share capital",
                "Scottish qualifying partnership",
                "Charitable incorporated organisation",
                "Scottish charitable incorporated organisation",
                "Registered society",
                "Industrial and provident society",
                "Overseas company",
                "UK establishment company",
                "Overseas entity",
                "Royal charter company",
                "European public limited liability company (SE)",
                "European Economic Interest Grouping (EEIG)",
                "Investment company with variable capital",
                "Assurance company",
                "Protected cell company",
                "Unregistered company",
                "Old public company",
                "Further education or sixth form college corporation",
                "Converted or closed"
              ]
            }
          },
          "maxItems": {
            "title": "🔢 Max companies from the register",
            "minimum": 1,
            "maximum": 10000000,
            "type": "integer",
            "description": "How many companies the register list returns at most, newest first. Raise it to 100000 or more to take a whole slice of the register.",
            "default": 1000
          },
          "includeDetails": {
            "title": "👥 Add directors, owners, charges and financials",
            "type": "boolean",
            "description": "Also read the directors, persons with significant control, charges, accounts category and financial figures of each company of the register list. Much slower: about 3 to 4 seconds per company, as for a company looked up by number, instead of thousands of companies a minute.",
            "default": false
          },
          "readScannedAccounts": {
            "title": "📑 Read scanned accounts (slower)",
            "type": "boolean",
            "description": "Also read the figures of companies whose accounts are filed as scanned paper documents, such as Revolut or Monzo. Figures are read from the filed accounts and kept only when the balance sheet and income statement add up. On by default; takes 1.5 to 7.5 minutes per such company (about 4 times faster with 1 GB of memory). Turn it off for faster runs.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}