{ "openapi": "3.0.1", "info": { "title": "USPTO PTAB Trial Tracker — IPR/PGR/CBM API", "description": "Track USPTO PTAB AIA trials (IPR, PGR, CBM) from the Open Data Portal: search by party, patent, type or date; a new-petition delta feed; a petitioner<->patent-owner graph; and an institution-rate score (instituted/decided). Needs a free USPTO ODP API key.", "version": "1.1", "x-build-id": "NqPa8Bujb34fGXNrt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~ptab-trial-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-ptab-trial-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/malonestar~ptab-trial-tracker/runs": { "post": { "operationId": "runs-sync-malonestar-ptab-trial-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/malonestar~ptab-trial-tracker/run-sync": { "post": { "operationId": "run-sync-malonestar-ptab-trial-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": { "apiKey": { "title": "USPTO ODP API key", "type": "string", "description": "Your FREE USPTO Open Data Portal (ODP) API key, sent as the X-API-KEY header. Register in minutes at https://data.uspto.gov/apis/getting-started (video ID verification). Supplying your own key gives you your own rate limit; leave it blank to use the Actor default, which is shared across all users and throttles sooner. The USPTO decommissioned the old keyless PTAB API on 2026-01-06, so there is no unauthenticated path." }, "mode": { "title": "Mode", "enum": [ "search", "delta", "graph" ], "type": "string", "description": "search = list matching proceedings; delta = only NEW petitions (since a date and/or not seen in a prior run); graph = petitioner<->patent-owner edge list / rollup with institution-rate scores.", "default": "search" }, "party": { "title": "Party name", "type": "string", "description": "Optional free-text search term, e.g. \"Apple\" or \"Intel Corporation\". Note: this is a full-record search - it matches petitioner and patent-owner names, and it will ALSO match counsel firms and inventor surnames appearing in the record." }, "patentNumber": { "title": "Challenged patent number", "type": "string", "description": "Optional challenged patent number. The USPTO indexes the BARE grant number (e.g. 8082501); formatted forms such as US8082501B2 or 8,082,501 are normalized automatically. Returns every PTAB trial filed against that patent." }, "proceedingType": { "title": "Proceeding type", "enum": [ "", "IPR", "PGR", "CBM", "DER" ], "type": "string", "description": "Restrict to a PTAB trial type: IPR (inter partes review), PGR (post-grant review), CBM (covered business method), or DER (derivation). Empty = all types. Live counts 2026-08-01: IPR 18,136 / CBM 602 / PGR 568 / DER 28." }, "sinceDate": { "title": "Petition filed since (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}$", "type": "string", "description": "Only return proceedings whose petition was filed on or after this date. MUST be YYYY-MM-DD (e.g. 2025-01-15) - any other format is rejected and the run fails without billing, rather than silently returning the whole docket or none of it. Drives the delta/monitoring window. Empty = no lower bound." }, "priorItems": { "title": "Prior items (delta mode)", "type": "array", "description": "Delta mode: the previous run's results (or a list of proceeding_number strings). Any proceeding already present is treated as seen and excluded, leaving only new petitions. The Actor ALSO keeps a rolling seen-set in a NAMED key-value store, scoped to this exact query, so scheduled runs auto-delta without passing anything.", "default": [] }, "graphBy": { "title": "Graph grouping (graph mode)", "enum": [ "edge", "petitioner", "patentOwner" ], "type": "string", "description": "Graph mode grouping: edge = one row per petitioner->patent-owner pair; petitioner = per-petitioner rollup; patentOwner = per-patent-owner rollup. Each row carries proceeding_count and the institution-rate score.", "default": "edge" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of proceedings to fetch before delta/graph processing. The USPTO caps a page at 100, so this is fetched in pages of 100. If it is lower than the number of matches, every row carries results_truncated=true and total_matching_count - and in graph mode the institution rate is then a subset rate, not the party's real rate.", "default": 1000 } } }, "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 } } } } } } } } } }