openapi: 3.1.0
info:
title: Patsnap Open Platform AI Translation Patent Mining Data 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 Mining Data
description: Patent Mining Data APIs.
paths:
/high-value-data/application-domain:
get:
operationId: p023HighValueDataApplicationDomain
summary: P023 Application Domain
description: Receive application domain classification data by patent_id or patent_number.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p023 application domain response.
content:
application/json:
schema:
$ref: '#/components/schemas/P023HighValueDataApplicationDomainResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/high-value-data/application-domain
parameters:
- name: lang
in: query
required: false
description: Select the language , you can choose cn or en.
schema:
type: string
example: en
description: Select the language , you can choose cn or en.
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 1a47a70d-6b54-4709-a72a-ed552781fcac,ef7d1252-2e0e-40c3-a44f-1bc1c86b7990
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN102681224A
description: patent_number
/high-value-data/tech-problem-and-benefit-summary:
get:
operationId: p025HighValueDataTechProblemAndBenefitSummary
summary: P025 The Three Elements of Patent Technology
description: Receive the classification data for the three elements of patent technology, namely technical problem summary, technical benefit summary and technical approach summary, by providing the patent_id or patent_number.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p025 the three elements of patent technology response.
content:
application/json:
schema:
$ref: '#/components/schemas/P025HighValueDataTechProblemAndBenefitSummaryResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/high-value-data/tech-problem-and-benefit-summary
parameters:
- name: lang
in: query
required: false
description: Select the language , you can choose cn or en.
schema:
type: string
example: en
description: Select the language , you can choose cn or en.
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: ef7d1252-2e0e-40c3-a44f-1bc1c86b7990,767a81fb-8abb-45e4-b9fe-4bbc327dc586
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN102681224A,US20230139460A1
description: patent_number
/high-value-data/seic-classification:
get:
operationId: p022HighValueDataSeicClassification
summary: P022 Strategic Emerging Industry Classification (SEIC)
description: Receive strategic emerging industry classification data by patent_id or patent_number.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p022 strategic emerging industry classification (seic) response.
content:
application/json:
schema:
$ref: '#/components/schemas/P022HighValueDataSeicClassificationResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/high-value-data/seic-classification
parameters:
- name: lang
in: query
required: false
description: Select the language , you can choose cn or en.
schema:
type: string
example: en
description: Select the language , you can choose cn or en.
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 1e099a74-4378-4b84-9d13-f1b4ed5cb59b,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN110650438A
description: patent_number
/high-value-data/technology-topic:
get:
operationId: p024HighValueDataTechnologyTopic
summary: P024 Technology Topic
description: <p>Receive technology topic classification data by patent_id or patent_number.</p><p>Technology topic is a classification developed by Patsnap that allows you to easily understand key elements of the technical solution. The algorithm leverages AI technology. Technology topic is not provided for design patents.</p>
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p024 technology topic response.
content:
application/json:
schema:
$ref: '#/components/schemas/P024HighValueDataTechnologyTopicResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/high-value-data/technology-topic
parameters:
- name: lang
in: query
required: false
description: Select the language , you can choose cn or en.
schema:
type: string
example: en
description: Select the language , you can choose cn or en.
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: ef7d1252-2e0e-40c3-a44f-1bc1c86b7990,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN102681224A
description: patent_number
/high-value-data/patent-classification-description:
post:
operationId: p066HighValueDataPatentClassificationDescription
summary: P066 Patent Classification Description
description: 'Receive patent classification description data by corresponding classification type and code.<p>Note: There must be all of the two request parameters of classification type and code. The API supports batch requests with a maximum of 10 classification codes of one type, and more classification codes are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.</p>'
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p066 patent classification description response.
content:
application/json:
schema:
$ref: '#/components/schemas/P066HighValueDataPatentClassificationDescriptionResponse'
'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/high-value-data/patent-classification-description
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P066HighValueDataPatentClassificationDescriptionRequest'
/basic-patent-data/patent_enhanced_data:
get:
operationId: p064BasicPatentDataPatentEnhancedData
summary: P064 Patent Enhanced Data
description: Receive patent basic bibliography data by patent_id or patent_number.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p064 patent enhanced data response.
content:
application/json:
schema:
$ref: '#/components/schemas/P064BasicPatentDataPatentEnhancedDataResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/basic-patent-data/patent_enhanced_data
parameters:
- name: fields
in: query
required: false
description: the fields you want received, multiple fields are separated by commas.
schema:
type: string
example: first_publication,application_type,first_claim
description: the fields you want received, multiple fields are separated by commas.
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 718ead9c-4f3c-4674-8f5a-24e126827269
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: US11205304B2
description: patent_number
/material/material-ontology:
post:
operationId: p101MaterialMaterialOntology
summary: P101 material ontology
description: This interface provides all material ontology lables in the patent text
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p101 material ontology response.
content:
application/json:
schema:
$ref: '#/components/schemas/P101MaterialMaterialOntologyResponse'
'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/material/material-ontology
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 9cf648f8-8283-4767-9a14-f90f68303f3e,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN108977442B
description: patent_number
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P101MaterialMaterialOntologyRequest'
/material/patent-pum:
post:
operationId: p100MaterialPatentPum
summary: P100 patent PUM
description: This interface provides all PUM information (including Property, Unit, and Measurement) in the patent text
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p100 patent pum response.
content:
application/json:
schema:
$ref: '#/components/schemas/P100MaterialPatentPumResponse'
'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/material/patent-pum
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 9cf648f8-8283-4767-9a14-f90f68303f3e,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN108977442B
description: patent_number
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P100MaterialPatentPumRequest'
/material/material-spum:
post:
operationId: p103MaterialMaterialSpum
summary: P103 patent SPUM
description: This interface provides all material and PUM (including Property, Unit and Measurement) in the patent text.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p103 patent spum response.
content:
application/json:
schema:
$ref: '#/components/schemas/P103MaterialMaterialSpumResponse'
'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/material/material-spum
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 9cf648f8-8283-4767-9a14-f90f68303f3e,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN108977442B
description: patent_number
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P103MaterialMaterialSpumRequest'
/material/material-substance:
post:
operationId: p102MaterialMaterialSubstance
summary: P102 material substance
description: This interface provides all material substance name in the patent text.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p102 material substance response.
content:
application/json:
schema:
$ref: '#/components/schemas/P102MaterialMaterialSubstanceResponse'
'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/material/material-substance
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 9cf648f8-8283-4767-9a14-f90f68303f3e,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN108977442B
description: patent_number
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P102MaterialMaterialSubstanceRequest'
/search/patent/intelligent-attached-image:
post:
operationId: p063PatentIntelligentAttachedImage
summary: P063 Patent intelligent attached image
description: Receive patent intelligent attached image data by patent_id.
tags:
- Patent Mining Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p063 patent intelligent attached image response.
content:
application/json:
schema:
$ref: '#/components/schemas/P063PatentIntelligentAttachedImageResponse'
'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/intelligent-attached-image
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P063PatentIntelligentAttachedImageRequest'
components:
schemas:
P064BasicPatentDataPatentEnhancedData_PatentEnhancedResponse:
type: object
properties:
pn:
type: string
example: CN101595528B
description: Patent Number
patent_id:
type: string
example: 02515f4b-1506-4c99-8101-9242f916bd99
description: Patent Id
first_claim:
type: array
example: 'Please check the form: PatentEnhancedClaim'
description: Patent first claim
items:
$ref: '#/components/schemas/P064BasicPatentDataPatentEnhancedData_PatentEnhancedClaim'
application_type:
type: integer
format: int32
example: 1
description: Application Type
first_publication:
$ref: '#/components/schemas/P064BasicPatentDataPatentEnhancedData_PatentEnhancedPublication'
earliest_priority_date:
type: integer
format: int32
example: 20220112
description: Earliest Priority Date
P102MaterialMaterialSubstance_MaterialSubstanceLable:
type: object
properties:
substance_id:
type: string
example: 4440b6da-82d9-4719-aeb9-6670b15a0a4e
description: material substance id
substance_master_name_cn:
type: string
example: 二氯甲烷
description: material substance chinese name
substance_master_name_en:
type: string
example: METHYLENE CHLORIDE
description: material substance english name
P022HighValueDataSeicClassificationResponse:
type: object
properties:
data:
type: array
example: no sample
description: response data
items:
$ref: '#/components/schemas/P022HighValueDataSeicClassification_SeicClassificationResp'
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
P024HighValueDataTechnologyTopicResponse:
type: object
properties:
data:
type: array
example: no sample
description: response data
items:
$ref: '#/components/schemas/P024HighValueDataTechnologyTopic_TechnologyTopicResponse'
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
P025HighValueDataTechProblemAndBenefitSummary_TechnicalApproachSummary:
type: object
properties:
technical_approach_para:
type: array
example: "<cn>[\"[0042]如上所述，考虑到TFT玻璃基板尽量减小金属线负载的设计基本原则，一张母板玻璃可以设置一组或几组信号输入端口，这样可以根据TFT玻璃基板设计的实际情况，将一张母板玻璃的单元液晶屏分成几组，每组的单元液晶屏共用一组信号输入端口，尽量减小Cell Test检测用信号线负载的影响。按照信号线损耗尽量相等的原则，离Pad端较远的单元液晶屏的Cell Test检测用信号线比离Pad端较近的单元液晶屏的Cell Test检测用信号线宽，以使整张母板上所有单元液晶屏的Cell Test检测用信号线的电阻尽量相等，单元液晶屏之间的电压分布均匀。\"]</cn><us>[\"Vertical polarization antenna: the scheme provides a method to implement a vertical polarization antenna in an antenna module with a certain height. this feature addresses the challenge of integrating a vertical polarization antenna into a compact device.\",\n \"Orthogonal polarization antennas: the scheme introduces an antenna module with antenna elements having different polarizations orthogonal to each other. this feature allows for multiple-input multiple-output (mimo) communication, enhancing the overall performance and data rate of the electronic device.\",\n \"Disposing an array antenna in a millimeter wave band: the scheme overcomes the limitation of existing wireless communication systems by incorporating an array antenna into an electronic device. this allows for multifunctionality, enabling the device to capture still images or moving videos, play music or video files, provide data communication, and receive broadcast and television signals.\",\n \"Height reduction and interference reduction: the scheme introduces various antenna structures and configurations to reduce the overall height of the antenna module and minimize interference between antennas with different polarizations. this includes offsetting the via pad and via by a certain distance, using a metal strip and a via, and arranging different polarization antennas vertically and horizontally.\"]</us>"
description: Technical Approach Paragraph
P100MaterialPatentPumResponse:
type: object
properties:
data:
type: array
example: no sample
description: response data
items:
$ref: '#/components/schemas/P100MaterialPatentPum_MaterialPatentPumResponse'
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
P101MaterialMaterialOntologyRequest:
type: object
P066HighValueDataPatentClassificationDescriptionRequest:
type: object
properties:
code:
type: string
example: C08G69/32
description: patent classification code, character length <= 150. Batch requests needs to be <= 10 classification codes, and separated by English commas
replace_by_merge:
type: integer
format: int32
example: 1
description: 'When the current patent classification type is ipc or cpc, should historical data be used as a substitute? Default substitution: 1: Yes 0: No.'
type:
type: string
example: ipc
description: 'patent classification type, character length <= 5<p>enumeration value: ipc, cpc, upc, gbc, loc, fi, fterm</p>'
required:
- code
- type
P063PatentIntelligentAttachedImage_PatentImage:
type: object
properties:
parts:
type: array
example:
- x1: 128
x2: 147
y1: 956
y2: 980
code: '52'
representive_label_txt: person
description: intelligent figure information
items:
$ref: '#/components/schemas/P063PatentIntelligentAttachedImage_Part'
storage_path:
type: string
example: https://data-fulltext-image.zhihuiya.com/CN/A/11/17/19/99/1/HDA0002418999840000011.png
description: storage path
P025HighValueDataTechProblemAndBenefitSummary_TechProblemSummaryResp:
type: object
properties:
pn:
type: string
example: <cn>CN102681224A</cn><us>US20230139460A1</us>
description: Patent number
lang:
type: string
example: <cn>cn</cn><us>en</us>
description: language
patent_id:
type: string
example: <cn>ef7d1252-2e0e-40c3-a44f-1bc1c86b7990</cn><us>767a81fb-8abb-45e4-b9fe-4bbc327dc586</us>
description: Patent id
patsnap_title:
type: string
example: <cn>通过将清洁构件的运动与喷嘴火焰和进料过程步骤同步,系统可以防止存款形成和开裂,从而解决了消除气体燃烧器系统中的效率低下和维护挑战,从而提高了组件寿命和过程效率。</cn><us>By synchronizing the movement of the cleaning member with the nozzle flame and feed process steps, the system prevents deposit formation and cracking, addressing the inefficiencies and maintenance challenges in gas abatement burner systems, thereby improving component lifespan and process efficiency.</us>
description: Patsnap Patent title
benefit_summary:
$ref: '#/components/schemas/P025HighValueDataTechProblemAndBenefitSummary_BenefitSummary'
tech_problem_summary:
$ref: '#/components/schemas/P025HighValueDataTechProblemAndBenefitSummary_TechProblemSummary'
technical_approach_summary:
$ref: '#/components/schemas/P025HighValueDataTechProblemAndBenefitSummary_TechnicalApproachSummary'
P022HighValueDataSeicClassification_SeicClassificationSub:
type: object
properties:
seic_no:
type: string
example: 1.1
description: Strategic emerging industry classification id
seic_desc:
type: string
example: 下一代信息网络产业
description: Strategic emerging industry classification
P100MaterialPatentPum_MaterialPpiDetail:
type: object
properties:
section:
type: string
example: claim
description: section
raw_unit:
type: string
example: μm
description: unit
raw_property:
type: string
example: 粒径
description: material property name
measurement_max:
type: number
format: double
example: 200
description: measurement max
measurement_min:
type: number
format: double
example: 5
description: measurement min
P102MaterialMaterialSubstance_MaterialSubstanceResponse:
type: object
properties:
pn:
type: string
example: CN113769175B
description: patent publication number
patent_id:
type: string
example: 05da3d4e-6f13-4005-9a2d-0645d2554cbf
description: patent id
substance_lable:
type: array
example: substanceLable
description: material substance info
items:
$ref: '#/components/schemas/P102MaterialMaterialSubstance_MaterialSubstanceLable'
P063PatentIntelligentAttachedImage_PdfImage2:
type: object
properties:
parts:
type: array
example:
- x1: 128
x2: 147
y1: 956
y2: 980
code: '52'
representive_label_txt: person
description: intelligent figure information
items:
$ref: '#/components/schemas/P063PatentIntelligentAttachedImage_Part'
patent_id:
type: string
example: 8d83d36c-02d4-411c-8912-21fa3272abff
description: patent ID
storage_path:
type: string
example: https://data-fulltext-image.zhihuiya.com/CN/A/11/17/19/99/1/HDA0002418999840000011.png
description: storage path
fig_title_code:
type: string
example: 1
description: figure title code
P103MaterialMaterialSpum_MaterialSpumDetail:
type: object
properties:
ppi_id:
type: integer
format: int32
example: 17010571
description: material property id
section:
type: string
example: claims
description: section
raw_unit:
type: string
example: min
description: material property raw unit
unit_offset:
type: array
example:
- end: 155
text: min
start: 152
description: material property unit offset range
items:
$ref: '#/components/schemas/P103MaterialMaterialSpum_MaterialOffset'
raw_property:
type: string
example: 时间
description: material property name
substance_id:
type: string
example: 8eb8c62a-9d2f-4c1b-953d-dcf142a10a21
description: material substance id
raw_substance:
type: string
example: 聚乙烯醇
description: material substance name
measurement_max:
type: number
format: double
example: 599.37
description: material property measurement max
measurement_min:
type: number
format: double
example: 59.937
description: material property measurement min
raw_measurement:
type: string
example: 1.0~10.0
description: material property raw measurement
substance_offset:
type: array
example:
- end: 95
text: 聚乙烯醇
start: 92
description: material substance offset range
items:
$ref: '#/components/schemas/P103MaterialMaterialSpum_MaterialOffset'
measurement_offset:
type: array
example:
- end: 152
text: 1-10
start: 148
description: material property measurement offset range
items:
$ref: '#/components/schemas/P103MaterialMaterialSpum_MaterialOffset'
P064BasicPatentDataPatentEnhancedData_PatentEnhancedPublication:
type: object
properties:
pn:
type: string
example: US11205304B2
description: patent number
pbdt:
type: integer
format: int32
example: 20230815
description: Publication Date
P064BasicPatentDataPatentEnhancedData_PatentEnhancedClaim:
type: object
properties:
lang:
type: string
example: CN
description: language
claim_text:
type: string
example: '<div class=\"indep-clm\" num=\"1\"><s
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/patsnap/refs/heads/main/openapi/patsnap-patent-mining-data-api-openapi.yml