{
"openapi": "3.0.1",
"info": {
"title": "PTAB Trials Scraper — USPTO IPR & PGR Decisions API",
"description": "Track USPTO PTAB trials via the official Open Data Portal API: IPR, PGR, CBM and DER proceedings with normalized parties, patent, status and key dates — or per-trial decision documents (institution and final written decisions) joined with proceeding context. Free USPTO API key required (BYOK).",
"version": "0.1",
"x-build-id": "5OSf8atVEVk7Py01o"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/nomad-agent~ptab-trials-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-nomad-agent-ptab-trials-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/nomad-agent~ptab-trials-scraper/runs": {
"post": {
"operationId": "runs-sync-nomad-agent-ptab-trials-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/nomad-agent~ptab-trials-scraper/run-sync": {
"post": {
"operationId": "run-sync-nomad-agent-ptab-trials-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": {
"usptoApiKey": {
"title": "USPTO API key",
"type": "string",
"description": "Your free USPTO Open Data Portal API key (sent as X-API-KEY). Get one in minutes: create a USPTO.gov account, then open https://data.uspto.gov/myodp and copy your key. The key stays on Apify as an encrypted secret; this Actor sends it only to api.uspto.gov."
},
"mode": {
"title": "What to fetch",
"enum": [
"proceedings",
"decisions"
],
"type": "string",
"description": "proceedings — one record per PTAB trial (parties, patent, status, key dates). decisions — one record per decision document (institution decisions, final written decisions...), each joined with its proceeding's parties/patent/status context. Decisions mode makes one extra API call per matched trial, so it is slower on broad searches.",
"default": "proceedings"
},
"trialNumber": {
"title": "Trial number",
"type": "string",
"description": "Look up one specific trial, e.g. IPR2024-00123. When set, all other filters below are ignored: you get that trial's proceeding record (proceedings mode) or all of its decision documents (decisions mode)."
},
"query": {
"title": "Search query",
"type": "string",
"description": "Optional free-text query passed to the USPTO search API (parties, patent numbers, technology keywords). Leave empty to browse by the structured filters below only. Ignored when Trial number is set."
},
"proceedingTypes": {
"title": "Proceeding types",
"type": "array",
"description": "Restrict to specific AIA trial types. Empty = all types. Ignored when Trial number is set.",
"items": {
"type": "string",
"enum": [
"IPR",
"PGR",
"CBM",
"DER"
],
"enumTitles": [
"IPR — inter partes review",
"PGR — post-grant review",
"CBM — covered business method review",
"DER — derivation proceeding"
]
}
},
"statusCategory": {
"title": "Trial status",
"type": "string",
"description": "Optional exact status-category filter as used by the USPTO API, e.g. Institution Granted, Institution Denied, Final Written Decision. Free text because USPTO does not publish a closed list of values; run without this filter once and read the statusCategory field to see live values. Ignored when Trial number is set."
},
"patentNumber": {
"title": "Patent number",
"type": "string",
"description": "Only trials challenging this US patent, e.g. 10701173 (digits only, no commas). Ignored when Trial number is set."
},
"patentOwnerName": {
"title": "Patent owner",
"type": "string",
"description": "Only trials where the patent owner matches this name as recorded by USPTO (e.g. Samsung Electronics Co., Ltd.). The API matches the recorded name — try the free-text Search query instead if you are unsure of the exact form. Ignored when Trial number is set."
},
"petitionerName": {
"title": "Petitioner",
"type": "string",
"description": "Only trials where the petitioner's real party in interest matches this name as recorded by USPTO (e.g. Apple Inc.). Same exact-name caveat as Patent owner. Ignored when Trial number is set."
},
"filedFrom": {
"title": "Filed from",
"type": "string",
"description": "Only trials with an accorded filing date on/after this date. Ignored when Trial number is set."
},
"filedTo": {
"title": "Filed to",
"type": "string",
"description": "Only trials with an accorded filing date on/before this date. Ignored when Trial number is set."
},
"onlyNewSinceLastRun": {
"title": "Only new since last run",
"type": "boolean",
"description": "Only output proceedings/decisions not seen in previous runs with this flag. Skipped (already-seen) records are not pushed or billed — schedule the same search to watch for new IPR petitions against your patents or fresh final written decisions.",
"default": false
},
"maxItems": {
"title": "Max items",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Hard cap on records pushed per run (1–10000). In decisions mode this caps decision records; one trial can yield several decision documents.",
"default": 100
}
}
},
"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
}
}
}
}
}
}
}
}
}
}