{
  "openapi": "3.0.1",
  "info": {
    "title": "Trademark Watch: USPTO New Filings & Similar Mark Alerts",
    "description": "Get alerted when someone files or publishes a US trademark that looks or sounds like yours. Fuzzy + phonetic similarity, Nice classes, opposition deadlines, since-last-run, webhook alerts. Official USPTO data, no key. Misses are free.",
    "version": "0.1",
    "x-build-id": "TecbgnBHB9JGokP6o"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/chaptersoft~trademark-watch/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-chaptersoft-trademark-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/chaptersoft~trademark-watch/runs": {
      "post": {
        "operationId": "runs-sync-chaptersoft-trademark-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/chaptersoft~trademark-watch/run-sync": {
      "post": {
        "operationId": "run-sync-chaptersoft-trademark-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": {
          "marks": {
            "title": "Marks to watch",
            "type": "array",
            "description": "Your brand names / word marks. We find new USPTO filings that look alike, sound alike, contain your mark or share its dominant word. Optional per-mark Nice classes after a bar: \"Starbucks | 30, 43\".",
            "items": {
              "type": "string"
            }
          },
          "watchFor": {
            "title": "Watch for",
            "enum": [
              "new-filings",
              "published-for-opposition",
              "new-filings-and-publications",
              "all-dates"
            ],
            "type": "string",
            "description": "New filings = applications filed in the date window (alerts arrive the day after filing). Published for opposition = marks published (or scheduled to publish) in the Official Gazette, with your 30-day opposition deadline. All dates = one-off knockout / clearance search across the whole register.",
            "default": "new-filings"
          },
          "niceClasses": {
            "title": "Nice classes (optional)",
            "type": "array",
            "description": "Only report filings in these international (Nice) classes, e.g. [\"25\", \"35\"]. Empty = all 45 classes. Per-mark classes in \"Marks to watch\" override this.",
            "items": {
              "type": "string"
            }
          },
          "lookbackDays": {
            "title": "Look back (days)",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Date window when no explicit dates are given: filings from the last N days (publications: from N days ago up to “Look ahead” days ahead). Use 1–7 for a daily/weekly schedule.",
            "default": 7
          },
          "lookaheadDays": {
            "title": "Look ahead (days, publications only)",
            "minimum": 0,
            "maximum": 365,
            "type": "integer",
            "description": "Publications are scheduled in the Official Gazette weeks in advance. Include publications up to this many days in the future so you see them before the 30-day opposition window opens.",
            "default": 60
          },
          "sinceLastRun": {
            "title": "Only new since last run (for schedules)",
            "type": "boolean",
            "description": "Remembers what was already delivered (in a named key-value store in your account, \"trademark-watch-state\") and only returns — and charges for — filings you have not seen yet. Ideal for a daily or weekly schedule.",
            "default": false
          },
          "minSimilarity": {
            "title": "Minimum similarity (50–100)",
            "minimum": 50,
            "maximum": 100,
            "type": "integer",
            "description": "Report filings scoring at least this much against a watched mark. 90+ = near-identical or sound-alike, 80 = one-letter changes / shared dominant word (recommended), 70 = broad net.",
            "default": 80
          },
          "owners": {
            "title": "Competitor owners to watch (optional)",
            "type": "array",
            "description": "Also report every new filing by these applicants (e.g. a competitor's legal name). Charged like a match.",
            "items": {
              "type": "string"
            }
          },
          "excludeOwners": {
            "title": "Exclude owners (your own company)",
            "type": "array",
            "description": "Skip filings by these owners so your own applications never show up (and are never charged).",
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "From date (optional)",
            "type": "string",
            "description": "YYYY-MM-DD. Overrides \"Look back\"."
          },
          "dateTo": {
            "title": "To date (optional)",
            "type": "string",
            "description": "YYYY-MM-DD. Default: today (publications: today + 60 days)."
          },
          "liveOnly": {
            "title": "Live marks only",
            "type": "boolean",
            "description": "Skip abandoned, cancelled and expired records.",
            "default": true
          },
          "maxResults": {
            "title": "Max matches per run",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Hard cap on saved (charged) matches, highest risk first. Your \"Maximum cost per run\" is always respected too.",
            "default": 1000
          },
          "maxResultsPerTerm": {
            "title": "Max matches per watched term",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Keep at most this many (best-ranked) matches per watched mark, so one generic word can't use up the run. 0 = no per-term limit.",
            "default": 0
          },
          "maxCandidatesPerTerm": {
            "title": "Candidates scored per term",
            "minimum": 20,
            "maximum": 2000,
            "type": "integer",
            "description": "How many USPTO search hits are fetched and scored per watched term (best first). Raise for very common words or long windows. Candidates that do not match are free.",
            "default": 300
          },
          "includeNoMatchRows": {
            "title": "Add a free row for terms with no matches",
            "type": "boolean",
            "description": "One free \"no-match\" row per watched term with nothing new, so every term is accounted for.",
            "default": true
          },
          "stateKey": {
            "title": "State key (optional)",
            "type": "string",
            "description": "Name for the since-last-run memory. Default: derived from your marks/owners/classes, so changing the watch list starts fresh."
          },
          "jurisdictions": {
            "title": "Jurisdictions",
            "type": "array",
            "description": "Register(s) to watch. Today: US (USPTO). EUIPO, UK IPO, Canada and WIPO Madrid are on the roadmap.",
            "items": {
              "type": "string",
              "enum": [
                "US"
              ],
              "enumTitles": [
                "United States (USPTO)"
              ]
            },
            "default": [
              "US"
            ]
          },
          "notifyWebhookUrl": {
            "title": "Alert webhook URL (optional)",
            "type": "string",
            "description": "Send a short alert (top 10 matches with links and opposition deadlines) to this https:// webhook when the run finds new matches. Works with Slack and Discord incoming webhooks, Microsoft Teams/Zapier/Make, or your own endpoint (JSON body: text, content, summary). Nothing is sent when there are no matches. You can also use Apify integrations (email, Slack, Google Sheets) on the run."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}