{ "openapi": "3.0.1", "info": { "title": "TTAB Opposition Tracker — Trademark Disputes API", "description": "Track TTAB trademark opposition and cancellation proceedings. Clean JSON for IP counsel, brand teams and AI agents.", "version": "0.0", "x-build-id": "trLdcsY0j7GEjXoV2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~ttab-trademark-opposition-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-ttab-trademark-opposition-tracker", "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/nexgendata~ttab-trademark-opposition-tracker/runs": { "post": { "operationId": "runs-sync-nexgendata-ttab-trademark-opposition-tracker", "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/nexgendata~ttab-trademark-opposition-tracker/run-sync": { "post": { "operationId": "run-sync-nexgendata-ttab-trademark-opposition-tracker", "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": { "party": { "title": "Party / company name", "type": "string", "description": "Search TTAB proceedings involving this party (plaintiff, defendant or potential opposer), e.g. 'Nike'. Required unless proceedingNumbers is given. An empty input fails before any network call and is not charged." }, "proceedingNumbers": { "title": "Proceeding numbers (optional)", "type": "array", "description": "Specific TTAB proceeding numbers to pull (e.g. 91308128). Overrides party search. Numbers not found on TTABVUE are reported in the status message and are not charged.", "items": { "type": "string" } }, "proceedingType": { "title": "Proceeding type", "enum": [ "all", "opposition", "cancellation", "concurrent use", "interference" ], "type": "string", "description": "Filter by type.", "default": "all" }, "status": { "title": "Status", "enum": [ "all", "pending", "terminated" ], "type": "string", "description": "Filter by proceeding status (pending or terminated).", "default": "all" }, "includeExtensions": { "title": "Include Extension-of-Time filings", "type": "boolean", "description": "TTABVUE lists Extension-of-Time-to-Oppose filings (numbered by the trademark application serial) alongside oppositions and cancellations. They are requests to extend the opposition deadline, not inter-partes proceedings; the requesting party is emitted as plaintiff ('Potential Opposer'). Set false to exclude them from results and billing.", "default": true }, "maxResults": { "title": "Max proceedings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of proceedings to return (1-500). The party search reads TTABVUE result pages of 25 (page=1..N) until this many proceedings are collected or the last page is reached. Every delivered proceeding is billed at $0.10.", "default": 50 }, "detailLevel": { "title": "Detail level", "enum": [ "full", "summary" ], "type": "string", "description": "'full' (default) reads each proceeding's TTABVUE page for status, status date and all parties — about 1 second per proceeding. 'summary' returns the fields shown on the TTABVUE search results (number, type, filing date, plaintiff, defendant, mark serial/registration numbers) straight from the result pages — hundreds of proceedings in seconds. In 'full' mode a proceeding whose detail page cannot be read in time is delivered as a summary row (detailLevel field says which) rather than dropped.", "default": "full" } } }, "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 } } } } } } } } } }