{ "openapi": "3.0.1", "info": { "title": "Patent Search API: PatSnap Patents, Legal Status and Families", "description": "Patent search API over 210M+ patents in 170+ jurisdictions: query, assignee, applicant and semantic prior art search, plus patent bibliography, abstracts, CPC and IPC classes, legal status and patent families, through the PatSnap Open Platform API. Bring your own key.", "version": "0.1", "x-build-id": "SfBGAUH3ZAf0bwfrS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~patent-search-legal-status-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-patent-search-legal-status-api", "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/nabeelbaghoor~patent-search-legal-status-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-patent-search-legal-status-api", "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/nabeelbaghoor~patent-search-legal-status-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-patent-search-legal-status-api", "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": { "mode": { "title": "What to read", "enum": [ "querySearch", "assigneeSearch", "applicantSearch", "semanticSearch", "bibliography", "legalStatus", "family" ], "type": "string", "description": "Each mode calls one documented read endpoint of the PatSnap Open Platform API. The four searches return patent lists; the three patent data modes read patents you list by number or PatSnap patent id.", "default": "querySearch" }, "apiKey": { "title": "PatSnap Open Platform API key", "type": "string", "description": "Your own API key from the API Keys page of the PatSnap Open Platform dashboard (open.patsnap.com). Sent in the Authorization Bearer header, never in a URL. Leave empty to use the DATA_API_KEY secret." }, "query": { "title": "Analytics query", "type": "string", "description": "Patent search by query. A PatSnap Analytics query of up to 3,000 characters, such as TACD: (solid state battery) for title, abstract, claims and description, or ANCS: (Apple, Inc.) AND TACD: (wireless charging). The syntax is described at analytics.patsnap.com/search_helper." }, "stemming": { "title": "Stemming", "type": "boolean", "description": "Patent search by query. Also match singular, plural and tense variants of English keywords (stemming 1). Off matches exact keywords only.", "default": false }, "companies": { "title": "Company names", "type": "array", "description": "Current assignee and original applicant searches. One standardized company name per line, such as Apple, Inc. or Huawei Technologies Co., Ltd. Up to 100 names; they are searched together with OR.", "items": { "type": "string" } }, "collapseType": { "title": "Collapse by family", "enum": [ "ALL", "APNO", "DOCDB", "INPADOC", "EXTEND" ], "type": "string", "description": "Query, assignee and applicant searches. Keep one publication per application or family instead of every publication.", "default": "ALL" }, "collapseBy": { "title": "Which publication to keep", "enum": [ "PBD", "APD", "AUTHORITY", "SCORE" ], "type": "string", "description": "Query, assignee and applicant searches, when collapsing. The field that picks the one publication kept for each application or family.", "default": "PBD" }, "collapseOrder": { "title": "Keep the latest or oldest", "enum": [ "LATEST", "OLDEST" ], "type": "string", "description": "Query, assignee and applicant searches, when collapsing by publication or application date.", "default": "LATEST" }, "sortBy": { "title": "Sort by", "enum": [ "SCORE", "PBDT_YEARMONTHDAY", "APD_YEARMONTHDAY", "ISD" ], "type": "string", "description": "Query, assignee and applicant searches. The order of the results; relevance is the default.", "default": "SCORE" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Query, assignee and applicant searches.", "default": "desc" }, "semanticText": { "title": "Technical text", "type": "string", "description": "Semantic search. A technical description, abstract or invention disclosure; PatSnap recommends more than 200 words. Results come back most similar first, at most 1,000." }, "authorities": { "title": "Authorities and kind codes", "type": "array", "description": "Semantic search. Limit results to authority plus kind code values such as USB (US granted), USA (US applications), EPB, CNA or JPU. Kind codes are A application, B granted, U utility model, D design. Leave empty for all.", "items": { "type": "string" } }, "publishedFrom": { "title": "Published from", "type": "string", "description": "Semantic search. Earliest publication date as YYYY-MM-DD or YYYYMMDD." }, "publishedTo": { "title": "Published to", "type": "string", "description": "Semantic search. Latest publication date as YYYY-MM-DD or YYYYMMDD." }, "filedFrom": { "title": "Filed from", "type": "string", "description": "Semantic search. Earliest application date as YYYY-MM-DD or YYYYMMDD." }, "filedTo": { "title": "Filed to", "type": "string", "description": "Semantic search. Latest application date as YYYY-MM-DD or YYYYMMDD." }, "minRelevancy": { "title": "Minimum relevancy (%)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Semantic search. Only return patents at least this similar to your text, such as 50 for 50%." }, "legalStatuses": { "title": "Legal status", "type": "array", "description": "Semantic search. Only return patents with these simple legal statuses. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "0", "220", "221", "999" ], "enumTitles": [ "Active", "Pending", "Inactive", "PCT designated stage expired", "PCT designated stage", "Undetermined" ] } }, "patents": { "title": "Patent numbers or ids", "type": "array", "description": "Bibliography, legal status and family modes. One publication number (such as US11205304B2 or EP3456789A1) or PatSnap patent id per line. Read in batches of 100; up to 5,000 per run. Search rows carry both values.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 20000, "type": "integer", "description": "The run stops after this many rows. Searches can page up to 20,000 results (semantic search 1,000).", "default": 100 } } }, "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 } } } } } } } } } }