{ "openapi": "3.0.1", "info": { "title": "USPTO TTAB Docket Diff API — Opposition & Cancellation Tracker", "description": "Daily diff feed for USPTO TTABVUE. Emits JSONL records for every change to TTAB proceeding status, filings, parties, scheduling-order deadlines, challenged-mark text, or final decision. Replaces $20-200k/yr CompuMark watch tiers at $30-1,000/mo. For TM prosecution counsel, IP litigation, BigLaw.", "version": "0.1", "x-build-id": "S30N0kKKC1gTbwJdp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/changewire~uspto-ttab-docket-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-changewire-uspto-ttab-docket-extractor", "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/changewire~uspto-ttab-docket-extractor/runs": { "post": { "operationId": "runs-sync-changewire-uspto-ttab-docket-extractor", "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/changewire~uspto-ttab-docket-extractor/run-sync": { "post": { "operationId": "run-sync-changewire-uspto-ttab-docket-extractor", "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": { "proceeding_numbers": { "title": "Proceeding numbers", "type": "array", "description": "Specific TTAB proceeding numbers to track (e.g. 91234567 oppositions, 92123456 cancellations, 88123456 ex parte). If empty, falls through to filer / mark / date filters; if all are empty, the actor processes the most recent daily changes feed.", "default": [], "items": { "type": "string" } }, "proceeding_types": { "title": "Proceeding types", "type": "array", "description": "Filter by TTAB proceeding category. Valid values: OPP (opposition), CAN (cancellation), EX (ex parte appeal), CON (concurrent use), INT (interference). Case-insensitive.", "default": [ "OPP", "CAN" ], "items": { "type": "string" } }, "filers_watch": { "title": "Filer watchlist (party names, case-insensitive substring)", "type": "array", "description": "Match party names whose plaintiff_name or defendant_name CONTAINS any string in this list (case-insensitive). Useful for tracking specific brands or law firms across all proceedings.", "default": [], "items": { "type": "string" } }, "marks_watch": { "title": "Mark watchlist (case-insensitive substring)", "type": "array", "description": "Match proceedings whose challenged_mark_text CONTAINS any string in this list (case-insensitive).", "default": [], "items": { "type": "string" } }, "lookback_days": { "title": "Lookback days (daily-changes feed)", "minimum": 1, "maximum": 90, "type": "integer", "description": "When proceeding_numbers is empty, the actor pulls TTABVUE daily-changes feeds for this many trailing days and unions the resulting proceeding set. Larger windows take longer.", "default": 7 }, "change_types": { "title": "Change types to emit", "type": "array", "description": "Subset of: status_change, filings_added, parties_change, deadline_change, mark_change, decision_landed. Empty = emit all.", "default": [ "status_change", "filings_added", "parties_change", "deadline_change", "mark_change", "decision_landed" ], "items": { "type": "string" } }, "snapshot_key": { "title": "Snapshot key", "type": "string", "description": "Key-value store key holding the previous snapshot. Default: 'ttab-snapshot-latest'.", "default": "" }, "ttabvue_base_url": { "title": "TTABVUE base URL override", "type": "string", "description": "Override the TTABVUE base. Default https://ttabvue.uspto.gov. Useful for offline test mirrors.", "default": "" }, "rate_limit_rps": { "title": "Polite rate limit (requests per second)", "minimum": 1, "maximum": 5, "type": "integer", "description": "USPTO does not publish a public RPS limit but blocks at >10 rps. Default 2 is polite-default.", "default": 2 } } }, "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 } } } } } } } } } }