{ "openapi": "3.0.1", "info": { "title": "US Trademark Status and Watch (USPTO TSDR)", "description": "Current status, dates, owner, attorney, classes and latest event of US trademarks from USPTO's official TSDR API, with computed Section 8 and renewal deadlines. Watch mode reports only the marks that changed since the last run.", "version": "0.1", "x-build-id": "huG5874Rqx60VsCac" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lone_rachis~us-trademark-status-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lone_rachis-us-trademark-status-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/lone_rachis~us-trademark-status-watch/runs": { "post": { "operationId": "runs-sync-lone_rachis-us-trademark-status-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/lone_rachis~us-trademark-status-watch/run-sync": { "post": { "operationId": "run-sync-lone_rachis-us-trademark-status-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": [ "marks" ], "properties": { "mode": { "title": "What to do", "enum": [ "check", "watch" ], "type": "string", "description": "check: one row per mark you list below. watch: run the same list on a schedule; the first run delivers every mark as the baseline, later runs deliver only marks whose status, status date, registration number, owner, attorney, prosecution history or deadline status changed, with each change listed. A watch run with no change writes one free row that says so.", "default": "check" }, "marks": { "title": "Serial or registration numbers", "maxItems": 500, "type": "array", "description": "One per line. An application serial number has 8 digits (97123456 or 97/123,456); a registration number has up to 7 (0238145, 238145 or 6,500,000). Write sn or rn in front to be explicit, such as sn97123456 or rn6500000. Each mark costs one request to TSDR. With the built-in trial key a run reads at most 10 marks; with your own key, 500.", "default": [], "items": { "type": "string" } }, "includeGoodsAndServices": { "title": "Include goods and services text", "type": "boolean", "description": "Keep the full goods and services wording of each class (cut at 5,000 characters per class, with a flag). Turn off for smaller rows: the class numbers, class status and first-use dates stay.", "default": true }, "stateStoreName": { "title": "Watch memory name", "type": "string", "description": "Watch mode. Optional. The name of the key-value store that remembers the last delivered state of each mark. Leave empty and the name comes from the list itself, so editing the list starts a new memory and the next run delivers every mark as a new baseline. Give a name, such as my-portfolio-watch, to keep one memory while you add or remove marks: only the new marks are delivered as a baseline. Letters, digits and dashes." }, "apiKey": { "title": "Your TSDR API key", "type": "string", "description": "Optional, and recommended. The TSDR API key from your own free USPTO.gov account (the README shows how to get one in three steps). With it a run reads up to 500 marks and uses your own share of the rate limit (60 requests a minute). Without it the run uses the Actor's built-in trial key, capped at 10 marks per run. The key is stored encrypted and is never written to the output or the log." } } }, "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 } } } } } } } } } }