openapi: 3.1.0
info:
title: Patsnap Open Platform AI Translation Custom Aggregate 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: Custom Aggregate Data
description: Custom Aggregate Data APIs.
paths:
/search/patent/query-search-patent/v3:
post:
operationId: d005QuerySearchPatentV3
summary: D005 Patent 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, patent ID, etc
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d005 patent search response.
content:
application/json:
schema:
$ref: '#/components/schemas/D005QuerySearchPatentV3Response'
'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/v3
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D005QuerySearchPatentV3Request'
/shhgy/reportdata/life-cycle:
post:
operationId: d101ReportdataLifeCycle
summary: D101 life cycle data
description: This interface is a statistical analysis interface that provides the number of patent applications per year over the past 10 years, as well as the number of invention patent applications.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d101 life cycle data response.
content:
application/json:
schema:
$ref: '#/components/schemas/D101ReportdataLifeCycleResponse'
'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/shhgy/reportdata/life-cycle
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D101ReportdataLifeCycleRequest'
/basic-patent-data/patent-detail:
get:
operationId: d007BasicPatentDataPatentDetail
summary: D007 Patent Detail
description: Receive patent detail by patent_id or patent_number
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d007 patent detail response.
content:
application/json:
schema:
$ref: '#/components/schemas/D007BasicPatentDataPatentDetailResponse'
'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-detail
parameters:
- name: lang
in: query
required: false
description: translation language, support cn, en, jp
schema:
type: string
example: en
description: translation language, support cn, en, jp
- 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
- name: replace_by_related
in: query
required: false
description: "When the fulltext of current patent is unavailable, whether to replace it with the fulltext of its family patent？default not to replace: \n<p>1. Yes</p>\n<p>0: No </p>"
schema:
type: integer
format: int32
example: '0'
description: "When the fulltext of current patent is unavailable, whether to replace it with the fulltext of its family patent？default not to replace: \n<p>1. Yes</p>\n<p>0: No </p>"
/shhgy/reportdata/applicant-rank:
post:
operationId: d102ReportdataApplicantRank
summary: D102 Applicant ranking
description: This interface belongs to the statistical analysis interface, providing the names of the top 10 applicants and the number of patents
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d102 applicant ranking response.
content:
application/json:
schema:
$ref: '#/components/schemas/D102ReportdataApplicantRankResponse'
'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/shhgy/reportdata/applicant-rank
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D102ReportdataApplicantRankRequest'
/shhgy/reportdata/applicant-technology-analysis:
post:
operationId: d103ReportdataApplicantTechnologyAnalysis
summary: D103 Main applicant technology analysis
description: This interface belongs to the statistical analysis interface, providing the names of the top 10 applicants and the number of patents corresponding to the top 10 IPC main groups for each applicant
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d103 main applicant technology analysis response.
content:
application/json:
schema:
$ref: '#/components/schemas/D103ReportdataApplicantTechnologyAnalysisResponse'
'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/shhgy/reportdata/applicant-technology-analysis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D103ReportdataApplicantTechnologyAnalysisRequest'
/shhgy/reportdata/applicant-trend:
post:
operationId: d104ReportdataApplicantTrend
summary: D104 Main applicant application trend
description: This interface belongs to the statistical analysis interface, providing the names of the top 10 applicants and the number of patent applications for each year in the past 10 years
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d104 main applicant application trend response.
content:
application/json:
schema:
$ref: '#/components/schemas/D104ReportdataApplicantTrendResponse'
'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/shhgy/reportdata/applicant-trend
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D104ReportdataApplicantTrendRequest'
/shhgy/reportdata/cooperation-applicant-analysis:
post:
operationId: d105ReportdataCooperationApplicantAnalysis
summary: D105 Cooperation applicant analysis
description: This interface belongs to the statistical analysis interface, providing the names of the top 10 main applicants, the number of patent applications, and their cooperative applicants, the number of patent applications, and the number of cooperative patents
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d105 cooperation applicant analysis response.
content:
application/json:
schema:
$ref: '#/components/schemas/D105ReportdataCooperationApplicantAnalysisResponse'
'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/shhgy/reportdata/cooperation-applicant-analysis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D105ReportdataCooperationApplicantAnalysisRequest'
/shhgy/reportdata/patent-trend:
post:
operationId: d106ReportdataPatentTrend
summary: D106 Patent trend
description: This interface belongs to the statistical analysis interface, providing the number of patent applications, grants and grant rates in the past 10 years
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d106 patent trend response.
content:
application/json:
schema:
$ref: '#/components/schemas/D106ReportdataPatentTrendResponse'
'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/shhgy/reportdata/patent-trend
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D106ReportdataPatentTrendRequest'
/shhgy/reportdata/technology-applicant-distribution:
post:
operationId: d107ReportdataTechnologyApplicantDistribution
summary: D107 Technology applicant distribution
description: This interface belongs to the statistical analysis interface, providing the top 10 IPC main groups and the number of patents corresponding to the top 10 applicants for each IPC main group
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d107 technology applicant distribution response.
content:
application/json:
schema:
$ref: '#/components/schemas/D107ReportdataTechnologyApplicantDistributionResponse'
'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/shhgy/reportdata/technology-applicant-distribution
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D107ReportdataTechnologyApplicantDistributionRequest'
/shhgy/reportdata/technology-constitute:
post:
operationId: d108ReportdataTechnologyConstitute
summary: D108 Technology constitute
description: This interface belongs to the statistical analysis interface, providing the number of patents for the top 100 IPC subclasses
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d108 technology constitute response.
content:
application/json:
schema:
$ref: '#/components/schemas/D108ReportdataTechnologyConstituteResponse'
'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/shhgy/reportdata/technology-constitute
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D108ReportdataTechnologyConstituteRequest'
/shhgy/reportdata/rec-office-year:
post:
operationId: d110ReportdataRecOfficeYear
summary: D110 Receiving office statistics (by year)
description: This interface belongs to the statistical analysis interface, providing the number of patents for the top 100 receiving offices in the past 10 years
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d110 receiving office statistics (by year) response.
content:
application/json:
schema:
$ref: '#/components/schemas/D110ReportdataRecOfficeYearResponse'
'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/shhgy/reportdata/rec-office-year
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D110ReportdataRecOfficeYearRequest'
/shhgy/reportdata/refered-rank:
post:
operationId: d111ReportdataReferedRank
summary: D111 Citation ranking
description: This interface belongs to the statistical analysis interface, providing patent information for the top 20 most cited patents
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d111 citation ranking response.
content:
application/json:
schema:
$ref: '#/components/schemas/D111ReportdataReferedRankResponse'
'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/shhgy/reportdata/refered-rank
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D111ReportdataReferedRankRequest'
/shhgy/reportdata/rec-office:
post:
operationId: d109ReportdataRecOffice
summary: D109 Receiving office statistics
description: This interface belongs to the statistical analysis interface, providing the number of patents for the top 100 receiving offices
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d109 receiving office statistics response.
content:
application/json:
schema:
$ref: '#/components/schemas/D109ReportdataRecOfficeResponse'
'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/shhgy/reportdata/rec-office
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D109ReportdataRecOfficeRequest'
/shhgy/reportdata/famn-rank:
post:
operationId: d112ReportdataFamnRank
summary: D112 Patent family ranking
description: This interface belongs to the statistical analysis interface, providing patent information for the top 20 patents with the most family members
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d112 patent family ranking response.
content:
application/json:
schema:
$ref: '#/components/schemas/D112ReportdataFamnRankResponse'
'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/shhgy/reportdata/famn-rank
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D112ReportdataFamnRankRequest'
/shhgy/reportdata/patent-list:
post:
operationId: d113ReportdataPatentList
summary: D113 Patent list
description: This interface returns a list of patent information, supports paging query, returns up to 100 patent information per page. Up to 20,000 patent information can be returned
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d113 patent list response.
content:
application/json:
schema:
$ref: '#/components/schemas/D113ReportdataPatentListResponse'
'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/shhgy/reportdata/patent-list
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D113ReportdataPatentListRequest'
/shhgy/reportdata/domain-map:
post:
operationId: d115ReportdataDomainMap
summary: D115 Domain Map
description: This interface returns the image URL of technical composition
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d115 domain map response.
content:
application/json:
schema:
$ref: '#/components/schemas/D115ReportdataDomainMapResponse'
'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/shhgy/reportdata/domain-map
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D115ReportdataDomainMapRequest'
/shhgy/reportdata/patent-info:
post:
operationId: d114ReportdataPatentInfo
summary: D114 Patent field details (large text only)
description: This interface returns patent titles, abstracts, claims, and specifications, including original data sources, Chinese (with translation), and English (with translation). Supports batch queries with a limit of 100 items, request parameters are separated by English commas.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d114 patent field details (large text only) response.
content:
application/json:
schema:
$ref: '#/components/schemas/D114ReportdataPatentInfoResponse'
'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/shhgy/reportdata/patent-info
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D114ReportdataPatentInfoRequest'
/shhgy/reportdata/3d-map:
post:
operationId: d116Reportdata3dMap
summary: D116 3D Map Analysis
description: This interface returns the Top 100 IPC classifications, showing the number of patents and invalid patents for each applicant in each group.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d116 3d map analysis response.
content:
application/json:
schema:
$ref: '#/components/schemas/D116Reportdata3dMapResponse'
'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/shhgy/reportdata/3d-map
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D116Reportdata3dMapRequest'
/open-user/statement/v2:
post:
operationId: statementV2
summary: Statement of account V2
description: Support input time range to get API calls and billing information
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful statement of account v2 response.
content:
application/json:
schema:
$ref: '#/components/schemas/StatementV2Response'
'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/open-user/statement/v2
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StatementV2Request'
/basic-patent-data/patent-detail-aggregation:
get:
operationId: d301BasicPatentDataPatentDetailAggregation
summary: D301 patent details aggregation
description: Patent details can be batch-queried by entering patent_id or patent_number.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d301 patent details aggregation response.
content:
application/json:
schema:
$ref: '#/components/schemas/D301BasicPatentDataPatentDetailAggregationResponse'
'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-detail-aggregation
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 9cf648f8-8283-4767-9a14-f90f68303f3e
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN108977442B
description: patent_number
/jdf/patent_detail_text:
post:
operationId: d201JdfPatentDetailText
summary: D201 patent details text
description: This interface provides patent documentation details, legal status, and patent text, including background art, summary of invention, description of embodiments, first claim, independent claim, and technical elements
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d201 patent details text response.
content:
application/json:
schema:
$ref: '#/components/schemas/D201JdfPatentDetailTextResponse'
'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/jdf/patent_detail_text
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 9cf648f8-8283-4767-9a14-f90f68303f3e
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/D201JdfPatentDetailTextRequest'
/search/patent/query-search-patent-facet:
post:
operationId: d006PatentQuerySearchPatentFacet
summary: D006 Patent Search Facet
description: Search PatSnap's global patent database using standard text queries.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d006 patent search facet response.
content:
application/json:
schema:
$ref: '#/components/schemas/D006PatentQuerySearchPatentFacetResponse'
'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-facet
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D006PatentQuerySearchPatentFacetRequest'
/basic-patent-data/patent-pdf:
get:
operationId: d008BasicPatentDataPatentPdf
summary: D008 patent PDF
description: Receive patent PDF document pathway by patent_id or patent_number.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d008 patent pdf response.
content:
application/json:
schema:
$ref: '#/components/schemas/D008BasicPatentDataPatentPdfResponse'
'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-pdf
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 494407c3-459b-4c6b-8503-b5128cf0c07e,94365516-de3c-445b-aa73-dd8370887a2d,ddfc29cf-71c6-4bb3-b35b-10f256767152
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: EP2458380B1,CN3126351D,US20050262868A1
description: patent_number
- name: replace_by_related
in: query
required: false
description: "When the PDF of current patent is unavailable, whether to replace it with the PDF of its family patent？default not to replace: \n 1. Yes\n 0: No"
schema:
type: integer
format: int32
example: '0'
description: "When the PDF of current patent is unavailable, whether to replace it with the PDF of its family patent？default not to replace: \n 1. Yes\n 0: No"
/search/patent/query-search-facet:
post:
operationId: d010PatentQuerySearchFacet
summary: D010 Patent Facet
description: Search PatSnap's global patent database using standard text queries, and statistics by specified field dimension.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d010 patent facet response.
content:
application/json:
schema:
$ref: '#/components/schemas/D010PatentQuerySearchFacetResponse'
'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-facet
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D010PatentQuerySearchFacetRequest'
/search/patent/query-search-patent-detail:
post:
operationId: d009PatentQuerySearchPatentDetail
summary: D009 Patent Search Detail
description: Search PatSnap's global patent database using standard text queries. Returns the first patent detail and a list of 20 patents one patent forward or backward from the offset location.
tags:
- Custom Aggregate Data
security:
- bearerAuth: []
responses:
'200':
description: Successful d009 patent search detail response.
content:
application/json:
schema:
$ref: '#/components/schemas/D009PatentQuerySearchPatentDetailResponse'
'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-detail
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/D009PatentQuerySearchPatentDetailRequest'
components:
schemas:
D114ReportdataPatentInfo_PatentInfoResponse:
type: object
properties:
data:
typ
# --- truncated at 32 KB (240 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/patsnap/refs/heads/main/openapi/patsnap-custom-aggregate-data-api-openapi.yml