{
  "openapi": "3.0.1",
  "info": {
    "title": "EUIPO Trademark Search — By Name, Class & Status",
    "description": "Search EU trademarks via the official EUIPO API. Find registered, pending, or expired trademarks by name, Nice class, applicant, status, or date. Returns application details, owners, goods & services, and EUIPO links.",
    "version": "1.1",
    "x-build-id": "EUtehPfZX2Q2Wdxfu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ryanclinton~euipo-trademark-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ryanclinton-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/ryanclinton~euipo-trademark-search/runs": {
      "post": {
        "operationId": "runs-sync-ryanclinton-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/ryanclinton~euipo-trademark-search/run-sync": {
      "post": {
        "operationId": "run-sync-ryanclinton-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": [
          "query",
          "clientId",
          "clientSecret"
        ],
        "properties": {
          "query": {
            "title": "Trademark Name",
            "type": "string",
            "description": "Trademark name or verbal element to search for (supports wildcards with *). Use this for single searches.",
            "default": "Nike"
          },
          "queries": {
            "title": "Batch Queries",
            "maxItems": 50,
            "type": "array",
            "description": "Search multiple trademark names in one run (portfolio monitoring). Each query runs as a separate search. Overrides 'Trademark Name' if provided. Max 50 queries per run.",
            "items": {
              "type": "string"
            }
          },
          "yourMark": {
            "title": "Your Mark (for similarity scoring)",
            "type": "string",
            "description": "Enter your own trademark name to compute a similarity score (0-100) against each result. Results are sorted by similarity when set. Use this for clearance searches."
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "clearance",
              "monitoring",
              "competitor"
            ],
            "type": "string",
            "description": "Preset mode that optimizes filters and sorting. Clearance: filters active marks, sorts by risk. Monitoring: enables change detection. Competitor: focuses on recent filings (last 30 days)."
          },
          "niceClass": {
            "title": "Nice Classification",
            "type": "string",
            "description": "Nice Classification number (1-45) to filter by goods/services class. Comma-separated for multiple classes (e.g. '9,25,42')."
          },
          "status": {
            "title": "Trademark Status",
            "enum": [
              "REGISTERED",
              "RECEIVED",
              "UNDER_EXAMINATION",
              "APPLICATION_PUBLISHED",
              "REGISTRATION_PENDING",
              "WITHDRAWN",
              "REFUSED",
              "OPPOSITION_PENDING",
              "APPEALED",
              "CANCELLATION_PENDING",
              "CANCELLED",
              "SURRENDERED",
              "EXPIRED",
              "ACCEPTED"
            ],
            "type": "string",
            "description": "Filter by trademark status"
          },
          "applicantName": {
            "title": "Applicant / Owner Name",
            "type": "string",
            "description": "Filter by applicant or owner name (supports wildcards with *)"
          },
          "markFeature": {
            "title": "Mark Type",
            "enum": [
              "WORD",
              "FIGURATIVE",
              "SHAPE_3D",
              "COLOUR",
              "SOUND",
              "HOLOGRAM",
              "POSITION",
              "PATTERN",
              "MOTION",
              "MULTIMEDIA",
              "OTHER"
            ],
            "type": "string",
            "description": "Filter by mark type (word, figurative, etc.)"
          },
          "dateFrom": {
            "title": "Application Date From",
            "type": "string",
            "description": "Filter trademarks filed on or after this date (YYYY-MM-DD)"
          },
          "dateTo": {
            "title": "Application Date To",
            "type": "string",
            "description": "Filter trademarks filed on or before this date (YYYY-MM-DD)"
          },
          "clientId": {
            "title": "EUIPO Client ID",
            "type": "string",
            "description": "Your Client ID from the EUIPO Developer Portal. Register for FREE at https://dev.euipo.europa.eu — click 'Register', create an app, subscribe to 'Trademark Search' API, then copy your Client ID here."
          },
          "clientSecret": {
            "title": "EUIPO Client Secret",
            "type": "string",
            "description": "Your Client Secret from the EUIPO Developer Portal. Found in the same app you created at https://dev.euipo.europa.eu under your app's credentials section."
          },
          "useSandbox": {
            "title": "Use Sandbox Environment",
            "type": "boolean",
            "description": "Use the EUIPO sandbox environment for testing (uses test data, not production data)",
            "default": false
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum number of trademarks to return (max 500)",
            "default": 25
          },
          "outputProfile": {
            "title": "Output profile",
            "enum": [
              "minimal",
              "standard",
              "llm",
              "full"
            ],
            "type": "string",
            "description": "Controls how much data each result record contains. 'minimal' = decision-only (mark/applicant/status/lifecycle/similarity/clearanceRisk/nextActionTag/summary). 'standard' = decision + filing/registration/expiry/days + similarity components. 'llm' = LLM-friendly subset with confidence + agentContract for AI consumers. 'full' = every field (default).",
            "default": "full"
          },
          "watchlistName": {
            "title": "Watchlist name (optional)",
            "type": "string",
            "description": "Name this run as a separate watchlist. Cross-run state (PREVIOUS_RESULTS map of applicationNumber → status/highestSim) is namespaced per-watchlist, so the same actor runs as N independent monitors (e.g. 'eu-trademark-watch-fashion' vs 'eu-trademark-watch-tech'). Leave blank to share the default state.",
            "default": ""
          },
          "webhookUrl": {
            "title": "Webhook URL (Slack or Discord)",
            "type": "string",
            "description": "Optional. Slack or Discord incoming webhook URL. On run completion, posts a rich embed with portfolio totals + alerts + top blocking matches + a link to the run. Auto-detects vendor by URL.",
            "default": ""
          },
          "circuitBreakerThreshold": {
            "title": "Circuit breaker threshold",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Reserved for future EUIPO 5xx failure-streak abort. Currently a placeholder; the per-page retry-with-backoff loop already retries up to 3 times per request before bailing out.",
            "default": 0
          },
          "includeAgentContract": {
            "title": "Include agentContract",
            "type": "boolean",
            "description": "Add a top-level agentContract { decision, confidence, nextAction, costToAct } to every trademark record (and run-level on the SUMMARY) for MCP and AI-agent consumers.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}