{
  "openapi": "3.0.1",
  "info": {
    "title": "PTAB Scraper: Inter Partes Review & Post-Grant Review Lookup",
    "description": "Look up USPTO PTAB patent challenges by patent or trial number: inter partes review (IPR), post-grant review (PGR) and other AIA trials, with parties, dates, status and decisions. Lists of numbers in one run; patents with no challenge get a \"no PTAB trials found\" row. Needs your own USPTO API key.",
    "version": "0.1",
    "x-build-id": "iEFKObO1c8jwBIKYQ"
  },
  "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). USPTO requires a USPTO.gov account verified with ID.me and a completed profile; older keys were deactivated on 8 October 2026. Create the key at https://data.uspto.gov/myodp. The key stays on Apify as an encrypted secret; this Actor sends it only to api.uspto.gov. Not needed when Dry run is on."
          },
          "dryRun": {
            "title": "Dry run (preview sample, no key needed)",
            "type": "boolean",
            "description": "Preview the exact output shape without a USPTO key: returns a fixed sample record for the selected mode, makes no USPTO API call and bills nothing (no start or per-record charge). Turn off and add your usptoApiKey to fetch live PTAB data.",
            "default": true
          },
          "mode": {
            "title": "What to fetch",
            "enum": [
              "proceedings",
              "decisions"
            ],
            "type": "string",
            "description": "<code>proceedings</code> — one record per PTAB trial (parties, patent, status, key dates). <code>decisions</code> — 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"
          },
          "trialNumbers": {
            "title": "Trial numbers (batch lookup)",
            "type": "array",
            "description": "Look up several trials in one run, e.g. <code>IPR2024-00123</code>. Spacing and case are forgiven (<code>ipr 2024-00123</code>); a pasted list in one item is split. Each number answers with its proceeding record (proceedings mode) or its decision documents (decisions mode), or with one <code>no_match</code> row when USPTO has no such trial. A trial returned for two requested numbers (a trial and its patent) is delivered, and billed, for each. The numbers are looked up one after the other. Search filters below are ignored.",
            "items": {
              "type": "string"
            }
          },
          "patentNumbers": {
            "title": "Patent numbers (batch lookup)",
            "type": "array",
            "description": "Look up several US patents in one run, e.g. <code>10701173</code> or <code>US 8,082,501 B2</code> (commas inside a number, spaces, the US prefix and the kind code are stripped). One item may also hold a pasted list separated by commas plus a space, semicolons or new lines. Each patent answers with the PTAB trials that challenged it, or with one <code>no_match</code> row, \"no PTAB trial found\", when none did. Publication numbers such as <code>US20200012345A1</code> are not patent numbers and get a warning row. The numbers are looked up one after the other. Search filters below are ignored.",
            "items": {
              "type": "string"
            }
          },
          "trialNumber": {
            "title": "Trial number",
            "type": "string",
            "description": "Look up one specific trial, e.g. <code>IPR2024-00123</code> (the same as a one-item Trial numbers list). When set, all search filters below are ignored: you get that trial's proceeding record (proceedings mode) or all of its decision documents (decisions mode), or one <code>no_match</code> row when USPTO has no such trial."
          },
          "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. <code>Institution Granted</code>, <code>Institution Denied</code>, <code>Final Written Decision</code>. 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. <code>10701173</code>. Commas, spaces, the US prefix and the kind code are stripped (<code>US8082501B2</code> becomes <code>8082501</code>). Used alone it is a lookup (an unmatched patent answers with a <code>no_match</code> row, and repeat-delivery suppression does not apply); combined with other search filters it narrows a search. If Trial number or a numbers list is also set, this patent is looked up with them."
          },
          "patentOwnerName": {
            "title": "Patent owner",
            "type": "string",
            "description": "Only trials where the patent owner matches this name as recorded by USPTO (e.g. <code>Samsung Electronics Co., Ltd.</code>). 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. <code>Apple Inc.</code>). Same exact-name caveat as Patent owner. Ignored when Trial number is set."
          },
          "technologyCenter": {
            "title": "Technology center",
            "type": "string",
            "description": "Only trials whose challenged patent sits in this USPTO technology center, e.g. <code>2600</code> (Communications) or <code>1600</code> (Biotech/Organic). Exact match on the value USPTO recorded. Ignored when Trial number is set."
          },
          "artUnit": {
            "title": "Group art unit",
            "type": "string",
            "description": "Only trials whose challenged patent sits in this USPTO group art unit, e.g. <code>2645</code>. More specific than technology center; exact match on the recorded value. 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."
          },
          "webhookUrl": {
            "title": "Webhook URL (optional alerts)",
            "type": "string",
            "description": "Optional HTTP(S) endpoint. When set, after writing records to the dataset the run also POSTs them to this URL as JSON (<code>{source, items, offset, count, total}</code>) in batches of 50. Schedule full snapshots and compare them downstream to push new institution/final-written decisions to Slack, n8n, Make or email. Best-effort: a webhook failure is logged but never fails the run."
          },
          "webhookSecret": {
            "title": "Webhook secret (optional)",
            "type": "string",
            "description": "Optional shared secret sent with each webhook POST as the X-Webhook-Secret header so your endpoint can verify the caller. Only used when Webhook URL is set; never logged."
          },
          "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. In a batch lookup every requested number needs at least one row, so set this at least as high as the number of numbers; the run says which numbers it did not reach.",
            "default": 100
          },
          "dedupe": {
            "title": "Repeat-delivery suppression",
            "required": [
              "enabled",
              "key"
            ],
            "type": "object",
            "description": "Suppress confirmed repeat deliveries for the same Apify user and search.",
            "properties": {
              "enabled": {
                "type": "boolean",
                "title": "Enabled",
                "description": "Use the tenant-isolated delivery ledger."
              },
              "key": {
                "type": "string",
                "maxLength": 256,
                "title": "Scope key",
                "description": "Optional stable alert or profile key. Empty derives the scope from this search."
              }
            },
            "default": {
              "enabled": true,
              "key": ""
            },
            "additionalProperties": false
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}