{
"openapi": "3.0.1",
"info": {
"title": "Germany LUCID Packaging Register Check (EPR)",
"version": "0.1",
"x-build-id": "yflrkrROfOsblnoK9"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/rastriq~germany-lucid-register-check/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-rastriq-germany-lucid-register-check",
"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/rastriq~germany-lucid-register-check/runs": {
"post": {
"operationId": "runs-sync-rastriq-germany-lucid-register-check",
"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/rastriq~germany-lucid-register-check/run-sync": {
"post": {
"operationId": "run-sync-rastriq-germany-lucid-register-check",
"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": {
"mode": {
"title": "Mode",
"enum": [
"check",
"monitor",
"discover"
],
"type": "string",
"description": "Check (default when empty): look up the items of your list and return the matching registrations; items with no match return a not_found row (VAT IDs and names that include a legal form).
Monitor: same lookup on a saved list, but returns only changes since your last run (the first run returns everything as baseline). Schedule it weekly.
Discover: search by one term (brand or company name) with a low result limit.",
"default": "check"
},
"vatIds": {
"title": "VAT IDs",
"type": "array",
"description": "EU VAT numbers, e.g. DE815499929. Spaces and dots are ignored. Check / monitor modes.",
"items": {
"type": "string"
}
},
"companyNames": {
"title": "Company names",
"type": "array",
"description": "Company names, e.g. HARIBO GmbH & Co. KG. Partial names also match (flagged partial_match). Including the legal form (GmbH, AG, Ltd…) makes a not_found row possible when nothing matches. Check / monitor modes.",
"items": {
"type": "string"
}
},
"brands": {
"title": "Brands",
"type": "array",
"description": "Brand names registered by producers in LUCID, e.g. MAOAM. Check / monitor modes.",
"items": {
"type": "string"
}
},
"searchTerm": {
"title": "Search term (discover mode)",
"minLength": 0,
"maxLength": 100,
"type": "string",
"description": "One brand or company-name term, at least 3 characters, no wildcards. Returns up to Max results legal entities (hard limit 1,000). Discover mode only."
},
"includeDetails": {
"title": "Include brands and packaging types",
"type": "boolean",
"description": "Fetches each match's brands and declared packaging types (two extra requests per match, so the run is slower). The price per row is the same either way. Turn off for the fastest yes/no check.",
"default": true
},
"maxMatchesPerQuery": {
"title": "Max matches per list item",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "A generic name can match many registrations. Keep the best N per item (exact matches first). Default 10, maximum 50.",
"default": 10
},
"maxItems": {
"title": "Max results",
"minimum": 0,
"maximum": 10000,
"type": "integer",
"description": "Stop after this many rows (0 = no limit; in discover mode 0 means 100, and the maximum is 1,000). Each row is billed, so this is also your spending cap. Pre-filled with 5 so a first test costs a few cents."
},
"stateKey": {
"title": "Monitor stream name",
"type": "string",
"description": "Optional. Monitor mode remembers each list under a name derived from the list itself, so editing the list starts a new stream. Set a name (e.g. supplier-watchlist) to keep one stream while you edit the list. Monitor mode only."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}