{ "openapi": "3.0.1", "info": { "title": "Zefix Scraper: Swiss Company Register Search to Excel", "description": "Zefix scraper for the Swiss company register (Handelsregister): search by name, activity or canton, get UID, legal form and address as Excel.", "version": "0.1", "x-build-id": "916kkPjQ98fki2dyZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alpine-data~swiss-company-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alpine-data-swiss-company-register", "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/alpine-data~swiss-company-register/runs": { "post": { "operationId": "runs-sync-alpine-data-swiss-company-register", "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/alpine-data~swiss-company-register/run-sync": { "post": { "operationId": "run-sync-alpine-data-swiss-company-register", "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": { "nameContains": { "title": "Company name contains", "type": "array", "description": "Finds companies whose name contains ANY of these words (upper/lower case does not matter). Example: treuhand, immobilien. One word per line; commas also work. Tip: shorter words find more ('treuhand' also finds 'Treuhand AG').", "items": { "type": "string" } }, "purposeContains": { "title": "Business activity (purpose) contains", "type": "array", "description": "Searches the registered business purpose ('Zweck'). Great for target lists by industry. Example: software, Photovoltaik, blockchain. Searching in German, French or Italian finds the most companies.", "items": { "type": "string" } }, "cantons": { "title": "Canton", "type": "array", "description": "Pick one or more cantons. Example: Zug. Leave empty for all of Switzerland. You can also type names or codes such as Zürich, Genf or ZH.", "items": { "type": "string", "enumSuggestedValues": [ "AG", "AR", "AI", "BL", "BS", "BE", "FR", "GE", "GL", "GR", "JU", "LU", "NE", "NW", "OW", "SH", "SZ", "SO", "SG", "TG", "TI", "UR", "VS", "VD", "ZG", "ZH" ], "enumTitles": [ "Aargau (AG)", "Appenzell Ausserrhoden (AR)", "Appenzell Innerrhoden (AI)", "Basel-Landschaft (BL)", "Basel-Stadt (BS)", "Bern (BE)", "Fribourg (FR)", "Genève (GE)", "Glarus (GL)", "Graubünden (GR)", "Jura (JU)", "Luzern (LU)", "Neuchâtel (NE)", "Nidwalden (NW)", "Obwalden (OW)", "Schaffhausen (SH)", "Schwyz (SZ)", "Solothurn (SO)", "St. Gallen (SG)", "Thurgau (TG)", "Ticino (TI)", "Uri (UR)", "Valais (VS)", "Vaud (VD)", "Zug (ZG)", "Zürich (ZH)" ] } }, "maxResults": { "title": "Max companies (cost limit)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The run stops after this many companies, so you never pay more than you expect. Example: 100 companies cost at most $0.38 ($0.0038 each).", "default": 100 }, "uids": { "title": "Look up companies by UID", "type": "array", "description": "One UID per line (commas also work). All formats work: CHE-105.841.533, CHE105841533, 105841533 or 'CHE-105.841.533 MWST'. A UID with a typo (wrong check digit) is reported and not charged.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Swiss 4-digit postal codes of the registered address. Example: 8001, 6300. '8001 Zürich' or 'CH-8001' also work.", "items": { "type": "string" } }, "legalForms": { "title": "Legal form", "type": "array", "description": "Only companies with these legal forms. Example: AG and GmbH. Leave empty for all (sole proprietorships are excluded unless you switch them on below). You can also type AG, GmbH, Sàrl, Verein or the code 0106.", "items": { "type": "string", "enumSuggestedValues": [ "0106", "0107", "0108", "0109", "0110", "0103", "0104", "0105", "0101", "0151", "0111", "0117" ], "enumTitles": [ "AG – Aktiengesellschaft / SA (corporation)", "GmbH – Gesellschaft mit beschränkter Haftung / Sàrl (LLC)", "Genossenschaft / Coopérative (cooperative)", "Verein / Association", "Stiftung / Fondation (foundation)", "Kollektivgesellschaft / Société en nom collectif (general partnership)", "Kommanditgesellschaft / Société en commandite (limited partnership)", "Kommanditaktiengesellschaft (partnership limited by shares)", "Einzelunternehmen / Raison individuelle (sole proprietorship)", "Zweigniederlassung (Swiss branch)", "Ausländische Niederlassung (branch of a foreign company)", "Institut des öffentlichen Rechts (public-law institution)" ] } }, "includeSoleProprietorships": { "title": "Include sole proprietorships (Einzelunternehmen)", "type": "boolean", "description": "Names of sole proprietorships usually contain a private person's name, so they are excluded by default for data-protection reasons. Switch on only if you have a lawful reason. Example: off.", "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 } } } } } } } } } }