# HOLD - USPTO Trademark Status Requires User API Key (`taroyamada/uspto-trademark-status-office-action-scraper`) Actor HOLD: this Actor requires a user-supplied USPTO API key for real rows and is excluded from the active public revenue portfolio. Do not promote it. - **URL**: https://apify.com/taroyamada/uspto-trademark-status-office-action-scraper.md - **Developed by:** [åĪŠéƒŽ åąąį”°](https://apify.com/taroyamada) (community) - **Categories:** Business - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $10.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## USPTO Trademark Status & Office Action Scraper Trademark teams, IP operations, brand protection teams, and legal ops use this actor to turn Official USPTO TSDR API with a user-provided API key into a clean dataset for Regulatory Trigger Pack. Provide focused source inputs, keep the first run small, and expand only after the output shape is useful. Each emitted row includes source context, timestamps, and fields designed for monitoring, QA, research, or workflow handoff. ### Store Quickstart Start with one serial number and a user-provided key, then seed a watchlist baseline for recurring status changes. Recommended first run: ```json { "serialNumbers": [ "88713620" ], "includeDocumentMetadata": true, "usptoApiKey": "YOUR_USPTO_API_KEY", "limit": 25, "firstRunMode": "emit_all", "delivery": "dataset", "dryRun": false } ```` ### Input examples #### Trademark status ```json { "serialNumbers": [ "88713620" ], "includeDocumentMetadata": true, "usptoApiKey": "YOUR_USPTO_API_KEY", "limit": 25, "firstRunMode": "emit_all", "delivery": "dataset", "dryRun": false } ``` #### Status only ```json { "serialNumbers": [ "88713620" ], "includeDocumentMetadata": false, "usptoApiKey": "YOUR_USPTO_API_KEY", "limit": 10, "firstRunMode": "emit_all", "delivery": "dataset", "dryRun": false } ``` #### Baseline seed ```json { "serialNumbers": [ "88713620" ], "includeDocumentMetadata": true, "usptoApiKey": "YOUR_USPTO_API_KEY", "limit": 25, "firstRunMode": "seed_only", "delivery": "dataset", "dryRun": false } ``` ### Sample output ```json { "meta": { "actorName": "uspto-trademark-status-office-action-scraper", "actorTitle": "USPTO Trademark Status & Office Action Scraper", "bundle": "Regulatory Trigger Pack", "fetchedAt": "2026-05-06T00:00:00.000Z", "totalRows": 1 }, "rows": [ { "actorName": "uspto-trademark-status-office-action-scraper", "rowType": "trademark_status", "eventType": "trademark_status_seen", "serialNumber": "88713620", "markLiteral": "EXAMPLE", "ownerName": "Example Owner LLC", "statusDescription": "Example status", "sourceUrl": "https://tsdrapi.uspto.gov/ts/cd/casestatus/sn88713620/info.xml", "fetchedAt": "2026-05-06T00:00:00.000Z" } ], "warnings": [] } ``` ### Output fields - `rowType` - `eventType` - `serialNumber` - `registrationNumber` - `markLiteral` - `ownerName` - `statusDescription` - `documentDescription` - `sourceUrl` Rows also include source URLs, fetch timestamps, warnings when a source is partial, and stable IDs when the workflow supports recurring change detection. ### Pricing and no-change runs $0.001 actor start and $0.030 per emitted trigger row. Missing-key and unchanged runs suppress dataset rows. The default dataset is the billable surface. Dry runs, validation-only runs, missing-key warnings, and unchanged recurring polls should not write payable default-dataset rows. ### Compliance guardrails - Requires the user's own USPTO API key. - The actor does not use a platform-owned key or download PDF/ZIP bundles. - No legal advice or provider-approval language. - Do not use provider emblems or wording that implies approval by an upstream data provider. ### See also - [sec-form-d-offering-notices-scraper](https://apify.com/taroyamada/sec-form-d-offering-notices-scraper) - [courtlistener-public-docket-opinion-watch-scraper](https://apify.com/taroyamada/courtlistener-public-docket-opinion-watch-scraper) # Actor input Schema ## `serialNumbers` (type: `array`): USPTO trademark serial numbers to inspect. ## `includeDocumentMetadata` (type: `boolean`): Fetch XML document metadata only; PDF and ZIP downloads are not used. ## `usptoApiKey` (type: `string`): User-supplied official USPTO TSDR API key. Falls back to USPTO\_API\_KEY environment variable. ## `knownStableIds` (type: `array`): Optional IDs already seen by your previous workflow run. Matching rows are suppressed to avoid no-change charges. ## `maxChargeUsd` (type: `number`): Safety cap for billable dataset rows. The actor stops emitting billable rows once this cap would be exceeded. ## `limit` (type: `integer`): Maximum billable rows to emit. ## `firstRunMode` (type: `string`): emit\_all writes the first matching rows. seed\_only stores the baseline and writes no rows. ## `delivery` (type: `string`): Where to send emitted trigger rows. ## `webhookUrl` (type: `string`): Required when delivery=webhook. ## `dryRun` (type: `boolean`): Run without external source requests or dataset writes. ## Actor input object example ```json { "serialNumbers": [ "88713620" ], "includeDocumentMetadata": true, "usptoApiKey": "", "knownStableIds": [], "maxChargeUsd": 1, "limit": 25, "firstRunMode": "emit_all", "delivery": "dataset", "webhookUrl": "", "dryRun": false } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "serialNumbers": [ "88713620" ], "knownStableIds": [] }; // Run the Actor and wait for it to finish const run = await client.actor("taroyamada/uspto-trademark-status-office-action-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`ðŸ’ū Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "serialNumbers": ["88713620"], "knownStableIds": [], } # Run the Actor and wait for it to finish run = client.actor("taroyamada/uspto-trademark-status-office-action-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("ðŸ’ū Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "serialNumbers": [ "88713620" ], "knownStableIds": [] }' | apify call taroyamada/uspto-trademark-status-office-action-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=taroyamada/uspto-trademark-status-office-action-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "HOLD - USPTO Trademark Status Requires User API Key", "description": "HOLD: this Actor requires a user-supplied USPTO API key for real rows and is excluded from the active public revenue portfolio. Do not promote it.", "version": "0.1", "x-build-id": "nhG8oLmD5lM0pH0CX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~uspto-trademark-status-office-action-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-uspto-trademark-status-office-action-scraper", "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/taroyamada~uspto-trademark-status-office-action-scraper/runs": { "post": { "operationId": "runs-sync-taroyamada-uspto-trademark-status-office-action-scraper", "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/taroyamada~uspto-trademark-status-office-action-scraper/run-sync": { "post": { "operationId": "run-sync-taroyamada-uspto-trademark-status-office-action-scraper", "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": { "serialNumbers": { "title": "Serial numbers", "type": "array", "description": "USPTO trademark serial numbers to inspect.", "default": [ "88713620" ], "items": { "type": "string" } }, "includeDocumentMetadata": { "title": "Include document metadata", "type": "boolean", "description": "Fetch XML document metadata only; PDF and ZIP downloads are not used.", "default": true }, "usptoApiKey": { "title": "USPTO API key", "type": "string", "description": "User-supplied official USPTO TSDR API key. Falls back to USPTO_API_KEY environment variable.", "default": "" }, "knownStableIds": { "title": "Known stable IDs", "type": "array", "description": "Optional IDs already seen by your previous workflow run. Matching rows are suppressed to avoid no-change charges.", "default": [], "items": { "type": "string" } }, "maxChargeUsd": { "title": "Maximum charge USD", "minimum": 0, "maximum": 100, "type": "number", "description": "Safety cap for billable dataset rows. The actor stops emitting billable rows once this cap would be exceeded.", "default": 1 }, "limit": { "title": "Result limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum billable rows to emit.", "default": 25 }, "firstRunMode": { "title": "First run mode", "enum": [ "emit_all", "seed_only" ], "type": "string", "description": "emit_all writes the first matching rows. seed_only stores the baseline and writes no rows.", "default": "emit_all" }, "delivery": { "title": "Delivery", "enum": [ "dataset", "webhook" ], "type": "string", "description": "Where to send emitted trigger rows.", "default": "dataset" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Required when delivery=webhook.", "default": "" }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Run without external source requests or dataset writes.", "default": false } } }, "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 } } } } } } } } } } ```