{ "openapi": "3.0.1", "info": { "title": "EUIPO Trademark Search", "description": "Search EU trademark filings via the official EUIPO API. Supports multi-word brand names, combined keyword searches in a single run, date range and Nice class filtering, and automatic token caching.", "version": "0.1", "x-build-id": "vKlPWe972jiUXVfVo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/doppelspotter~euipo-trademark-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-doppelspotter-euipo-trademark-search", "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/doppelspotter~euipo-trademark-search/runs": { "post": { "operationId": "runs-sync-doppelspotter-euipo-trademark-search", "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/doppelspotter~euipo-trademark-search/run-sync": { "post": { "operationId": "run-sync-doppelspotter-euipo-trademark-search", "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", "required": [ "clientId", "clientSecret", "keywords" ], "properties": { "clientId": { "title": "EUIPO Client ID", "type": "string", "description": "Your EUIPO developer portal Client ID. Register for free at https://dev.euipo.europa.eu/ — used only to obtain an OAuth2 access token." }, "clientSecret": { "title": "EUIPO Client Secret", "type": "string", "description": "Your EUIPO developer portal Client Secret. Register for free at https://dev.euipo.europa.eu/ — used only to obtain an OAuth2 access token." }, "keywords": { "title": "Keywords", "minItems": 1, "type": "array", "description": "Brand keywords to search for. All keywords are combined into a single RSQL OR query so multi-word terms with spaces are supported. Each value is automatically wrapped as *keyword* if no * is present.", "items": { "type": "string" } }, "dateFrom": { "title": "Filing date from", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Optional lower bound for the trademark application date (YYYY-MM-DD). Results include trademarks filed on or after this date." }, "dateTo": { "title": "Filing date to", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Optional upper bound for the trademark application date (YYYY-MM-DD). Results include trademarks filed on or before this date." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of trademark records to emit. The EUIPO API returns pages of 100; the actor paginates until this limit is reached.", "default": 50 }, "niceClass": { "title": "Nice class filter", "type": "string", "description": "Optional Nice Classification filter. Use a single class number (e.g. 9) or comma-separated values for multiple classes (e.g. 9,42). Leave empty to return all classes." }, "status": { "title": "Trademark status filter", "enum": [ "", "REGISTERED", "RECEIVED", "UNDER_EXAMINATION", "APPLICATION_PUBLISHED", "REGISTRATION_PENDING", "WITHDRAWN", "REFUSED", "OPPOSITION_PENDING", "APPEALED", "CANCELLATION_PENDING", "CANCELLED", "SURRENDERED", "EXPIRED", "ACCEPTED" ], "type": "string", "description": "Optional trademark status filter. Leave empty to return all statuses.", "default": "" }, "markFeature": { "title": "Mark type filter", "enum": [ "", "WORD", "FIGURATIVE", "SHAPE_3D", "COLOUR", "SOUND", "HOLOGRAM", "POSITION", "PATTERN", "MOTION", "MULTIMEDIA", "OTHER" ], "type": "string", "description": "Optional mark type filter. Leave empty to return all mark types.", "default": "" }, "useSandbox": { "title": "Use sandbox environment", "type": "boolean", "description": "When enabled, all requests go to the EUIPO sandbox environment, which uses test data rather than live production records. Useful while waiting for production API approval.", "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 } } }, "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 } } } } } } } } } }