# Patent Publications Harvester Scraper (`datapilot/patent-publications-harvester-scraper`) Actor Search patents from Google Patents and Espacenet using keywords. Collect patent titles, publication and filing dates, abstracts, assignees, inventors, patent numbers, countries, detail links, remove duplicates, and export structured JSON for patent research, technology monitoring, and competitive. - **URL**: https://apify.com/datapilot/patent-publications-harvester-scraper.md - **Developed by:** [Data Pilot](https://apify.com/datapilot) (community) - **Categories:** Other, Real estate - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 scraped results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Patent Publications Harvester Scraper ⚖️ **Patent Publications Harvester Scraper** is a powerful Apify Actor designed to discover, track, and analyze **Patent Publications** from multiple global patent databases including USPTO, WIPO, and Google Patents. This tool provides comprehensive **Patent Publications** intelligence including patent details, inventors, claims, filing dates, classification codes, and legal status. Whether you're monitoring intellectual property, tracking competitor innovations, or conducting patent landscape research, the Patent Publications Harvester Scraper delivers actionable **Patent Publications** insights efficiently. With multi-source integration from USPTO, WIPO, and Google Patents, intelligent patent classification, claims extraction, inventor tracking, citation analysis, legal status monitoring, and deduplication, the Patent Publications Harvester Scraper ensures comprehensive **Patent Publications** discovery and analysis. It focuses on key **Patent Publications** signals including patent type, technology classification, filing date, claims count, and citations, making it an essential tool for **Patent Publications** research and intellectual property intelligence. --- ### 📋 Table of Contents - [Features](#-features) - [Data Sources](#-data-sources) - [How It Works](#-how-it-works) - [Input](#-input) - [Output](#-output) - [Technical Stack](#-technical-stack) - [Data Fields](#-data-fields) - [Patent Classifications](#-patent-classifications) - [Patent Types](#-patent-types) - [Use Cases](#-use-cases) - [Quick Start](#-quick-start) - [Configuration](#-configuration) - [Performance](#-performance) - [Billing](#-billing) - [Important Notes](#-important-notes) - [Keywords](#-keywords) - [Changelog](#-changelog) - [Support](#-support) --- ### 🔥 Features - **USPTO Integration** – Direct integration with U.S. Patent and Trademark Office database. - **WIPO Integration** – International patent data from World Intellectual Property Organization. - **Google Patents Integration** – Advanced patent search via Google Patents platform. - **Multi-Source Intelligence** – Aggregates **Patent Publications** from 3 major sources. - **Keyword Search** – Search **Patent Publications** by inventor, company, or technology. - **Patent Discovery** – Discovers relevant **Patent Publications** matching search criteria. - **Inventor Tracking** – Captures inventor and assignee information. - **Claims Extraction** – Identifies and extracts patent claims. - **Filing Date Tracking** – Records patent filing and publication dates. - **IPC Classification** – Captures International Patent Classification codes. - **CPC Classification** – U.S. Cooperative Patent Classification codes. - **Claims Count** – Identifies number of independent and dependent claims. - **Citation Tracking** – Tracks patent citations and references. - **Abstract Extraction** – Captures patent abstracts and summaries. - **Legal Status Monitoring** – Tracks patent grant, expiration, and status. - **Priority Date Tracking** – Records priority claim dates. - **Technology Classification** – Categorizes patents by technology area (15+ types). - **Patent Family Tracking** – Identifies related patents across jurisdictions. - **Assignee Analysis** – Tracks patent assignee companies. - **Jurisdiction Coverage** – Supports multiple countries and patent offices. - **URL Capture** – Provides direct links to patent documents. - **Value Scoring** – Estimates patent value based on features. - **Novelty Assessment** – Assesses novelty based on citations. - **Deduplication** – Removes duplicate patent records. - **Proxy Support** – Apify residential proxy support for reliability. - **Real-Time Dataset Push** – Pushes results to Apify Dataset with metadata. - **Detailed Logging** – Comprehensive logging of patent detection and processing. - **Asyncio-Friendly** – Non-blocking async/await architecture. --- ### 📊 Data Sources #### **1. USPTO (U.S. Patent and Trademark Office)** - **Authority**: Official U.S. patent database - **Coverage**: 12+ million U.S. patents since 1790 - **Data**: Full patent documents, claims, abstracts, examiner notes - **Update Frequency**: Real-time as patents are published - **API**: Official USPTO API with comprehensive data - **Scope**: Utility, design, plant, and reissue patents #### **2. WIPO (World Intellectual Property Organization)** - **Authority**: International patent system database - **Coverage**: Patents from 180+ countries and regions - **Data**: PCT (Patent Cooperation Treaty) applications and patents - **Update Frequency**: Regular updates as filings are processed - **Coverage**: Global patent landscape - **Scope**: International patent applications and publications #### **3. Google Patents** - **Authority**: Google's aggregated patent database - **Coverage**: Patents from multiple jurisdictions - **Data**: Full-text search, related patents, citations - **Update Frequency**: Real-time aggregation - **Accessibility**: User-friendly interface with advanced search - **Scope**: Global patent documents with full-text indexing --- ### ⚙️ How It Works The Patent Publications Harvester Scraper accepts a keyword to search for patents. It simultaneously queries USPTO, WIPO, and Google Patents with the keyword. For each patent found, it extracts full details including title, abstract, inventors, assignee, claims, filing date, publication date, classifications, status, and citations. Patents are analyzed to detect technology type, classify patent type, assess novelty based on citation count, and calculate value score. Results are deduplicated by patent number across jurisdictions and pushed to the dataset. A completion summary is logged with statistics. **Key Processing Steps:** 1. **Input Parsing** – Accept search keyword 2. **Proxy Setup** – Configure Apify residential proxy 3. **USPTO Query** – Search USPTO database 4. **WIPO Query** – Search WIPO database 5. **Google Patents Query** – Search Google Patents 6. **Patent Parsing** – Extract all patent details 7. **Title & Abstract Extraction** – Capture summary information 8. **Inventor Extraction** – Identify inventors and assignees 9. **Claims Parsing** – Extract and count claims 10. **Date Extraction** – Record filing and publication dates 11. **Classification Extraction** – Capture IPC and CPC codes 12. **Citation Analysis** – Extract and count citations 13. **Status Detection** – Identify patent grant/expiration status 14. **Technology Classification** – Categorize by technology area 15. **Value Scoring** – Estimate patent value 16. **Novelty Assessment** – Assess based on citations 17. **Deduplication** – Remove duplicates by patent number 18. **Dataset Push** – Push unique patents in batch 19. **Summary Logging** – Report statistics **Key Benefits:** - Monitor **Patent Publications** in technology areas of interest - Track competitor patent activities - Identify technology innovations - Assess patent landscape and novelty - Find relevant prior art - Build patent intelligence database --- ### 📥 Input The Actor accepts the following input parameters: | Field | Type | Default | Description | |-------|------|---------|-------------| | `keyword` | string | required | Search keyword for **Patent Publications** (e.g., "machine learning", "blockchain") | | `useApifyProxy` | boolean | `true` | Enable Apify residential proxies | | `apifyProxyGroups` | array | `["RESIDENTIAL"]` | Proxy group configuration | **Example Input:** ```json { "keyword": "artificial intelligence", "useApifyProxy": true } ```` **Search for Blockchain Patents:** ```json { "keyword": "blockchain" } ``` **Track Quantum Computing:** ```json { "keyword": "quantum computing" } ``` *** ### 📤 Output The Actor pushes **Patent Publications** records with the following structure: **Patent Publication Record:** | Field | Type | Description | |-------|------|-------------| | `patent_number` | string | Unique patent identifier | | `title` | string | Patent title | | `abstract` | string | Patent abstract/summary | | `inventors` | string | Inventor names (comma-separated) | | `assignee` | string | Company/organization holding patent | | `filing_date` | string | Patent filing date (YYYY-MM-DD) | | `publication_date` | string | Patent publication date (YYYY-MM-DD) | | `grant_date` | string | Patent grant date (if granted) | | `ipc_class` | string | International Patent Classification | | `cpc_class` | string | Cooperative Patent Classification | | `claims_count` | integer | Total number of claims | | `independent_claims` | integer | Number of independent claims | | `citations_count` | integer | Number of citations | | `cited_by_count` | integer | Number of papers citing this patent | | `patent_type` | string | Type (utility, design, plant) | | `technology_area` | string | Technology classification | | `status` | string | Patent status (granted, pending, expired) | | `family_members` | string | Related patents in patent family | | `jurisdiction` | string | Patent jurisdiction (US, EP, WO, etc.) | | `value_score` | integer | Estimated value (1-100) | | `novelty_score` | integer | Novelty assessment (1-100) | | `patent_url` | string | Direct link to patent document | | `source` | string | Data source (USPTO, WIPO, or Google Patents) | | `keyword` | string | Search keyword used | | `scraped_at` | string | ISO 8601 scrape timestamp | **Example Patent Publication Record:** ```json { "patent_number": "US10,123,456", "title": "Method and System for Machine Learning on Edge Devices", "abstract": "A system and method for deploying machine learning models on edge devices with optimized inference performance. The invention relates to techniques for model compression, quantization, and efficient execution on resource-constrained hardware.", "inventors": "John Smith, Jane Doe, Robert Johnson", "assignee": "Google LLC", "filing_date": "2020-06-15", "publication_date": "2021-08-20", "grant_date": "2022-03-14", "ipc_class": "G06F 15/18", "cpc_class": "G06N 5/025", "claims_count": 28, "independent_claims": 3, "citations_count": 45, "cited_by_count": 127, "patent_type": "utility", "technology_area": "Artificial Intelligence", "status": "granted", "family_members": "EP3456789B1, WO2021/012345", "jurisdiction": "US", "value_score": 82, "novelty_score": 76, "patent_url": "https://patents.google.com/patent/US10123456", "source": "Google Patents", "keyword": "machine learning", "scraped_at": "2025-02-14T12:00:00" } ``` **Example Multiple Patents (Batch):** ```json [ { "patent_number": "US10,234,567", "title": "Blockchain-Based Supply Chain Verification System", "abstract": "A distributed ledger system for supply chain transparency...", "inventors": "Alice Chen, Bob Wilson", "assignee": "Walmart Inc.", "filing_date": "2019-11-20", "publication_date": "2021-02-15", "grant_date": "2021-09-01", "ipc_class": "G06Q 30/00", "cpc_class": "G06Q 30/0205", "claims_count": 35, "independent_claims": 5, "citations_count": 52, "cited_by_count": 34, "patent_type": "utility", "technology_area": "Blockchain", "status": "granted", "value_score": 78, "novelty_score": 71, "source": "USPTO", "keyword": "blockchain", "scraped_at": "2025-02-14T12:00:00" } ] ``` *** ### 🧰 Technical Stack - **APIs:** USPTO API, WIPO API, Google Patents search - **HTTP Client:** httpx for async HTTP requests - **HTML/XML Parsing:** BeautifulSoup and regex - **JSON Parsing:** Standard json library - **Date Parsing:** datetime for standardized formatting - **Query Building:** urllib.parse for URL encoding - **Async:** asyncio for non-blocking operations - **Data Structure:** Collections for aggregation - **Deduplication:** Set-based tracking by patent number - **Scoring:** Algorithm-based value and novelty assessment - **Proxy:** Apify Proxy with RESIDENTIAL configuration - **Logging:** Apify Actor logging system - **Platform:** Apify Actor serverless environment *** ### 📊 Data Fields Explained #### **Patent Identification** - **patent\_number**: Unique patent identifier - **title**: Patent title/invention name - **patent\_type**: Type of patent (utility, design, plant) #### **Patent Parties** - **inventors**: People who invented the technology - **assignee**: Company or organization holding rights #### **Timeline** - **filing\_date**: When patent was filed - **publication\_date**: When patent was published - **grant\_date**: When patent was granted #### **Technical Classification** - **ipc\_class**: International classification - **cpc\_class**: U.S. cooperative classification - **technology\_area**: What technology it covers #### **Content** - **abstract**: Summary of invention - **claims\_count**: Number of claims - **citations\_count**: Patents it references #### **Assessment** - **value\_score**: Estimated importance (1-100) - **novelty\_score**: How novel it is (1-100) - **status**: Is it still active *** ### 🏛️ Patent Classifications The Actor identifies 15 **Patent Publications** technology areas: - **Artificial Intelligence** - ML, deep learning, neural networks - **Blockchain** - Distributed ledger, cryptocurrency - **Quantum Computing** - Quantum algorithms, quantum hardware - **Biotechnology** - Gene editing, medical treatments - **Nanotechnology** - Nanoparticles, nanostructures - **Renewable Energy** - Solar, wind, battery technology - **IoT/Sensors** - Internet of Things, sensor networks - **5G/6G** - Next-gen wireless communications - **Robotics** - Robots, autonomous systems - **Autonomous Vehicles** - Self-driving, mobility - **Cloud Computing** - Cloud infrastructure, SaaS - **Cybersecurity** - Security, encryption, defense - **Materials Science** - New materials, composites - **Medical Devices** - Healthcare technology - **Other Technologies** - Miscellaneous patents *** ### 📊 Patent Types The Actor recognizes 3 main patent types: - **Utility Patents** - Functional inventions (most common) - **Design Patents** - Ornamental designs - **Plant Patents** - New plant varieties *** ### 🎯 Use Cases - **Patent Landscape Research** – Research **Patent Publications** in technology area - **Competitor Intelligence** – Track competitor **Patent Publications** and IP strategy - **Innovation Analysis** – Identify emerging innovations via **Patent Publications** - **Prior Art Search** – Find relevant prior art for patent prosecution - **Novelty Assessment** – Assess novelty of invention ideas - **Patent Valuation** – Estimate value of patent portfolios - **Patent Mining** – Identify valuable acquisition targets - **Technology Trends** – Track **Patent Publications** trends - **Portfolio Analysis** – Analyze patent portfolio strength - **Freedom to Operate** – Assess patent infringement risks - **Licensing Opportunities** – Find patents to license - **Due Diligence** – Research patents during M\&A - **R\&D Planning** – Inform research strategy - **Patent Strategy** – Develop patent filing strategy - **Inventor Tracking** – Identify prolific inventors *** ### 🚀 Quick Start #### **1. Prepare Input** Go to Apify Console and enter: ```json { "keyword": "quantum computing", "useApifyProxy": true } ``` #### **2. Run the Actor** Click **Start** button. The Actor will: - Query USPTO for patents - Query WIPO for international patents - Query Google Patents - Extract patent details - Classify and score - Deduplicate and push to Dataset #### **3. Monitor Progress** Console shows: ``` [USPTO] Searching patents for: 'quantum computing' [WIPO] Searching international patents... [Google Patents] Searching patent database... Found 156 patents matching keyword. Successfully processed and stored 142 unique patents! ``` #### **4. View & Download Results** - **Results Tab**: All **Patent Publications** records - **Export**: JSON, CSV, Excel - **Filter**: By technology area or status - **Sort**: By value score or citations *** ### ⚙️ Configuration #### **Search Scope** Specific technology: ```json { "keyword": "CRISPR gene editing" } ``` Broad technology: ```json { "keyword": "artificial intelligence" } ``` *** ### 📈 Performance #### **Processing Speed** - \~30-45 seconds per search - \~40-100 patents per search - Detail extraction and scoring efficient - Citation analysis optimized #### **Resource Usage** - Memory: ~180-250MB - CPU: ~45-55% during processing - Network: ~5-10MB per search - API calls: 3 searches *** ### 💰 Billing #### **Batch Billing** - **Billing Model:** Batch push (not per-patent PPE) - **Typical Cost:** Single operation per search - **Efficiency:** High efficiency, bulk processing *** ### ⚠️ Important Notes #### **Legal & Compliance** - **Fair Use**: Respects patent office ToS and rate limits - **Attribution**: Respects patent holder rights - **Accuracy**: Data as recorded in patent databases - **Verification**: Verify with official patent offices - **Legal**: Not legal advice, consult patent attorney #### **Data Quality** - **Freshness**: Real-time from patent databases - **Completeness**: Comprehensive patent information - **Accuracy**: Official patent office data - **Reliability**: Patent offices highly reliable - **Verification**: Verify with official sources #### **Best Practices** - Consult patent attorney for analysis - Verify novel patents independently - Check claims carefully - Review prosecution history - Monitor for patent status changes - Track patent expirations - Understand technology thoroughly - Assess infringement carefully - Monitor patent citations - Follow patent office updates ### 📦 Changelog #### v1.0.0 (February 2025) **Initial Release:** - USPTO API integration - WIPO API integration - Google Patents search integration - Multi-source simultaneous querying - Keyword-based patent search - Patent detail extraction (title, abstract, inventors, assignee) - Patent date extraction (filing, publication, grant) - IPC and CPC classification extraction - Claims extraction and counting - Citation extraction and analysis - Patent type identification - Legal status detection - Patent family identification - Jurisdiction tracking - 15-type technology area classification - Patent value scoring algorithm - Novelty assessment based on citations - Deduplication by patent number - Multi-jurisdiction support - Real-time Dataset push - Detailed progress logging - Comprehensive error handling - Asyncio executor support *** ### 🧑‍💻 Support & Feedback - **Issues:** Submit via Apify console with keyword - **Documentation:** Check Actor details page - **Community:** Apify forum discussions - **Feature Requests:** Suggest improvements - **Bug Reports:** Include keyword and error details ### 📄 License & Legal **Terms of Use:** - Use for legitimate patent research - Respect patent office ToS and policies - Respect patent holder rights - Don't republish without permission - Comply with patent laws - Use data responsibly **Disclaimer:** Patent Publications Harvester Scraper is provided as-is for research purposes. Users are responsible for compliance with patent office ToS. This is not legal advice - consult a patent attorney for legal matters. *** ### 🎉 Get Started Today **Deploy now for **Patent Publications** research!** Use for: - 📊 Patent Analysis - 🔍 Patent Landscape - 💡 Innovation Research - 📈 Prior Art Search - 🎯 Patent Intelligence **Perfect for:** - Patent Attorneys - IP Managers - Researchers - Inventors - Technology Strategists *** **Last Updated:** February 2025\ **Version:** 1.0.0\ **Status:** Production Ready\ **Platform:** Apify Actor\ **Architecture:** Async/Await\ **Data Sources:** USPTO, WIPO, Google Patents *** ### 📚 Related Tools - Company Tech Stack Change Monitor - AI Tool Launch Tracker Scraper - Public Company Expansion Signals Scraper - News Mention Alert Engine **Your complete Apify-powered **Patent Publications** research solution!** 🚀✨ *** ### ⚖️ Patent Excellence This Actor is optimized for **Patent Publications** research with: - ✅ Multi-source USPTO, WIPO, Google Patents integration - ✅ 15-type technology classification - ✅ Claims extraction and analysis - ✅ Citation tracking - ✅ Value and novelty scoring - ✅ Patent family tracking - ✅ Real-time Dataset push - ✅ Error recovery - ✅ Production-ready code **Discover patents effortlessly!** 💎🚀 # Actor input Schema ## `keyword` (type: `string`): Enter technical keyword (e.g., battery, AI chip, mRNA, quantum). ## `useApifyProxy` (type: `boolean`): Recommended to prevent patent registries (USPTO/Google Patents) from blocking. ## `apifyProxyGroups` (type: `array`): Select proxy networks (RESIDENTIAL is highly recommended). ## Actor input object example ```json { "keyword": "AI chip", "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "keyword": "AI chip" }; // Run the Actor and wait for it to finish const run = await client.actor("datapilot/patent-publications-harvester-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "keyword": "AI chip" } # Run the Actor and wait for it to finish run = client.actor("datapilot/patent-publications-harvester-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "keyword": "AI chip" }' | apify call datapilot/patent-publications-harvester-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=datapilot/patent-publications-harvester-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Patent Publications Harvester Scraper", "description": "Search patents from Google Patents and Espacenet using keywords. Collect patent titles, publication and filing dates, abstracts, assignees, inventors, patent numbers, countries, detail links, remove duplicates, and export structured JSON for patent research, technology monitoring, and competitive.", "version": "0.0", "x-build-id": "o3QRB8ENDJmssUS29" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datapilot~patent-publications-harvester-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datapilot-patent-publications-harvester-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/datapilot~patent-publications-harvester-scraper/runs": { "post": { "operationId": "runs-sync-datapilot-patent-publications-harvester-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/datapilot~patent-publications-harvester-scraper/run-sync": { "post": { "operationId": "run-sync-datapilot-patent-publications-harvester-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", "required": [ "keyword" ], "properties": { "keyword": { "title": "Search Keyword", "type": "string", "description": "Enter technical keyword (e.g., battery, AI chip, mRNA, quantum)." }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Recommended to prevent patent registries (USPTO/Google Patents) from blocking.", "default": true }, "apifyProxyGroups": { "title": "Proxy Groups", "uniqueItems": true, "type": "array", "description": "Select proxy networks (RESIDENTIAL is highly recommended).", "items": { "type": "string", "enum": [ "RESIDENTIAL", "DATACENTER" ] }, "default": [ "RESIDENTIAL" ] } } }, "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 } } } } } } } } } } ```