{ "openapi": "3.0.1", "info": { "title": "Insolvency & Bankruptcy Watch", "description": "Watch official insolvency publications for companies and sole traders in NL, the UK, France and the US, and return only new matches. Personal insolvencies are excluded.", "version": "0.1", "x-build-id": "OBIK35K7aViZuts11" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mikee368~insolvency-bankruptcy-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mikee368-insolvency-bankruptcy-watch", "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/mikee368~insolvency-bankruptcy-watch/runs": { "post": { "operationId": "runs-sync-mikee368-insolvency-bankruptcy-watch", "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/mikee368~insolvency-bankruptcy-watch/run-sync": { "post": { "operationId": "run-sync-mikee368-insolvency-bankruptcy-watch", "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": { "entities": { "title": "Companies and sole traders to watch", "type": "array", "description": "Objects with name, number (company number, SIREN, KvK or CIK) and country (NL, GB, FR, US, DE, NO). DE and NO are reported as unsupported and are not fetched. UK is accepted as GB." }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional words that mark a publication as a possible match when no register number or exact name hits. Keywords shorter than 4 characters are ignored. A keyword match is flagged possible match, verify.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Adapters to run: NL, GB, FR, US, plus DE and NO (unsupported, with the reason). Leave empty to use each company's country. Keywords without companies search the supported countries.", "items": { "type": "string" } }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Separate named-store state (seen- and meta-) when one Actor has two schedules.", "default": "default" }, "lookbackDays": { "title": "Lookback (days)", "minimum": 1, "maximum": 31, "type": "integer", "description": "How far back the first run, or a run with no saved watermark, asks each source. Later runs start at the previous run's date. State still drops ids already seen.", "default": 7 }, "includeBaseline": { "title": "Include baseline rows", "type": "boolean", "description": "Off by default. The first run only stores publication ids. Turn this on to also write that first window as uncharged baseline rows.", "default": false }, "includePersonalNames": { "title": "Include personal names", "type": "boolean", "description": "Off by default. A BODACC natural person (no company form such as SAS or SARL) is returned with the SIREN only. Turn this on to copy that person's name into the row. You are the controller for that name.", "default": false }, "maxEntities": { "title": "Max companies per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Per-run cap. Extra companies are left for a later run and counted in the status message.", "default": 25 }, "maxMatches": { "title": "Max matches per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Cap on matched rows. Unmatched publications are still remembered. Matches over the cap are left for the next run.", "default": 25 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional https URL on port 443. The host is resolved once and the connection uses that address. Private, loopback, link-local and metadata addresses are rejected, including on a redirect. When the run has at least one charged new match, one JSON digest is posted. Baseline runs and empty runs do not call it." }, "resetState": { "title": "Reset monitor state", "type": "boolean", "description": "Drop seen publication ids and the watermark for this monitorId. The next result is a new baseline.", "default": false }, "cirUsername": { "title": "CIR webservice username", "type": "string", "description": "Username from the CIR abonnementenportaal. Not logged." }, "cirApiSecret": { "title": "CIR webservice password", "type": "string", "description": "Password for the CIR webservice. Sent as a WS-Security username token. Not logged and not written to the dataset or the run summary." } } }, "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 } } } } } } } } } }