{ "openapi": "3.0.1", "info": { "title": "EPO Patent Search: Company Portfolios, Inventors, Prior Art", "description": "Patent search by company, inventor, keyword, CPC or publication number from the EPO official worldwide register: 100+ patent offices, family, legal status, citations and claims. Verified company portfolios and prior art search. $0.002 a search, $0.0015 a row, $0.001 on higher Apify plans.", "version": "0.1", "x-build-id": "y9dw2LRX9Tv5Yp2ie" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pvalyou~patent-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pvalyou-patent-lookup", "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/pvalyou~patent-lookup/runs": { "post": { "operationId": "runs-sync-pvalyou-patent-lookup", "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/pvalyou~patent-lookup/run-sync": { "post": { "operationId": "run-sync-pvalyou-patent-lookup", "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": [ "queries" ], "properties": { "mode": { "title": "What are you looking up?", "enum": [ "company", "inventor", "search", "document", "family" ], "type": "string", "description": "How every query is read. Company: the patents a company owns (verified against the company's legal names). Inventor: patents naming a person. Search: keywords in title and abstract, narrowed by the filters below. Document: one publication number with family, legal status, citations and claims. Family: every member of a publication's family.", "default": "company" }, "queries": { "title": "Queries", "minItems": 1, "maxItems": 1000, "type": "array", "description": "One query per line, read in the mode above: company names, inventor names, search phrases or publication numbers (EP3000000A1, US12724156B1, WO2023187781A1). For programmatic use each entry may also be an object with 'query', 'mode' and any filter below, so one run can mix modes.", "items": { "type": "string" } }, "max_results": { "title": "Patent rows per query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on the rows a company, inventor or search query returns. Each row is one patent_record event. Up to 500 (the live search window). Larger portfolios: read has_more in the summary, then run again with the same query and a higher offset.", "default": 100 }, "offset": { "title": "Start at row", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Where the page starts for a company, inventor or search query. 0 is the first page. For the next page, raise it by the rows you already read (0, then 100, then 200 at 100 rows per query) for as long as has_more in the summary stays true. A live search reaches 500 rows, a stored company portfolio reaches its whole size. Document and family modes ignore it.", "default": 0 }, "countries": { "title": "Offices", "type": "array", "description": "Keep only publications from these offices: US, EP, WO, CN, JP, KR, IL, DE, GB and the other two-letter codes. Empty means every office.", "items": { "type": "string" } }, "granted_only": { "title": "Granted patents only", "type": "boolean", "description": "Drop applications and keep granted patents (kind codes B, C, E, S, U, Y).", "default": false }, "one_per_family": { "title": "One row per family", "type": "boolean", "description": "Collapse the members of each patent family to one row, so a portfolio counts inventions rather than filings.", "default": false }, "published_from": { "title": "Published from", "type": "string", "description": "Inventor and search modes: earliest publication date (2020, 2020-06, 2020-06-15)." }, "published_to": { "title": "Published to", "type": "string", "description": "Inventor and search modes: latest publication date." }, "filed_from": { "title": "Filed from", "type": "string", "description": "Company mode: earliest filing date, YYYY-MM-DD." }, "filed_to": { "title": "Filed to", "type": "string", "description": "Company mode: latest filing date, YYYY-MM-DD." }, "cpc": { "title": "CPC classes", "type": "string", "description": "Search mode: CPC symbols, comma separated (G01S17, H04L9/06, A61K). Any of them matches." }, "ipc": { "title": "IPC classes", "type": "string", "description": "Search mode: IPC symbols, comma separated." }, "applicant": { "title": "Applicant", "type": "string", "description": "Search mode: narrow the keyword search to this applicant name (token match, not verified)." }, "inventor": { "title": "Inventor", "type": "string", "description": "Search mode: narrow the keyword search to this inventor." }, "company": { "title": "Company", "type": "string", "description": "Inventor mode: narrow to patents where this company is the applicant." }, "include": { "title": "Document sections", "type": "array", "description": "Document mode: which sections to fetch beyond the bibliographic record. Claims and description text exist for EP and WO publications and a few national collections.", "items": { "type": "string", "enum": [ "family", "legal", "citations", "claims", "description" ], "enumTitles": [ "Family members", "Legal events (INPADOC)", "Citations (forward, and backward where listed)", "Claims text", "Description text" ] }, "default": [ "family", "legal", "citations" ] }, "refresh": { "title": "Force a live pass", "type": "boolean", "description": "Company mode: query the EPO now even when a pre-built portfolio exists (pre-built portfolios are refreshed every 90 days and carry their as_of date).", "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 } } } } } } } } } }