{
  "openapi": "3.0.1",
  "info": {
    "title": "Finnish Company Events Feed (PRH open data) - company-level",
    "description": "Daily feed of Finnish Trade Register company events (PRH open data): new companies, name changes, liquidations, bankruptcies, restructurings, dissolutions, industry changes, watchlist diffs. New: Norway mode (Brreg, NLOD). Company-level only, attribution included. Not affiliated with PRH/Brreg.",
    "version": "0.2",
    "x-build-id": "usoROtb5vSbETqASL"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/itulo~prh-company-events/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-itulo-prh-company-events",
        "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/itulo~prh-company-events/runs": {
      "post": {
        "operationId": "runs-sync-itulo-prh-company-events",
        "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/itulo~prh-company-events/run-sync": {
      "post": {
        "operationId": "run-sync-itulo-prh-company-events",
        "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": {
          "registry": {
            "title": "Registry (country)",
            "enum": [
              "fi_prh",
              "no_brreg"
            ],
            "type": "string",
            "description": "Which national business register to read. Default fi_prh (Finland). no_brreg reads Norway's Enhetsregisteret (data.brreg.no): supported events new_company, name_change, liquidation, bankruptcy, dissolution, removal, registered_office_change, industry_change; other types are reported as unsupported in OUTPUT_SUMMARY. Sole proprietorships (ENK) are always excluded.",
            "default": "fi_prh"
          },
          "eventTypes": {
            "title": "Event types",
            "type": "array",
            "description": "new_company, name_change, liquidation, liquidation_ended, bankruptcy, bankruptcy_ended, restructuring, dissolution, removal, merger, demerger, registered_office_change, articles_amended, industry_change",
            "default": [
              "new_company",
              "name_change",
              "liquidation",
              "bankruptcy",
              "restructuring",
              "dissolution",
              "industry_change"
            ],
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "From (YYYY-MM-DD)",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Registration date window start (YYYY-MM-DD). Default: yesterday (back to the previous Friday when yesterday was a weekend), or since last run in alert mode."
          },
          "dateTo": {
            "title": "To (YYYY-MM-DD)",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Registration date window end (YYYY-MM-DD). Default: yesterday. Set both dates to use a custom window."
          },
          "location": {
            "title": "Town / city",
            "type": "string",
            "description": "Optional registered-office town filter, e.g. Helsinki. In Norway mode: town (poststed, e.g. OSLO) or 4-digit municipality number (kommunenummer)."
          },
          "companyForm": {
            "title": "Company form",
            "type": "string",
            "description": "Optional PRH company form code: OY, OYJ, OK, KY, AY, SÄÄ, ... In Norway mode: Brreg organisasjonsform code (AS, ASA, NUF, SA, ANS, DA, ...)."
          },
          "maxPerEvent": {
            "title": "Max records per event type",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum number of company events to fetch per requested event type. Example input uses 20; default 500.",
            "default": 500
          },
          "watchBusinessIds": {
            "title": "Watchlist Business IDs",
            "type": "array",
            "description": "Optional list of Y-tunnus (1234567-8). Each run compares with the previous snapshot and emits change events. In Norway mode: 9-digit organisasjonsnummer.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "alertMode": {
            "title": "Alert mode (only new events)",
            "type": "boolean",
            "description": "Return only events not seen in previous runs with the same alert key.",
            "default": false
          },
          "alertStateKey": {
            "title": "Alert / watchlist key",
            "type": "string",
            "description": "State key used to isolate alert and watchlist state across saved schedules.",
            "default": "default"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}