openapi: 3.1.0
info:
title: Patsnap Open Platform AI Translation Patent Basic 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 Basic Data
description: Patent Basic Data APIs.
paths:
/basic-patent-data/abstract-image:
get:
operationId: p021BasicPatentDataAbstractImage
summary: P021 Abstract Image
description: Receive patent abstract image data (the image from front page) by patent_id or patent_number. Patent abstract data includes abstract image number and abstract image URL path.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p021 abstract image response.
content:
application/json:
schema:
$ref: '#/components/schemas/P021BasicPatentDataAbstractImageResponse'
'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/abstract-image
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 077f4978-092c-4522-bc98-e8257a5c99f9,6e5c550d-28d6-4cf1-a265-b5488996b641,52ee4f52-3edc-4e41-854e-c76dd8b7d14f
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN3307359D,CN303649457S,CN104169186A
description: patent_number
/basic-patent-data/pdf-data:
get:
operationId: p020BasicPatentDataPdfData
summary: P020 PDF
description: Receive patent PDF document pathway by patent_id or patent_number.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p020 pdf response.
content:
application/json:
schema:
$ref: '#/components/schemas/P020BasicPatentDataPdfDataResponse'
'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/pdf-data
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"
/basic-patent-data/backward-citation:
get:
operationId: p015BasicPatentDataBackwardCitation
summary: P015 Cited By Patents
description: Receive patent backward citation data by patent_id or patent_number. Patent backward citation data includes backward citation number, backward citation count for simple family, INPADOC family and PatSnap family.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p015 cited by patents response.
content:
application/json:
schema:
$ref: '#/components/schemas/P015BasicPatentDataBackwardCitationResponse'
'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/backward-citation
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 000d6583-2f77-42e0-999d-9aa9ecc5b94e
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: DE3106419A1
description: patent_number
/basic-patent-data/simple-legal-status:
get:
operationId: p041BasicPatentDataSimpleLegalStatus
summary: P041 Simple Legal Status
description: Receive simple legal status data by patent_id or patent_number. Simple Legal Status data includes Active, Pending, Inactive, Undetermined, PCT designated period, PCT designated expiration. For more details please view the full list of fields in the developer document.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p041 simple legal status response.
content:
application/json:
schema:
$ref: '#/components/schemas/P041BasicPatentDataSimpleLegalStatusResponse'
'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/simple-legal-status
parameters:
- 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
/basic-patent-data/fulltext-image:
post:
operationId: p042BasicPatentDataFulltextImage
summary: P042 Fulltext Image
description: Receive patent fulltext image data by patent_id or patent_number. Patent fulltext data includes fulltext image type and fulltext image URL path.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p042 fulltext image response.
content:
application/json:
schema:
$ref: '#/components/schemas/P042BasicPatentDataFulltextImageResponse'
'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/basic-patent-data/fulltext-image
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/P042BasicPatentDataFulltextImageRequest'
/advanced-patent-data/forward-citation:
get:
operationId: p016AdvancedPatentDataForwardCitation
summary: P016 Patent Citation
description: Receive detailed forward citation data patent_id or patent_number. This includes citation type, citation source, citation category, reference DOI, title, author, and publication.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p016 patent citation response.
content:
application/json:
schema:
$ref: '#/components/schemas/P016AdvancedPatentDataForwardCitationResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/advanced-patent-data/forward-citation
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 4ad45196-06ed-4bef-b5d5-ac2ff2b6032c,314b8a88-3877-4bf4-9461-f501f94876bd
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: US10071304B2
description: patent_number
/basic-patent-data/legal-status:
get:
operationId: p013BasicPatentDataLegalStatus
summary: P013 Patent Legal Status
description: Receive legal status data by patent_id or patent_number. Legal status data includes simple legal status, legal status and event status. For more details please view the fields description in the developer document.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p013 patent legal status response.
content:
application/json:
schema:
$ref: '#/components/schemas/P013BasicPatentDataLegalStatusResponse'
'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/legal-status
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: b54b4e0c-c0f5-4cf6-9ede-36394a7e2f0b
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: US20220119699A9
description: patent_number
/basic-patent-data/claim-data:
get:
operationId: p018BasicPatentDataClaimData
summary: P018 Claim
description: Receive patent claim data by patent_id or patent_number. Patent claim data includes claim text, number of claims and independent claims.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p018 claim response.
content:
application/json:
schema:
$ref: '#/components/schemas/P018BasicPatentDataClaimDataResponse'
'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/claim-data
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
- name: replace_by_related
in: query
required: false
description: "When the claims of current patent is unavailable, whether to replace it with the claims of its family patent？default not to replace: \n 1. Yes\n 0: No"
schema:
type: integer
format: int32
example: '0'
description: "When the claims of current patent is unavailable, whether to replace it with the claims of its family patent？default not to replace: \n 1. Yes\n 0: No"
/basic-patent-data/bibliography:
get:
operationId: p012BasicPatentDataBibliography
summary: P012 Biblio
description: Receive patent bibliography data by patent_id or patent_number. Patent bibliography data includes a total of 100+ fields, including application information, applicant information and agency information. For more details please view the full list of fields in the developer document.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p012 biblio response.
content:
application/json:
schema:
$ref: '#/components/schemas/P012BasicPatentDataBibliographyResponse'
'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/bibliography
parameters:
- 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
/basic-patent-data/patent-family:
get:
operationId: p014BasicPatentDataPatentFamily
summary: P014 Patent Family
description: Receive patent family data by patent_id or patent_number. Patent family data includes simple, INPADOC, and PatSnap family authority, family members and count.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p014 patent family response.
content:
application/json:
schema:
$ref: '#/components/schemas/P014BasicPatentDataPatentFamilyResponse'
'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-family
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 1a47a70d-6b54-4709-a72a-ed552781fcac
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: JP1999068462A
description: patent_number
/basic-patent-data/simple-bibliography:
get:
operationId: p011BasicPatentDataSimpleBibliography
summary: P011 Simple Biblio
description: Receive patent basic bibliography data by patent_id or patent_number. For more details please view the full list of fields in the developer document.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p011 simple biblio response.
content:
application/json:
schema:
$ref: '#/components/schemas/P011BasicPatentDataSimpleBibliographyResponse'
'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/simple-bibliography
parameters:
- 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
/basic-patent-data/abstract-data-translated:
get:
operationId: p043BasicPatentDataAbstractDataTranslated
summary: P043 Abstract (Translated)
description: Receive patent translated title and abstract by patent_id or patent_number (support Chinese, English, Japanese).
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p043 abstract (translated) response.
content:
application/json:
schema:
$ref: '#/components/schemas/P043BasicPatentDataAbstractDataTranslatedResponse'
'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/abstract-data-translated
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: 1a47a70d-6b54-4709-a72a-ed552781fcac,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN101595528B
description: patent_number
- name: replace_by_related
in: query
required: false
description: 'When the abstract of current patent is unavailable, whether to replace it with the abstract of its family patent？default not to replace: 1. Yes 0: No'
schema:
type: integer
format: int32
example: '0'
description: 'When the abstract of current patent is unavailable, whether to replace it with the abstract of its family patent？default not to replace: 1. Yes 0: No'
/basic-patent-data/description-data:
get:
operationId: p019BasicPatentDataDescriptionData
summary: P019 Description
description: Receive patent description data by patent_id or patent_number. Patent description data includes the Technical field, Background Art, Summary of Invention, Brief Description of Drawings and Description of Embodiments.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p019 description response.
content:
application/json:
schema:
$ref: '#/components/schemas/P019BasicPatentDataDescriptionDataResponse'
'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/description-data
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: 1a47a70d-6b54-4709-a72a-ed552781fcac,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: JP1999068462A
description: patent_number
- name: replace_by_related
in: query
required: false
description: "When the description of current patent is unavailable, whether to replace it with the description of its family patent？default not to replace: \n 1. Yes\n 0: No"
schema:
type: integer
format: int32
example: '0'
description: "When the description of current patent is unavailable, whether to replace it with the description of its family patent？default not to replace: \n 1. Yes\n 0: No"
/basic-patent-data/claim-data-translated:
get:
operationId: p044BasicPatentDataClaimDataTranslated
summary: P044 Claim (Translated)
description: Receive patent translated claims by patent_id or patent_number (support Chinese, English, Japanese)
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p044 claim (translated) response.
content:
application/json:
schema:
$ref: '#/components/schemas/P044BasicPatentDataClaimDataTranslatedResponse'
'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/claim-data-translated
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: 1a47a70d-6b54-4709-a72a-ed552781fcac,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN101595528B
description: patent_number
- name: replace_by_related
in: query
required: false
description: 'When the claims of current patent is unavailable, whether to replace it with the claims of its family patent？default not to replace: 1. Yes 0: No'
schema:
type: integer
format: int32
example: '0'
description: 'When the claims of current patent is unavailable, whether to replace it with the claims of its family patent？default not to replace: 1. Yes 0: No'
/basic-patent-data/description-data-translated:
get:
operationId: p045BasicPatentDataDescriptionDataTranslated
summary: P045 Description (Translated)
description: Receive patent translated description by patent_id or patent_number (support Chinese, English, Japanese)
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p045 description (translated) response.
content:
application/json:
schema:
$ref: '#/components/schemas/P045BasicPatentDataDescriptionDataTranslatedResponse'
'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/description-data-translated
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: 1a47a70d-6b54-4709-a72a-ed552781fcac,7353c607-0594-4592-b99e-aea9f517de17
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN101595528B
description: patent_number
- name: replace_by_related
in: query
required: false
description: 'When the description of current patent is unavailable, whether to replace it with the description of its family patent？default not to replace: 1. Yes 0: No'
schema:
type: integer
format: int32
example: '0'
description: 'When the description of current patent is unavailable, whether to replace it with the description of its family patent？default not to replace: 1. Yes 0: No'
/basic-patent-data/fulltext-inline-image:
get:
operationId: p042BasicPatentDataFulltextInlineImage
summary: P042 Fulltext Inline Image
description: Receive patent fulltext image data by patent_id or patent_number. Patent fulltext data includes fulltext image type and fulltext image URL path.
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p042 fulltext inline image response.
content:
application/json:
schema:
$ref: '#/components/schemas/P042BasicPatentDataFulltextInlineImageResponse'
'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/fulltext-inline-image
parameters:
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: fdbca633-63df-4c0b-8597-3f6c5e3a2748
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: CN116420141A
description: patent_number
/basic-patent-data/description-offset:
get:
operationId: p073BasicPatentDataDescriptionOffset
summary: P073 Fulltext navigation location information
description: 'The text paragraph location information of a specific patent can be queried by entering "patent_id" or "patent_number". The paragraph includes: technical field, background technology, invention content, attached drawing description, specific implementation plan, etc.'
tags:
- Patent Basic Data
security:
- bearerAuth: []
responses:
'200':
description: Successful p073 fulltext navigation location information response.
content:
application/json:
schema:
$ref: '#/components/schemas/P073BasicPatentDataDescriptionOffsetResponse'
'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/description-offset
parameters:
- name: lang
in: query
required: false
description: text language，Only EN, CN, JP, KR, and TW are supported.default EN
schema:
type: string
example: EN
description: text language，Only EN, CN, JP, KR, and TW are supported.default EN
- name: patent_id
in: query
required: false
description: patent_id
schema:
type: string
example: f3deb1dd-fd57-4bbb-85c4-6820be90b853
description: patent_id
- name: patent_number
in: query
required: false
description: patent_number
schema:
type: string
example: US9800501B2
description: patent_number
components:
schemas:
P012BasicPatentDataBibliography_PatentTitle:
type: object
properties:
lang:
type: string
example: EN
description: language
text:
type: string
example: Systems and methods for rendering user interfaces for augmented or virtual reality
description: text
data_format:
type: string
example: original
description: 'Original data: if there are several languages with original data, all will be returned'
P012BasicPatentDataBibliography_PriorityClaims:
type: object
properties:
date:
type: integer
format: int32
example: 20211221
description: 'dates: publication, applicaton, priority .etc<p>YYYYMMDD format</p>'
country:
type: string
example: US
description: authority
doc_number:
type: string
example: 62/012273
description: doc number
P073BasicPatentDataDescriptionOffset_PatentDescOffsetSection:
type: object
properties:
section_name:
$ref: '#/components/schemas/P073BasicPatentDataDescriptionOffset_PatentDescOffsetSectionName'
section_content:
$ref: '#/components/schemas/P073BasicPatentDataDescriptionOffset_PatentDescOffsetSectionContent'
P019BasicPatentDataDescriptionData_PatentDescriptionResponse:
type: object
properties:
pn:
type: string
example: JP1999068462A
description: patent number
patent_id:
type: string
example: 1a47a70d-6b54-4709-a72a-ed552781fcac
description: patent id
pn_related:
type: string
example: JP2004266582A
description: patent number of related patent (provided only if the substitute is made using the text of the same family patent)
description:
type: array
example: 'Please check the form: Description'
description: description
items:
$ref: '#/components/schemas/P019BasicPatentDataDescriptionData_PatentDescriptionNew'
P015BasicPatentDataBackwardCitation_PatentCited:
type: object
properties:
cited_by_3y:
type: integer
format: int32
example: 0
description: Count of cited by patents within 3 years
cited_by_5y:
type: integer
format: int32
example: 2
description: Count of cited by patents within 5 years
cited_by_patents:
type: array
example: 'Please check the form: CitedByPatents'
description: cited by patents
items:
$ref: '#/components/schemas/P015BasicPatentDataBackwardCitation_CitedByPatents'
cited_by_simple_family:
type: integer
format: int32
example: 2
description: Simple family backward citation count
cited_by_inpadoc_family:
type: integer
format: int32
example: 2
description: INPADOC family backward citation count
cited_by_patsnap_family:
type: integer
format: int32
example: 2
description: PATSNAP family backward citation count
P042BasicPatentDataFulltextInlineImage_FulltextInlineImage:
type: object
properties:
path:
type: string
example: https://open.patsnap.co
# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/patsnap/refs/heads/main/openapi/patsnap-patent-basic-data-api-openapi.yml