{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Patents & Assignee Portfolio Scraper",
    "description": "🔎 Google Patents Scraper (google-patents-scraper) extracts structured patent data from Google Patents—titles, abstracts, inventors, assignees, CPC, claims, citations, priority dates & PDF links. ⚙️ Ideal for IP research, competitive intel & R&D. Export to CSV/JSON for analysis. 🚀",
    "version": "1.0",
    "x-build-id": "65wMyZPgJi7A4avmN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/api-empire~google-patents-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-api-empire-google-patents-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/api-empire~google-patents-scraper/runs": {
      "post": {
        "operationId": "runs-sync-api-empire-google-patents-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/api-empire~google-patents-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-api-empire-google-patents-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": {
          "portfolioAssignee": {
            "title": "🏢 Company / assignee name",
            "type": "string",
            "description": "🏭 Pulls every patent assigned to this organization. Same as the base actor's `assignee` field, renamed for this portfolio-focused variant (a legacy `assignee` value in your input JSON still works)."
          },
          "portfolioInventor": {
            "title": "🧑‍🔬 Inventor name",
            "type": "string",
            "description": "🧑‍🔬 Pulls every patent listing this inventor. Same as the base actor's `inventor` field, renamed here (a legacy `inventor` value still works)."
          },
          "fullPortfolioMode": {
            "title": "📈 Guarantee full-portfolio pagination",
            "type": "boolean",
            "description": "🔁 When ON (default) and a company/inventor is set above, the run pages through EVERY result Google Patents exposes for that container instead of stopping at a small default - only an explicit 'Max patents' cap below limits it.",
            "default": true
          },
          "maxPortfolioSize": {
            "title": "🔢 Max patents to collect (0 = entire portfolio)",
            "minimum": 0,
            "type": "integer",
            "description": "🎚️ Safety cap on how many patents to collect. Use **0** to collect the whole portfolio (Google Patents' own search index still limits how deep any single query can page). Same role as the base actor's `maxResults` (a legacy `maxResults` value still works) - note the DEFAULT here is 0/unlimited for a company or inventor container, vs. the base's default of 10 for a plain keyword search."
          },
          "patentLinks": {
            "title": "🔗 Patent & search links",
            "type": "array",
            "description": "✅ One entry per line: patent URLs, search URLs (q=), or plain keywords. Same as the base actor's `urls` field, renamed here (a legacy `urls` value still works).",
            "items": {
              "type": "string"
            }
          },
          "keywordSearch": {
            "title": "🔤 Keywords",
            "type": "string",
            "description": "💡 Optional keyword search, OR-merged with the portfolio container and any links above. Same as the base actor's `searchQuery` field, renamed here (a legacy `searchQuery` value still works)."
          },
          "publicationIds": {
            "title": "🔢 Publication numbers",
            "type": "array",
            "description": "📋 Specific patent IDs to include. Same as the base actor's `patentNumbers` field, renamed here (a legacy `patentNumbers` value still works).",
            "items": {
              "type": "string"
            }
          },
          "jurisdiction": {
            "title": "🌍 Patent office / region",
            "enum": [
              "ANY",
              "US",
              "EP",
              "WO",
              "CN",
              "JP",
              "KR",
              "DE",
              "GB",
              "FR",
              "CA",
              "AU",
              "IN",
              "BR",
              "TW",
              "RU",
              "IT",
              "ES",
              "NL",
              "SE",
              "CH",
              "AT",
              "HK",
              "SG",
              "MX",
              "NO",
              "DK",
              "FI",
              "PL",
              "IL",
              "NZ",
              "ZA",
              "SA",
              "AR",
              "TH",
              "MY",
              "PH",
              "ID",
              "VN"
            ],
            "type": "string",
            "description": "🗺️ Pick a country or office - or **Any**. Also chooses the reference country used for the per-patent `legalStatus` (active/expired) field. Same as the base actor's `country` field, renamed here (a legacy `country` value still works)."
          },
          "publishedAfter": {
            "title": "📅 Published after",
            "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "⏳ Calendar date or relative range (e.g. *30 days*, *6 months*). Same as the base actor's `dateFrom` field, renamed here (a legacy `dateFrom` value still works)."
          },
          "publishedBefore": {
            "title": "📅 Published before",
            "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "⏳ Same as above - absolute or relative. Same as the base actor's `dateTo` field, renamed here (a legacy `dateTo` value still works)."
          },
          "documentKind": {
            "title": "📄 Document kind",
            "enum": [
              "ANY",
              "PATENT",
              "APPLICATION",
              "DESIGN"
            ],
            "type": "string",
            "description": "📑 Limit to grants, applications, or designs. Same as the base actor's `patentType` field, renamed here (a legacy `patentType` value still works)."
          },
          "fetchFullDescription": {
            "title": "📖 Full description",
            "type": "boolean",
            "description": "📜 Adds the full written description. Same as the base actor's `includeFullText` (a legacy value still works)."
          },
          "fetchClaims": {
            "title": "⚖️ Claims",
            "type": "boolean",
            "description": "📋 Adds the patent claims text. Same as the base actor's `includeClaims` (a legacy value still works)."
          },
          "fetchCitations": {
            "title": "🔗 Citations",
            "type": "boolean",
            "description": "↩️ Adds backward/forward citation lists. Same as the base actor's `includeCitations` (a legacy value still works)."
          },
          "fetchPatentFamily": {
            "title": "👨‍👩‍👧 Patent family",
            "type": "boolean",
            "description": "🌍 Adds related publications in the same family. Same as the base actor's `includePatentFamily` (a legacy value still works)."
          },
          "fetchClassifications": {
            "title": "🏷️ CPC / IPC codes",
            "type": "boolean",
            "description": "🧮 Adds classification codes - also feeds the portfolio's Top CPC codes stat. Same as the base actor's `includeClassifications` (a legacy value still works)."
          },
          "includeOwnershipSplit": {
            "title": "🔀 Original vs. current assignee",
            "type": "boolean",
            "description": "🏛️ Adds `originalAssignee`/`currentAssignee`/`ownershipChanged` per patent, parsed from the same detail page already fetched above (no extra request when any enrichment toggle is on).",
            "default": true
          },
          "includePortfolioStats": {
            "title": "📈 Portfolio summary row",
            "type": "boolean",
            "description": "🧾 Adds ONE extra dataset row (`type: portfolioSummary`) per run with patent-count-by-year, active-vs-expired ratio, and top CPC codes for the company/inventor container above.",
            "default": true
          },
          "connectionSettings": {
            "title": "🔐 Proxy",
            "type": "object",
            "description": "🛟 Optional Apify Proxy settings. Same as the base actor's `proxyConfiguration` (a legacy value still works)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}