{
  "openapi": "3.0.1",
  "info": {
    "title": "New Company Registrations: UK Companies House, France & Norway",
    "description": "Daily feed of newly registered companies from official open registers: UK Companies House, France BODACC + SIRENE and Norway's Brønnøysund Register. Activity codes (SIC/NAF/NACE), legal form, address, capital; filters and only-new mode. Companies only, no personal data.",
    "version": "0.1",
    "x-build-id": "f3kFfQGi0vd4ckHly"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/latamdatatools~new-company-registrations/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-latamdatatools-new-company-registrations",
        "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/latamdatatools~new-company-registrations/runs": {
      "post": {
        "operationId": "runs-sync-latamdatatools-new-company-registrations",
        "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/latamdatatools~new-company-registrations/run-sync": {
      "post": {
        "operationId": "run-sync-latamdatatools-new-company-registrations",
        "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": {
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "GB = United Kingdom (Companies House, needs your free API key), FR = France (BODACC + SIRENE), NO = Norway (Brønnøysund Register Centre).",
            "items": {
              "type": "string",
              "enum": [
                "GB",
                "FR",
                "NO"
              ],
              "enumTitles": [
                "United Kingdom",
                "France",
                "Norway"
              ]
            },
            "default": [
              "NO"
            ]
          },
          "companiesHouseApiKey": {
            "title": "Companies House API key (UK)",
            "type": "string",
            "description": "Needed only for the UK. Free: create an account at developer.company-information.service.gov.uk, add an application and copy its REST API key. Stored encrypted by Apify and never logged."
          },
          "daysBack": {
            "title": "Registered in the last N days",
            "minimum": 1,
            "maximum": 31,
            "type": "integer",
            "description": "Used when no dates are given. Registers publish with a delay of 1-3 days (France: BODACC publication date).",
            "default": 3
          },
          "dateFrom": {
            "title": "From date",
            "type": "string",
            "description": "Optional, YYYY-MM-DD. Max 31 days per run."
          },
          "dateTo": {
            "title": "To date",
            "type": "string",
            "description": "Optional, YYYY-MM-DD. Default: today."
          },
          "activityCodes": {
            "title": "Activity codes (prefix)",
            "type": "array",
            "description": "Optional: SIC (UK), NAF (FR) or NACE (NO) code prefixes, with or without dots, e.g. 62 (IT), 4321 (electrical installation), 56 (restaurants). For France this uses SIRENE data.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keywords in name or activity",
            "type": "array",
            "description": "Optional: keep companies whose name or activity description contains one of these words (case and accents ignored), e.g. software, solar, restaurant.",
            "items": {
              "type": "string"
            }
          },
          "postalCodePrefixes": {
            "title": "Postal code prefixes",
            "type": "array",
            "description": "Optional: e.g. 75 (Paris), EC1 (London), 0 (Oslo area).",
            "items": {
              "type": "string"
            }
          },
          "legalForms": {
            "title": "Legal forms",
            "type": "array",
            "description": "Optional: e.g. ltd, AS, SAS, Société par actions simplifiée.",
            "items": {
              "type": "string"
            }
          },
          "enrichFrance": {
            "title": "France: add SIRENE data",
            "type": "boolean",
            "description": "Adds the NAF activity code, legal form code, workforce bracket and VAT number from the open SIRENE API (charged as an enriched company). Companies that opted out of publication are left out.",
            "default": true
          },
          "onlyNew": {
            "title": "Only companies not delivered before",
            "type": "boolean",
            "description": "Remember what was delivered (named key-value store \"company-registrations-state\", per feed name) and return only new companies. Schedule the Actor daily for a clean feed.",
            "default": true
          },
          "feedName": {
            "title": "Feed name",
            "type": "string",
            "description": "Separate memories for different feeds (e.g. one per country or filter).",
            "default": "default"
          },
          "maxResults": {
            "title": "Max companies per country per run",
            "minimum": 1,
            "maximum": 200000,
            "type": "integer",
            "description": "France has about 3,000 new companies per publication day, Norway 500-1,500 units, the UK about 2,500.",
            "default": 1000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}