{ "openapi": "3.0.1", "info": { "title": "USPTO Trademark Monitoring · Similar Marks & Deadlines", "description": "Trademark monitoring for new US trademark filings and publications similar to yours (a USPTO trademark watch): exact, contains, sound-alike and edit-distance matching with a 0-100 score and reason, Nice class and date filters, opposition deadline, onlyNew for schedules. Only matches are charged.", "version": "0.1", "x-build-id": "abX0oy87MGzeWdXDo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thequietstack~uspto-trademark-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thequietstack-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/thequietstack~uspto-trademark-watch/runs": { "post": { "operationId": "runs-sync-thequietstack-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/thequietstack~uspto-trademark-watch/run-sync": { "post": { "operationId": "run-sync-thequietstack-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", "required": [ "watchTerms" ], "properties": { "watchTerms": { "title": "Marks to watch", "type": "array", "description": "Your marks or brand names. Each one is checked against new US filings or publications in the date window. Example: NIKE, JUST DO IT.", "items": { "type": "string" } }, "dateField": { "title": "Watch filings or publications", "enum": [ "filed", "published" ], "type": "string", "description": "'filed' = new applications by filing date (earliest warning, months before opposition opens). 'published' = marks published for opposition in the Official Gazette, including scheduled upcoming publications - this is the one with an opposition deadline.", "default": "filed" }, "lookbackDays": { "title": "Look back (days)", "minimum": 1, "type": "integer", "description": "Window start = today minus this many days. Ignored when 'Date from' is set. For a daily schedule with onlyNew, 7 is plenty.", "default": 30 }, "lookaheadDays": { "title": "Look ahead (days, publications only)", "minimum": 0, "type": "integer", "description": "For 'published': also include publications already scheduled up to this many days ahead. Default 60 for 'published', 0 for 'filed'." }, "dateFrom": { "title": "Date from (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional fixed window start. Overrides 'Look back'." }, "dateTo": { "title": "Date to (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional fixed window end." }, "niceClasses": { "title": "Nice classes", "type": "array", "description": "Only marks filed in at least one of these international classes (1-45). Empty = all classes. Example: 25 (clothing), 9 (software), 35 (retail).", "items": { "type": "string" } }, "minSimilarity": { "title": "Minimum similarity (1-100)", "minimum": 1, "maximum": 100, "type": "integer", "description": "100 exact · 95 equals a USPTO pseudo-mark reading · 90 contains as a word · 85 contains inside a word / sounds alike · 80 one word sounds alike · below 90 also edit distance. 80 keeps NIKEE and NYKE but drops BIKE and NUKE.", "default": 80 }, "matchTypes": { "title": "Match types", "type": "array", "description": "Which reasons count as a match.", "items": { "type": "string", "enum": [ "exact", "contains", "phonetic", "levenshtein" ], "enumTitles": [ "Exact", "Contains", "Sounds alike", "Edit distance" ] }, "default": [ "exact", "contains", "phonetic", "levenshtein" ] }, "liveOnly": { "title": "Live marks only", "type": "boolean", "description": "Skip abandoned, cancelled and expired marks.", "default": true }, "excludeOwners": { "title": "Ignore these owners", "type": "array", "description": "Your own company names (case-insensitive, part of the name is enough), so your own filings are not reported or charged.", "items": { "type": "string" } }, "onlyNew": { "title": "Only marks not reported before", "type": "boolean", "description": "Remembers reported serial numbers per watch term in a named key-value store. Use with a schedule: each mark is reported and charged once.", "default": false }, "seenStoreName": { "title": "Memory store name", "type": "string", "description": "Named key-value store for onlyNew. Use a different name per client or watch list.", "default": "uspto-trademark-watch-seen" }, "maxResults": { "title": "Max matches (hard limit)", "minimum": 1, "type": "integer", "description": "Hard cap on matches written and charged in this run, across all terms. Closest matches are written first.", "default": 200 }, "maxResultsPerTerm": { "title": "Max matches per term", "minimum": 1, "type": "integer", "description": "Optional cap per watch term." }, "maxCandidatesPerTerm": { "title": "Candidates checked per term", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many USPTO search hits (by relevance) are scored per term. Free - only matches are charged. If SUMMARY says 'truncated', raise it or narrow the window/classes. Max 10,000.", "default": 1000 }, "maxCostUsd": { "title": "Max cost (USD)", "type": "string", "description": "Optional hard spending cap for this run, computed from the live per-match price. The run stops cleanly before the next match would exceed it." } } }, "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 } } } } } } } } } }