openapi: 3.1.0
info:
title: Patsnap Open Platform AI Translation Patent Data Search API
version: 1.0.0
description: OpenAPI specification for Patsnap Open Platform APIs, including patent search, analytics, and Eureka AI capabilities.
servers:
- url: https://connect.patsnap.com
description: Patsnap Open Platform API gateway
tags:
- name: Patent Data Search
description: Patent Data Search APIs.
paths:
/search/patent/image-search/single-batch-result:
post:
operationId: p062ImageSearchSingleBatchResult
summary: P062 Receive Image Batch Search Result
description: Retrieve the search results by querying the job_i returned by the interface for generating image batch retrieval tasks based on [P062].
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p062 receive image batch search result response.
content:
application/json:
schema:
$ref: '#/components/schemas/P062ImageSearchSingleBatchResultResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/image-search/single-batch-result
parameters:
- name: task_id
in: query
required: true
description: Task ID
schema:
type: string
example: 264de8bf7e294505a9a000597e25d615
description: Task ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P062ImageSearchSingleBatchResultRequest'
/search/patent/classification/helper-search:
get:
operationId: p072ClassificationHelperSearch
summary: P072 Classification number search assistant interface
description: Based on the retrieval content and the type of classification number assistant, obtain the classification level information related to the retrieval content
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p072 classification number search assistant interface response.
content:
application/json:
schema:
$ref: '#/components/schemas/P072ClassificationHelperSearchResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/classification/helper-search
parameters:
- name: keyword
in: query
required: true
description: Classified retrieval content
schema:
type: string
example: 手机
description: Classified retrieval content
- name: type
in: query
required: true
description: The classification number assistant category includes ipc, cpc, and loc
schema:
type: string
example: ipc
description: The classification number assistant category includes ipc, cpc, and loc
/search/patent/classification/helper-section-subclass:
get:
operationId: p071ClassificationHelperSectionSubclass
summary: P071 Classification Number Assistant Query
description: This interface supports querying the list of all subcategories of each type of classification (supporting IPC, CPC, LOC).
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p071 classification number assistant query response.
content:
application/json:
schema:
$ref: '#/components/schemas/P071ClassificationHelperSectionSubclassResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/classification/helper-section-subclass
parameters:
- name: code
in: query
required: false
description: Classification Number
schema:
type: string
example: A
description: Classification Number
- name: type
in: query
required: true
description: The classification number assistant category includes ipc, cpc, and loc
schema:
type: string
example: ipc
description: The classification number assistant category includes ipc, cpc, and loc
/search/patent/nested-search-patent:
post:
operationId: p075PatentNestedSearch
summary: P075 Search the patent nested version with a search formula
description: Search PatSnap's global patent database using standard text queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper. This includes patent count, patent number, and patent ID.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p075 search the patent nested version with a search formula response.
content:
application/json:
schema:
$ref: '#/components/schemas/P075PatentNestedSearchResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/nested-search-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P075PatentNestedSearchRequest'
/search/patent/query-search-count:
post:
operationId: p001PatentQuerySearchCount
summary: P001 Analytics Query Search Count
description: Search PatSnap's global patent database using standard text queries, to get total search patent count of different queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p001 analytics query search count response.
content:
application/json:
schema:
$ref: '#/components/schemas/P001PatentQuerySearchCountResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/query-search-count
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P001PatentQuerySearchCountRequest'
/search/patent/query-search-patent:
post:
operationId: p002PatentQuerySearch
summary: P002 Analytics Query Search
description: Search PatSnap's global patent database using standard text queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper. This includes patent count, patent number, and patent ID.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p002 analytics query search response.
content:
application/json:
schema:
$ref: '#/components/schemas/P002PatentQuerySearchResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/query-search-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P002PatentQuerySearchRequest'
/search/patent/company-search-patent:
post:
operationId: p004PatentCompanySearch
summary: P004 Original Applicant Search
description: Receive original assignee (applicant) patent data. This includes patent count, patent number and patent ID.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p004 original applicant search response.
content:
application/json:
schema:
$ref: '#/components/schemas/P004PatentCompanySearchResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/company-search-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P004PatentCompanySearchRequest'
/search/patent/current-search-patent:
post:
operationId: p005PatentCurrentSearch
summary: P005 Current Assignee Search
description: Receive current assignee patent data. This includes patent count, patent number and patent ID.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p005 current assignee search response.
content:
application/json:
schema:
$ref: '#/components/schemas/P005PatentCurrentSearchResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/current-search-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P005PatentCurrentSearchRequest'
/search/patent/similar-search-patent:
post:
operationId: p007PatentSimilarSearch
summary: P007 Patent Number Search Similar Patent
description: Receive similar patent list by patent id or patent number search, patent id is preferred when both are requested, the maximum number of patents returned is 1000. Sort by default from high to low similarity score.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p007 patent number search similar patent response.
content:
application/json:
schema:
$ref: '#/components/schemas/P007PatentSimilarSearchResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/similar-search-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P007PatentSimilarSearchRequest'
/search/patent/semantic-search-patent:
post:
operationId: p008PatentSemanticSearch
summary: P008 Semantic Search Similar Patent
description: Receive patent list by semantic search ,the maximum number of patents returned is 1000. Sort by default from high to low similarity .Try entering a technical piece of text e.g. an abstract (we recommend entering >200 words for best results).
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p008 semantic search similar patent response.
content:
application/json:
schema:
$ref: '#/components/schemas/P008PatentSemanticSearchResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/semantic-search-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P008PatentSemanticSearchRequest'
/image-search/image-upload:
post:
operationId: p010ImageSearchImageUpload
summary: P010 Image Search Get Image Url
description: Obtain the url accessible to the public network by uploading an image.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p010 image search get image url response.
content:
application/json:
schema:
$ref: '#/components/schemas/P010ImageSearchImageUploadResponse'
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/image-search/image-upload
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/P010ImageSearchImageUploadRequest'
/search/patent/company-search-defense-patent:
post:
operationId: p006PatentCompanySearchDefense
summary: P006 Current Assignee Search Defense Patent
description: Receive applicant defense patent data. This includes patent count, patent number, and patent ID.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p006 current assignee search defense patent response.
content:
application/json:
schema:
$ref: '#/components/schemas/P006PatentCompanySearchDefenseResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/company-search-defense-patent
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P006PatentCompanySearchDefenseRequest'
/search/patent/image-multiple:
post:
operationId: p061PatentImageMultiple
summary: P061 Image Search Similar Patent - Multiple images
description: Image Search helps you search for design patents or utility patents using multiple images (up to four). By default, the similarity is sorted from high to low, and one call can return up to 100 similar patents.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p061 image search similar patent - multiple images response.
content:
application/json:
schema:
$ref: '#/components/schemas/P061PatentImageMultipleResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/image-multiple
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P061PatentImageMultipleRequest'
/search/patent/image-single:
post:
operationId: p060PatentImageSingle
summary: P060 Image Search Similar Patent - Single image
description: Image Search helps you search for design patents or utility patents using images. By default, the similarity is sorted from high to low, and one call can return up to 100 similar patents.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p060 image search similar patent - single image response.
content:
application/json:
schema:
$ref: '#/components/schemas/P060PatentImageSingleResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/image-single
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P060PatentImageSingleRequest'
/search/patent/patent-search-pn:
post:
operationId: p069PatentPatentSearchPn
summary: P069 Patsnap Standard Patent Number Search
description: 'Retrieve the Patsnap Patent Number by entering the patent application number. This API supports inputting a numeric number and specifying the receiving jurisdiction to obtain the Patsnap Standard Patent Number. The returned information includes: Current Applicant, Original Applicant, Inventor, Application Date, Publication Date. Country code refer to https://analytics.zhihuiya.com/status.'
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p069 patsnap standard patent number search response.
content:
application/json:
schema:
$ref: '#/components/schemas/P069PatentPatentSearchPnResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/patent-search-pn
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P069PatentPatentSearchPnRequest'
/patent-field/query:
post:
operationId: p003PatentFieldQuery
summary: P003 Analytics Query Search and Filter
description: According to the search query, the corresponding filtering results are obtained, and the filtering results are optional.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p003 analytics query search and filter response.
content:
application/json:
schema:
$ref: '#/components/schemas/P003PatentFieldQueryResponse'
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/patent-field/query
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P003PatentFieldQueryRequest'
/search/patent/keyword-suggest:
post:
operationId: p070PatentKeywordSuggest
summary: P070 Keyword Assistant
description: 'The Keyword Helper helps expand your search by recommending synonyms of the words entered.
Add content to the Type field in the interface documentation：
Synonyms refer to words with the same or very similar meaning.
Hyponyms are words that represent more specific terms.
Similar keywords are words that share a similar concept or theme.'
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p070 keyword assistant response.
content:
application/json:
schema:
$ref: '#/components/schemas/P070PatentKeywordSuggestResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/keyword-suggest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P070PatentKeywordSuggestRequest'
/search/patent/image-search/single-batch-create:
post:
operationId: p062ImageSearchSingleBatchCreate
summary: P062 Create Image Batch Search Task
description: Support batch uploading of multiple product images (up to 10 images) to create image batch retrieval tasks (retrieval results are the same as [P060] Patent Image Retrieval - Single Image), and return job_id. Batch image retrieval tasks are performed daily from 22:00 to 08:00. After 8:00 the day after requesting job_i, the [P062] interface is called based on job_i to obtain the batch image retrieval results (link to the corresponding interface page URL) and retrieve the retrieval results.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p062 create image batch search task response.
content:
application/json:
schema:
$ref: '#/components/schemas/P062ImageSearchSingleBatchCreateResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/image-search/single-batch-create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P062ImageSearchSingleBatchCreateRequest'
/search/patent/image-single/beta:
post:
operationId: p060ImageSingleBeta
summary: P060 Image Search Similar Patent - Single image Enhanced Shape Search version
description: This interface supports searching for similar design patents via an image URL. By default, the results are sorted by similarity from highest to lowest, and a single request can return up to 100 similar patents. The search side has incorporated a step that converts the user's image into a patent-style line drawing, which better supports the recall effectiveness of images based on contour and shape. This can better support overseas e-commerce in conducting infringement searches against European and American patents.
tags:
- Patent Data Search
security:
- bearerAuth: []
responses:
'200':
description: Successful p060 image search similar patent - single image enhanced shape search version response.
content:
application/json:
schema:
$ref: '#/components/schemas/P060ImageSingleBetaResponse'
'201':
description: Created.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/search/patent/image-single/beta
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P060ImageSingleBetaRequest'
components:
schemas:
P060ImageSingleBetaResponse:
type: object
properties:
data:
$ref: '#/components/schemas/P060ImageSingleBeta_ImageSearchResponse'
status:
type: boolean
example: 'false'
description: Status
error_msg:
type: string
example: The request parameter format is incorrect！
description: Error Message
error_code:
type: integer
example: '0'
description: Error Code
required:
- status
- error_code
P062ImageSearchSingleBatchResultResponse:
type: object
properties:
data:
$ref: '#/components/schemas/P062ImageSearchSingleBatchResult_MoreImageSearchResponse'
status:
type: boolean
example: 'false'
description: Status
error_msg:
type: string
example: The request parameter format is incorrect！
description: Error Message
error_code:
type: integer
example: '0'
description: Error Code
required:
- status
- error_code
P075PatentNestedSearch_Facet:
type: object
properties:
end:
type: integer
format: int32
example: 2018
description: Range end value (not included) (when type is range)
expr:
type: string
example: avg(PV)
description: 'aggregate expressions support nesting. aggregate function currently supports five types: avg/min/max/sum/unique (when type is query)'
facet:
type: array
example:
- end: 2018
gap: 1
tag: apd_year
type: range
field: APD_YEAR
start: 2000
description: Nested statistical configuration
field:
type: string
example: ANCS
description: 'The name of the field to be counted (when type is field and range). Refer to : https://analytics.patsnap.com/search_helper'
gap:
type: integer
format: int32
example: 1
description: Range step value, default is 1 (when type is range)
limit:
type: integer
format: int32
example: 10
description: How many statistical results need to be returned (when type is field)
mincount:
type: integer
format: int32
example: 1
description: The minimum value that can be returned for statistics is set to 1 by default (when type is field)
num_buckets:
type: boolean
example: false
description: Count number of buckets for the facet, which defaults to false. The returned format is tag_num_buckets (when type is field)
offset:
type: integer
format: int32
example: 10
description: The offset of the statistics, used for pagination, is set to 0 by default (when type is field)
query:
type: string
example: PV:[0 TO 100000]
description: Queries that need to be statistically analyzed (when type is query)
start:
type: integer
format: int32
example: 2000
description: Range starting value (when type is range)
tag:
type: string
example: ancs
description: The current statistics of custom aliases (alias names cannot be name or count)
type:
type: string
example: field
description: <p>Retrieval statistical type:</p><p> field - Statistics of field values, equivalent to the traditional facet field</p><p> range - range statistics for numerical fields will be automatically completed, equivalent to the traditional range facet</p><p> query - Statistics on query, equivalent to the traditional facet query</p><p> aggregate - Perform statistics such as min/max/sum on fields</p>
required:
- tag
- type
P062ImageSearchSingleBatchCreateResponse:
type: object
properties:
data:
$ref: '#/components/schemas/P062ImageSearchSingleBatchCreate_MoreImageSearchTaskResponse'
status:
type: boolean
example: 'false'
description: Status
error_msg:
type: string
example: The request parameter format is incorrect！
description: Error Message
error_code:
type: integer
example: '0'
description: Error Code
required:
- status
- error_code
P061PatentImageMultipleRequest:
type: object
properties:
apply_end_time:
type: string
example: '20200101'
description: Patent apply date to, format:yyyyMMdd
apply_start_time:
type: string
example: '20100101'
description: Patent apply date from, format:yyyyMMdd
assignees:
type: string
example: huawei
description: all assignees
country:
type: array
example:
- US
- EU
- CN
description: 'patent authority code
For the authority code, refer to https://analytics.patsnap.com/status, Multiple items can be searched, separated by comma.'
field:
type: string
example: SCORE
description: <p>field sort(only Chinese).field support SCORE,APD,PBD,ISD. The default SCORE</p>
include_machine_translation:
type: boolean
example: true
description: Includes Machine Translations
is_https:
type: integer
format: int32
example: 0
description: '<p>Select whether to return https domain image, default is 0, that is, return http domain image</p><p> 1: Return https</p><p> 0: Return http</p>'
lang:
type: string
example: original
description: 'Set the language preference of the title, you can choose cn, en or original, the default is original:
original: Original title
cn: Chinese translation title
en: English translation Title'
legal_status:
type: string
example: 3,2
description: <p>patent legal status</p><p>1:Published 2:Examining 3:Granted 8:Double 11:Withdrawn 12:Withdrawn-Undetermined 17:Withdrawn-Deemed 18:Withdrawn-Voluntarily 13:Rejected 14:Revoked 15:Expired 16:Non-payment 21:Restoration 22:Ceased 23:P-Revoked 24:Discontinuation 30:Abandoned 19:Abandoned-Deemed 20:Abandoned-Voluntarily 25:Abandoned-Undetermined 222:Non-Entry PCT-NP (In time limit)） 223:PCT-NP (In time limit) 224:PCT-NP (Past time limit) 225:Non-Entry PCT-NP (Past time limit)</p>
limit:
type: integer
format: int32
example: 10
description: Returns the number of patents, 1 <= limit <= 100，default is 10
loc:
type: string
example: (14-03 OR 14-02)
description: <p>LOC is the classification for Industrial Designs.</p><p>Enter LOC code, use AND/OR/NOT to connect multiple codes.</p>
main_field:
type: string
example: (phones or 手机)
description: '<p>patent main field</p><p>The main field includes: title, abstract, claims, description, publication number, application number, applicant, invent
# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/patsnap/refs/heads/main/openapi/patsnap-patent-data-search-api-openapi.yml