{ "openapi": "3.0.1", "info": { "title": "USPTO Patent + Trademark Scraper - Co-Assignees, Citations", "description": "USPTO patent and trademark intelligence. Co-assignee mapping (partnership and M&A intel), CPC tech-cluster analysis, inventor mobility, expiration calendar, family and citation graph, trademark watch. For IP law firms, R&D, competitive intel, VC due diligence.", "version": "0.5", "x-build-id": "kbvBKZZZczp4La5yg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seibs.co~uspto-patent-intel/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seibs.co-uspto-patent-intel", "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/seibs.co~uspto-patent-intel/runs": { "post": { "operationId": "runs-sync-seibs.co-uspto-patent-intel", "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/seibs.co~uspto-patent-intel/run-sync": { "post": { "operationId": "run-sync-seibs.co-uspto-patent-intel", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "patent_search", "trademark_search", "co_assignee_mapping", "tech_cluster_analysis", "inventor_mobility", "expiration_calendar", "family_lookup", "citation_analysis" ], "type": "string", "description": "Data source: official USPTO Open Data Portal (ODP). SUPPORTED: patent_search (title/inventor/assignee/filing-date; CPC + assignees via per-app detail), family_lookup (parent-child continuity), expiration_calendar, co_assignee_mapping (co-applicants on an assignee's patents), inventor_mobility (inventor->assignee history), tech_cluster_analysis (dominant CPC + YoY for an assignee), trademark_search (keyless TSDR). Abstract + claim count are recovered from the grant/publication full-text XML when include_full_text is on. NOT AVAILABLE via ODP (returns a documented note, no charge): citation_analysis - ODP exposes no forward/backward citation graph.", "default": "patent_search" }, "uspto_odp_api_key": { "title": "USPTO ODP API key (optional)", "type": "string", "description": "USPTO Open Data Portal (ODP) API key. Best practice: set it once as the USPTO_ODP_API_KEY secret env var (Console > the actor > Settings > Environment variables) rather than per run. Free from https://data.uspto.gov. Optional - ODP search responds without a key but is rate-limited harder. Trademark_search (TSDR) is keyless." }, "keywords": { "title": "Keywords", "maxItems": 20, "type": "array", "description": "Free-text terms searched against patent title+abstract (patent_search) or mark text + goods/services (trademark_search). Combined with OR within the list.", "default": [], "items": { "type": "string" } }, "assignees": { "title": "Assignees (companies)", "maxItems": 20, "type": "array", "description": "Company names exactly as they appear in USPTO records, e.g. 'Apple Inc.', 'Google LLC', 'International Business Machines Corporation'. Used in patent_search, co_assignee_mapping, tech_cluster_analysis, expiration_calendar.", "default": [], "items": { "type": "string" } }, "inventors": { "title": "Inventors", "maxItems": 20, "type": "array", "description": "Inventor names as 'First Last'. Used in patent_search and inventor_mobility modes.", "default": [], "items": { "type": "string" } }, "cpc_classes": { "title": "CPC classification codes", "maxItems": 20, "type": "array", "description": "Cooperative Patent Classification codes. Accepts section level (G), class (G06), subclass (G06F), or group (G06F 17/30). Used in patent_search, tech_cluster_analysis, expiration_calendar.", "default": [], "items": { "type": "string" } }, "nice_classes": { "title": "Nice classes (trademark)", "maxItems": 20, "type": "array", "description": "Nice classification integers 1-45 as strings, e.g. '9' (software/electronics), '25' (apparel), '35' (advertising/business), '42' (technology/SaaS). Used in trademark_search.", "default": [], "items": { "type": "string" } }, "patent_numbers": { "title": "Patent numbers", "maxItems": 100, "type": "array", "description": "USPTO patent numbers (utility, design, plant or reissue). Accepts with or without commas. Required for family_lookup and citation_analysis modes.", "default": [], "items": { "type": "string" } }, "date_from": { "title": "Date from (YYYY-MM-DD)", "type": "string", "description": "Lower bound on filing or grant date depending on mode. Empty = no lower bound.", "default": "" }, "date_to": { "title": "Date to (YYYY-MM-DD)", "type": "string", "description": "Upper bound on filing or grant date depending on mode. Empty = no upper bound.", "default": "" }, "expiration_window_months": { "title": "Expiration window (months)", "minimum": 1, "maximum": 240, "type": "integer", "description": "Used only in expiration_calendar mode. Returns patents whose expected 20-year-from-filing expiry falls within the next N months from today.", "default": 18 }, "include_family_members": { "title": "Include patent family members", "type": "boolean", "description": "When true, enriches each patent record with continuations, divisionals, CIPs, and foreign equivalents. Independently chargeable ($0.005 per resolved family).", "default": false }, "include_forward_citations": { "title": "Include forward citations", "type": "boolean", "description": "When true, enriches each patent record with patents that cite this one (downstream impact). Chargeable as citation_enrichment ($0.005 per patent).", "default": false }, "include_backward_citations": { "title": "Include backward citations", "type": "boolean", "description": "When true, enriches each patent record with patents this one cites (prior art). Shares the citation_enrichment charge ($0.005 per patent) when forward citations are also requested.", "default": false }, "max_results": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on total records returned across pagination. USPTO ODP returns up to 100 per page; we paginate up to this number (max 1000).", "default": 100 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Parallel HTTP workers. USPTO ODP tolerates 4-8 comfortably. TSDR is slower; keep at 2-4 for trademark_search.", "default": 4 }, "include_full_detail": { "title": "Include CPC + assignees (per-app detail)", "type": "boolean", "description": "When on (default), patent_search fetches each result's per-application detail record to populate CPC codes and assignees (one extra USPTO ODP request per record, capped at 40/run for rate safety). Turn off for a faster, lighter search that returns title/inventors/dates only.", "default": true }, "include_full_text": { "title": "Include abstract + claim count (full-text, heavy)", "type": "boolean", "description": "When on, patent_search downloads each result's grant/publication full-text XML (about 1 MB each) to recover the abstract and claim count. Off by default - heavy. Capped at 10 full-text downloads per run for rate safety; charges the full-text enrichment event ($0.005) per enriched record.", "default": false }, "use_apify_proxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route requests through Apify Proxy. Off by default; USPTO endpoints don't usually rate-limit by IP. Enable if running back-to-back large jobs.", "default": 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 } } }, "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 } } } } } } } } } }