{
  "openapi": "3.0.1",
  "info": {
    "title": "Company Registry Lookup",
    "description": "Legal-person companies from official registers: UK Companies House (your own API key) and Norway Brønnøysund (open data). Number, name, legal form, status, address, industry codes. No officers or people data. Price: $0.002/company record + $0.005 start fee per run.",
    "version": "0.1",
    "x-build-id": "zwFbidadxCeIEHH95"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/luxe_tasks~company-registry-lookup/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-luxe_tasks-company-registry-lookup",
        "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/luxe_tasks~company-registry-lookup/runs": {
      "post": {
        "operationId": "runs-sync-luxe_tasks-company-registry-lookup",
        "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/luxe_tasks~company-registry-lookup/run-sync": {
      "post": {
        "operationId": "run-sync-luxe_tasks-company-registry-lookup",
        "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": [
          "sources"
        ],
        "properties": {
          "sources": {
            "title": "Registers",
            "type": "array",
            "description": "Which official registers to read, one per line: no-brreg (Norway, Brønnøysundregistrene, open data, no key) and/or uk-companies-house (UK Companies House, needs your own Companies House API key). France (Sirene) is planned for a later version.",
            "items": {
              "type": "string"
            }
          },
          "companyName": {
            "title": "Company name contains (optional)",
            "type": "string",
            "description": "Companies whose name contains this text (Companies House company_name_includes; Brreg navn).",
            "default": ""
          },
          "companyNumbers": {
            "title": "Company numbers (optional)",
            "type": "array",
            "description": "Look up these companies directly instead of searching (at most 100). UK: 8-character Companies House numbers such as 01234567 or SC123456. Norway: 9-digit organisasjonsnummer. The other filters are not applied to a direct lookup, except the legal-form rule.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "activeOnly": {
            "title": "Active companies only",
            "type": "boolean",
            "description": "UK: company_status active. Norway: not bankrupt, not in liquidation or compulsory dissolution.",
            "default": true
          },
          "incorporatedFrom": {
            "title": "Incorporated from (YYYY-MM-DD, optional)",
            "type": "string",
            "description": "UK: date of creation; Norway: stiftelsesdato.",
            "default": ""
          },
          "incorporatedTo": {
            "title": "Incorporated to (YYYY-MM-DD, optional)",
            "type": "string",
            "description": "UK: date of creation; Norway: stiftelsesdato.",
            "default": ""
          },
          "ukSicCodes": {
            "title": "UK SIC codes (optional)",
            "type": "array",
            "description": "Companies House SIC 2007 codes, e.g. 62020.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "ukLocation": {
            "title": "UK registered office location (optional)",
            "type": "string",
            "description": "Companies House location filter, e.g. a town or postcode.",
            "default": ""
          },
          "ukCompanyTypes": {
            "title": "UK company types (optional)",
            "type": "array",
            "description": "Companies House company_type values to include. Empty = all supported incorporated types: ltd, plc, llp, private-unlimited, private-unlimited-nsc, private-limited-guarant-nsc, private-limited-guarant-nsc-limited-exemption, private-limited-shares-section-30-exemption, old-public-company, european-public-limited-liability-company-se, charitable-incorporated-organisation, scottish-charitable-incorporated-organisation, industrial-and-provident-society, registered-society-non-jurisdictional, royal-charter, assurance-company, protected-cell-company, investment-company-with-variable-capital, icvc-securities, icvc-warrant, icvc-umbrella, further-education-or-sixth-form-college-corporation. Partnerships, overseas entities and other types are never included.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "noIndustryCodes": {
            "title": "Norway industry codes (optional)",
            "type": "array",
            "description": "NACE codes as Brreg uses them, e.g. 62.010 or 62.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "noMunicipalityNumbers": {
            "title": "Norway municipality numbers (optional)",
            "type": "array",
            "description": "4-digit kommunenummer of the business address, e.g. 0301 (Oslo).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "noOrganisationForms": {
            "title": "Norway organisation forms (optional)",
            "type": "array",
            "description": "Brreg organisasjonsform codes to include. Empty = all supported legal-person forms: AS, ASA, SA, SE, SPA, GFS, BA, BBL, BRL, STI, FLI, IKS, SF, KF, FKF, PK, ANNA, SÆR. Sole proprietorships (ENK) and other natural-person forms are never included.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "ukIncludeProfile": {
            "title": "UK: read each company profile",
            "type": "boolean",
            "description": "One extra Companies House request per company (previous names, status detail, last accounts date), at most 1,000 per run. Slower: about 1 second per company.",
            "default": false
          },
          "companiesHouseApiKey": {
            "title": "Your Companies House API key (needed for uk-companies-house)",
            "type": "string",
            "description": "The REST API key of your own Companies House developer application. It is sent only to api.company-information.service.gov.uk. Encrypted by Apify (secret input); never logged, stored or returned by this Actor."
          },
          "ukMaxRequestsPerFiveMinutes": {
            "title": "UK: max requests per 5 minutes",
            "minimum": 20,
            "maximum": 600,
            "type": "integer",
            "description": "Companies House allows up to 600 requests per 5 minutes per key. Set lower if you use the same key elsewhere.",
            "default": 600
          },
          "maxResults": {
            "title": "Max results per register",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "At most this many companies are saved per register (at most 10,000 per run). Each saved company is charged as one company record, plus the $0.005 start fee per run.",
            "default": 100
          },
          "timeoutSecs": {
            "title": "Request timeout (seconds)",
            "minimum": 5,
            "maximum": 120,
            "type": "integer",
            "description": "How long to wait for one API answer.",
            "default": 60
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 1,
            "type": "integer",
            "description": "Items processed in parallel (each site still gets at most 1 request per second).",
            "default": 1
          },
          "credentialOwnershipAttestation": {
            "title": "I own or am authorized to use these credentials",
            "type": "boolean",
            "description": "Required with a secret: you may supply only credentials for accounts you own or are authorized to use, for APIs whose terms permit access through automation tools.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}