{ "openapi": "3.0.1", "info": { "title": "USPTO TTAB Oppositions & Cancellations Scraper (TTABVUE)", "description": "Search USPTO TTABVUE: trademark oppositions, cancellations, concurrent-use and appeals. Get both parties, counsel of record (name, firm, email, phone), every mark (serial + registration), the full prosecution-history docket and deadlines. Filter by type, party, mark, status and date.", "version": "0.1", "x-build-id": "DjN84dW1GZKKbeLd5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~uspto-ttab-proceedings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-uspto-ttab-proceedings-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/scrapers_lat~uspto-ttab-proceedings-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-uspto-ttab-proceedings-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/scrapers_lat~uspto-ttab-proceedings-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-uspto-ttab-proceedings-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": { "proceedingNumbers": { "title": "Proceeding Numbers (direct lookup)", "type": "array", "description": "One or more TTAB proceeding numbers to fetch directly, e.g. 91234567 (opposition) or 92012345 (cancellation). Fastest and most exact way to pull specific cases.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries (mark / keyword)", "type": "array", "description": "Free-text terms searched across TTABVUE (mark text and case content). Each value runs its own search.", "items": { "type": "string" } }, "partyName": { "title": "Party Name", "type": "array", "description": "Search by plaintiff or defendant party name, e.g. a company that files or defends oppositions.", "items": { "type": "string" } }, "propertyOwnerName": { "title": "Mark Owner Name", "type": "array", "description": "Search by the owner of a pleaded or involved mark (property owner).", "items": { "type": "string" } }, "serialOrRegistrationNumber": { "title": "Mark Serial / Registration Number", "type": "array", "description": "Find all proceedings that involve a given trademark application serial number or registration number.", "items": { "type": "string" } }, "correspondent": { "title": "Correspondent / Counsel Name", "type": "array", "description": "Search by correspondent (counsel of record) name or firm.", "items": { "type": "string" } }, "procStatus": { "title": "Proceeding Status (search scope)", "enum": [ "All", "Pending", "Terminated" ], "type": "string", "description": "Limit searches to pending (live), terminated (dead) or all proceedings.", "default": "All" }, "proceedingTypes": { "title": "Proceeding Type filter", "type": "array", "description": "Keep only these proceeding types. Accepts Opposition, Cancellation, Concurrent Use, Interference, Ex Parte Appeal (or codes OPP, CAN, CUP, INT, EXA).", "items": { "type": "string" } }, "status": { "title": "Status text filter", "type": "array", "description": "Keep only proceedings whose status contains one of these terms (e.g. Pending, Terminated).", "items": { "type": "string" } }, "filingDateFrom": { "title": "Filing Date From", "type": "string", "description": "Keep only proceedings filed on or after this date (YYYY-MM-DD or MM/DD/YYYY)." }, "filingDateTo": { "title": "Filing Date To", "type": "string", "description": "Keep only proceedings filed on or before this date (YYYY-MM-DD or MM/DD/YYYY)." }, "withDetails": { "title": "Include prosecution-history docket (add-on)", "type": "boolean", "description": "Attach the full prosecution-history docket timeline (every entry with date, text and due date). Billed as the 'details' event only when a docket is returned.", "default": true }, "withSummary": { "title": "AI proceeding summary (add-on, paid plans)", "type": "boolean", "description": "Add a plain-English AI summary of the dispute and docket. Billed as 'ai_summary' only on usable output. Disabled for free Apify users.", "default": false }, "withExtract": { "title": "AI structured extraction (add-on, paid plans)", "type": "boolean", "description": "Extract claims, key docket events, motions and outcome as structured JSON. Billed as 'ai_extract' only on usable output. Disabled for free Apify users.", "default": false }, "maxProceedings": { "title": "Max proceedings", "minimum": 1, "type": "integer", "description": "Maximum number of proceedings to return across all searches. Free Apify plans are capped at 10 per run.", "default": 50 } } }, "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 } } } } } } } } } }