{ "openapi": "3.0.1", "info": { "title": "USPTO API - Patent & Trademark Data", "description": "USPTO patent data from the USPTO Open Data Portal using your own free USPTO API key (USPTO.gov account plus ID.me). Search applications and granted patents by keyword, assignee, or inventor, or look up one patent. Without a key, live runs return a notice and charge nothing.", "version": "1.6", "x-build-id": "f6vQQfl2GqRCjuHj3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~uspto-api---patent-trademark-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-uspto-api---patent-trademark-data", "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/alizarin_refrigerator-owner~uspto-api---patent-trademark-data/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-uspto-api---patent-trademark-data", "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/alizarin_refrigerator-owner~uspto-api---patent-trademark-data/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-uspto-api---patent-trademark-data", "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", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "search_patents", "get_patent", "search_by_assignee", "search_by_inventor", "get_patent_claims", "get_citations", "search_trademarks", "get_trademark" ], "type": "string", "description": "The operation to perform", "default": "search_patents" }, "usptoApiKey": { "title": "USPTO Open Data Portal API Key", "type": "string", "description": "Required for live patent data. Your own free key from the USPTO Open Data Portal: create a USPTO.gov account, verify your identity with ID.me, then copy the key from data.uspto.gov (My ODP). Without a key, a live run returns an informational row and charges nothing." }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Keywords to search USPTO patent application records (title and other indexed fields). Advanced: Open Data Portal query syntax such as applicationMetaData.inventionTitle:battery." }, "patentNumber": { "title": "Patent Number", "type": "string", "description": "Granted patent number (for example US10123456B2 or 10123456), for get_patent" }, "applicationNumber": { "title": "Application Number", "type": "string", "description": "Patent application number (for example 16123456), for get_patent" }, "assignee": { "title": "Assignee", "type": "string", "description": "Applicant or assignee company name" }, "inventor": { "title": "Inventor", "type": "string", "description": "Inventor name to search" }, "cpcClass": { "title": "CPC Classification", "type": "string", "description": "Cooperative Patent Classification code" }, "dateFrom": { "title": "Date From", "type": "string", "description": "Filing date start (YYYY-MM-DD)" }, "dateTo": { "title": "Date To", "type": "string", "description": "Filing date end (YYYY-MM-DD)" }, "trademarkSerial": { "title": "Trademark Serial", "type": "string", "description": "Trademark serial number" }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum number of records to return (1 to 100)", "default": 25 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Return built-in sample data (no API key, no USPTO calls)", "default": true } } }, "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 } } } } } } } } } }