{ "openapi": "3.0.1", "info": { "title": "Zefix.ch Scraper - Swiss Commercial Register", "description": "Search the Swiss Central Business Names Index (Zefix) by company name, canton, or legal form. Get UID, legal form, registered seat, address, purpose, and SOGC publication date. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "dun6yyvTNYN7ocFJ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~zefix-ch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-zefix-ch-scraper", "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/parsebird~zefix-ch-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-zefix-ch-scraper", "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/parsebird~zefix-ch-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-zefix-ch-scraper", "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": { "searchQuery": { "title": "Search query", "type": "string", "description": "Company name or keyword to search (minimum 2 characters). Also accepts a UID, e.g. \"CHE-111.730.652\". Matches anywhere in the company name." }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Zefix search URLs with parameters, e.g. https://www.zefix.ch/en/search/entity/list?name=consulting&canton=BE. The name, canton and legalForm query parameters are read from each URL. Combined with Search query if both are set.", "default": [], "items": { "type": "string" } }, "canton": { "title": "Canton", "type": "string", "description": "Filter by canton. Accepts the 2-letter code (ZH, BE, GE, ...) or the full name in German, French or English. Comma-separate multiple cantons. See the README for the full 26-canton table.", "default": "" }, "legalForm": { "title": "Legal form", "type": "string", "description": "Filter by legal form: AG, GmbH, Einzelunternehmen, Kollektivgesellschaft, Kommanditgesellschaft, Genossenschaft, Verein, Stiftung, Zweigniederlassung (or the French/Italian/English equivalent, e.g. SA, Sàrl, Ltd, LLC). Comma-separate multiple forms.", "default": "" }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Only include active companies (EXISTIEREND / in liquidation). Turn off to also include deleted (GELOESCHT) companies.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of companies to return, combined across Search query and Search URLs.", "default": 100 }, "includeDetails": { "title": "Include full registry details", "type": "boolean", "description": "Fetch each company's registry entry for its purpose, full street address, postal code and city. Off = search-level fields only (UID, name, legal form, canton, status, SOGC date). Detail records are billed at a higher rate — see Pricing.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Zefix.ch has no anti-bot protection and works fine without a proxy, but Apify proxy is used by default for IP hygiene on sustained runs.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }