{ "openapi": "3.0.1", "info": { "title": "USPTO Patent Search & Changes Feed", "description": "Clean, flat U.S. patent records from the official USPTO Open Data Portal API. Filter by keyword, CPC class, inventor, assignee, type, status, and grant-date window, with a what-changed-since-last-run mode. Billed only per delivered patent. No API key needed.", "version": "0.0", "x-build-id": "k9xsgYZoPgy6rbMyh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thoob~uspto-patent-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thoob-uspto-patent-feed", "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/thoob~uspto-patent-feed/runs": { "post": { "operationId": "runs-sync-thoob-uspto-patent-feed", "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/thoob~uspto-patent-feed/run-sync": { "post": { "operationId": "run-sync-thoob-uspto-patent-feed", "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 API key", "type": "string", "description": "Optional. The actor supplies a working key, so you can leave this blank. Pass your own to run against your own quota. Stored as a secret; never written to the dataset or logs." }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text search across the patent record (title and other indexed fields). Leave empty to match any. Supports AND, OR, NOT, quotes for a phrase, and * for a wildcard." }, "cpcClasses": { "title": "CPC classes", "type": "array", "description": "Keep only patents in these Cooperative Patent Classification codes (for example A61K, G06N, H04L). Combined into the query. Leave empty for any class.", "items": { "type": "string" } }, "inventor": { "title": "Inventor name", "type": "string", "description": "Optional. Keep only patents naming this inventor (matched against the inventor name on the record)." }, "assignee": { "title": "Assignee or applicant", "type": "string", "description": "Optional. Keep only patents whose applicant or owner matches this name (for example IBM, Genentech)." }, "applicationTypes": { "title": "Application types", "type": "array", "description": "Filter to these application types (for example Utility, Design, Plant, Reissue). Exact match on the record. Leave empty for any type.", "items": { "type": "string" } }, "statuses": { "title": "Application status", "type": "array", "description": "Filter to these application statuses (for example Patented Case, Abandoned). Exact match on the record. Leave empty for any status.", "items": { "type": "string" } }, "grantDateFrom": { "title": "Granted on or after", "type": "string", "description": "Optional. Keep only patents granted on or after this date (YYYY-MM-DD). Pair with the to date to bound a window." }, "grantDateTo": { "title": "Granted on or before", "type": "string", "description": "Optional. Keep only patents granted on or before this date (YYYY-MM-DD)." }, "grantedOnly": { "title": "Granted patents only", "type": "boolean", "description": "When on, deliver only records with a granted patent number (skip pending applications). When off, published-but-not-yet-granted applications are delivered too, with a null patent number.", "default": true }, "sortOrder": { "title": "Sort order", "enum": [ "newest", "oldest" ], "type": "string", "description": "Order results by grant date. Newest first is the default.", "default": "newest" }, "mode": { "title": "Mode", "enum": [ "full", "changes" ], "type": "string", "description": "full returns every patent matching your filter. changes returns only records that are new, newly granted, status-changed, or updated since this account's last run, tracked per account. The first changes run has no baseline, so it returns everything matching once, then tracks deltas.", "default": "full" }, "maxRecords": { "title": "Max delivered records", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Safety cap on how many patents this run delivers and bills. Defaults to 1000 so a first run stays quick and cheap; raise it for a full pull, or set 0 for no cap. In changes mode, records beyond the cap are not dropped: they are delivered on a later run, never billed twice. The platform spend cap (ACTOR_MAX_TOTAL_CHARGE_USD) is honored regardless.", "default": 1000 }, "pageSize": { "title": "API page size", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many records to request per API page (1 to 100). Larger pages are fewer requests; the default is the API maximum.", "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 } } } } } } } } } }