{ "openapi": "3.0.1", "info": { "title": "USPTO Trademark Watch & Opposition Monitor", "description": "Watch the USPTO Trademark Official Gazette for marks that match your brand terms, competitor names or Nice classes. Get the 30-day opposition deadline, goods and services and owner type. Similar-mark matching, monitor mode for alerts and batch serial or registration number checks. No API key.", "version": "0.1", "x-build-id": "qqXDevA5qhbTaXXPT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maliksaid~uspto-trademark-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maliksaid-uspto-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/maliksaid~uspto-trademark-watch/runs": { "post": { "operationId": "runs-sync-maliksaid-uspto-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/maliksaid~uspto-trademark-watch/run-sync": { "post": { "operationId": "run-sync-maliksaid-uspto-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": { "mode": { "title": "Mode", "enum": [ "watch", "lookup" ], "type": "string", "description": "Choose Watch to find gazette entries that match your brand terms, owners or classes. Choose Number check to look up serial or registration numbers.", "default": "watch" }, "brandTerms": { "title": "Brand terms", "type": "array", "description": "Enter the words to watch, one per line, for example your brand names. Leave empty to list every entry that passes the other filters.", "default": [], "items": { "type": "string" } }, "matching": { "title": "Matching", "enum": [ "search", "similar" ], "type": "string", "description": "Pick how terms match marks. USPTO search finds marks that contain the term as a word, plus word forms. Similar marks reads every entry in the newest 4 issues at most. It adds marks that contain the term inside a word or are spelled one or two letters differently. Each issue read this way has a small fee.", "default": "search" }, "searchGoodsServices": { "title": "Also search goods and services", "type": "boolean", "description": "Turn on to also find entries whose goods and services text contains a term. Works with USPTO search matching.", "default": false }, "ownerNames": { "title": "Owner names (organisations)", "type": "array", "description": "Enter company names to watch, for example a competitor. Only organisation owners are returned. Marks owned by individuals are left out.", "default": [], "items": { "type": "string" } }, "niceClasses": { "title": "Nice classes", "type": "array", "description": "Enter international (Nice) class numbers from 1 to 45 to keep only entries in those classes. Leave empty for all classes.", "default": [], "items": { "type": "string" } }, "designCodes": { "title": "Design codes", "type": "array", "description": "Optional. Keep only marks with these USPTO design codes, for example 01.01.03 (a five-point star) or a prefix such as 01.01. It works together with your other filters. Watch mode only.", "default": [], "items": { "type": "string" } }, "publicationTypes": { "title": "Publication types", "type": "array", "description": "Pick the gazette sections to read. Published for opposition opens the 30-day window to oppose a mark.", "items": { "type": "string", "enum": [ "opposition", "registered", "renewed", "cancelled", "modified" ], "enumTitles": [ "Published for opposition", "Registrations issued", "Registrations renewed", "Registrations cancelled", "Registrations modified" ] }, "default": [ "opposition" ] }, "issues": { "title": "Number of weekly issues", "minimum": 1, "maximum": 104, "type": "integer", "description": "Set how many of the newest weekly gazette issues to read. The gazette comes out every Tuesday. Use 1 for a weekly schedule.", "default": 1 }, "issueDate": { "title": "Issue date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional. Enter one issue date, for example 2026-10-20, to read only that issue. Overrides the number of issues." }, "numbers": { "title": "Serial or registration numbers", "type": "array", "description": "Number check mode. Enter one number per line. 8 digits are read as a serial number and up to 7 digits as a registration number. Add SN or Reg in front to make it explicit.", "default": [], "items": { "type": "string" } }, "monitorMode": { "title": "Monitor mode (only new entries)", "type": "boolean", "description": "Watch mode only. Return only entries that earlier monitor-mode runs with the same state key did not return. Schedule a weekly watch with this on to get alerts. Number checks always return every number.", "default": false }, "stateKey": { "title": "Monitor state key", "type": "string", "description": "Name the memory that monitor mode uses. Use a different key for each separate watch list.", "default": "default" }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Stop after saving this many results. The default keeps test runs short and cheap. Set 0 for no limit. When left empty: 100 rows, or 20 rows when no brand terms, owner names or classes are given, so a first run is quick." } } }, "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 } } } } } } } } } }