Patsnap Drug Clinical Trial Data API
Drug Clinical Trial Data APIs.
Drug Clinical Trial Data APIs.
openapi: 3.1.0
info:
title: Patsnap Open Platform AI Translation Drug Clinical Trial 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: Drug Clinical Trial Data
description: Drug Clinical Trial Data APIs.
paths:
/synapse/clinical-trial/contact:
get:
operationId: b027ClinicalTrialContact
summary: B027 Clinical trial contact
description: Obtain clinical trial contact through clinical trial id or registry number
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b027 clinical trial contact response.
content:
application/json:
schema:
$ref: '#/components/schemas/B027ClinicalTrialContactResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/clinical-trial/contact
parameters:
- name: clinical_trial_id
in: query
required: false
description: Clinical trial id, obtain this through clinical trial search interface
schema:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical trial id, obtain this through clinical trial search interface
- name: register_number
in: query
required: false
description: register number
schema:
type: string
example: NCT06498986
description: register number
/synapse/clinical-trial/description:
get:
operationId: b024ClinicalTrialDescription
summary: B024 Clinical trial description
description: Obtain clinical trial description through clinical trial id or registry number
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b024 clinical trial description response.
content:
application/json:
schema:
$ref: '#/components/schemas/B024ClinicalTrialDescriptionResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/clinical-trial/description
parameters:
- name: clinical_trial_id
in: query
required: false
description: Clinical trial id, obtain this through clinical trial search interface
schema:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical trial id, obtain this through clinical trial search interface
- name: register_number
in: query
required: false
description: register number
schema:
type: string
example: NCT06498986
description: register number
/synapse/clinical-trial/detail:
get:
operationId: b022ClinicalTrialDetail
summary: B022 Clinical trial basic information
description: Obtain clinical trial basic information through clinical trial id or registry number
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b022 clinical trial basic information response.
content:
application/json:
schema:
$ref: '#/components/schemas/B022ClinicalTrialDetailResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/clinical-trial/detail
parameters:
- name: clinical_trial_id
in: query
required: false
description: Clinical trial id, obtain this through clinical trial search interface
schema:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical trial id, obtain this through clinical trial search interface
- name: register_number
in: query
required: false
description: Register number
schema:
type: string
example: NCT06498986
description: Register number
/synapse/clinical-trial/design:
get:
operationId: b026ClinicalTrialDesign
summary: B026 Clinical trial design
description: Obtain clinical trial design through clinical trial id or registry number
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b026 clinical trial design response.
content:
application/json:
schema:
$ref: '#/components/schemas/B026ClinicalTrialDesignResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/clinical-trial/design
parameters:
- name: clinical_trial_id
in: query
required: false
description: Clinical trial id, obtain this through clinical trial search interface
schema:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical trial id, obtain this through clinical trial search interface
- name: register_number
in: query
required: false
description: register number
schema:
type: string
example: NCT06498986
description: register number
/synapse/clinical-trial/eligibility:
get:
operationId: b025ClinicalTrialEligibility
summary: B025 Clinical trial eligibility
description: Obtain clinical trial eligibility through clinical trial id or registry number
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b025 clinical trial eligibility response.
content:
application/json:
schema:
$ref: '#/components/schemas/B025ClinicalTrialEligibilityResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/clinical-trial/eligibility
parameters:
- name: clinical_trial_id
in: query
required: false
description: Clinical trial id, obtain this through clinical trial search interface
schema:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical trial id, obtain this through clinical trial search interface
- name: register_number
in: query
required: false
description: register number
schema:
type: string
example: NCT06498986
description: register number
/synapse/clinical-trial/related-entity:
get:
operationId: b023ClinicalTrialRelatedEntity
summary: B023 Clinical trial related entity
description: Obtain clinical trial related entity through clinical trial id or registry number
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b023 clinical trial related entity response.
content:
application/json:
schema:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntityResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/clinical-trial/related-entity
parameters:
- name: clinical_trial_id
in: query
required: false
description: Clinical trial id, obtain this through clinical trial search interface
schema:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical trial id, obtain this through clinical trial search interface
- name: register_number
in: query
required: false
description: register number
schema:
type: string
example: NCT06498986
description: register number
/synapse/ct-result/detail:
get:
operationId: b032CtResultDetail
summary: B032 Drug clinical result basic information
description: Obtain clinical result data through clinical result ID
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b032 drug clinical result basic information response.
content:
application/json:
schema:
$ref: '#/components/schemas/B032CtResultDetailResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/ct-result/detail
parameters:
- name: ct_result_id
in: query
required: false
description: Clinical trial result ID, obtain this through clinical result search interface
schema:
type: string
example: e8ea588d3590e929a8022420da25d555
description: Clinical trial result ID, obtain this through clinical result search interface
/synapse/ct-result/group:
get:
operationId: b048CtResultGroup
summary: B048 Drug clinical result group information
description: Obtain clinical result group data through clinical result ID
tags:
- Drug Clinical Trial Data
security:
- bearerAuth: []
responses:
'200':
description: Successful b048 drug clinical result group information response.
content:
application/json:
schema:
$ref: '#/components/schemas/B048CtResultGroupResponse'
'401':
description: Unauthorized.
'403':
description: Forbidden.
'404':
description: Not Found.
externalDocs:
description: API Reference documentation
url: https://open.patsnap.com/devportal/api-reference/synapse/ct-result/group
parameters:
- name: ct_result_id
in: query
required: false
description: 临床结果ID,通过临床结果检索接口获取
schema:
type: string
example: 5adee5585028aaa5da5982d22a808a99
description: 临床结果ID,通过临床结果检索接口获取
components:
schemas:
B024ClinicalTrialDescription_CommonCountry:
type: object
properties:
country_id:
type: string
example: 676de5ba-893a-36bb-8683-c93306aaf769
description: Country/Location ID
alpha2_code:
type: string
example: US
description: Alpha Code
display_name:
type: array
example:
- lang: EN
name: United States
- lang: CN
name: 美国
description: Country/Location Name
items:
$ref: '#/components/schemas/B024ClinicalTrialDescription_CommonName'
B027ClinicalTrialContactResponse:
type: object
properties:
data:
$ref: '#/components/schemas/B027ClinicalTrialContact_GetClinicalTrialContactResponseDto'
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
B024ClinicalTrialDescription_CommonName:
type: object
properties:
lang:
type: string
example: EN
description: Language
name:
type: string
example: Ranibizumab (Genentech)
description: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
B032CtResultDetail_StudyDesignDto:
type: object
properties:
masking:
type: string
example: XXXX
description: Masking
allocation:
type: string
example: XXXX
description: Allocation
primary_purpose:
type: string
example: XXXX
description: Primary Purpose
intervention_model:
type: string
example: XXXX
description: Intervention Model
allocation_normalized:
$ref: '#/components/schemas/B032CtResultDetail_CommonDictionary'
intervention_model_normalized:
$ref: '#/components/schemas/B032CtResultDetail_CommonDictionary'
B026ClinicalTrialDesign_Outcome:
type: object
properties:
title:
type: string
example: Recommended Phase II Dose (RP2D)
description: Measure
time_frame:
type: string
example: Up to approximately 24 months
description: Time Frame
description:
type: string
example: The RP2D is defined as the dose level chosen by the sponsor (in consultation with the investigators) for phase II study, based on safety, tolerability, efficacy, PK, and PD data collected during the dose escalation study of BL-B01D1.
description: Description
outcome_type:
type: string
example: Primary
description: Outcome Type
B022ClinicalTrialDetail_CommonDictionary:
type: object
properties:
display_name:
type: array
example:
- lang: EN
name: Autologous CAR-T
- lang: CN
name: 自体CAR-T
description: Dict Name
items:
$ref: '#/components/schemas/B022ClinicalTrialDetail_CommonName'
normalized_id:
type: string
example: 2fbfdb3e92d942c48cbb0adb79f23526
description: Dict ID
B022ClinicalTrialDetailResponse:
type: object
properties:
data:
$ref: '#/components/schemas/B022ClinicalTrialDetail_GetClinicalTrialBasicInformationResponseDto'
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
B023ClinicalTrialRelatedEntity_GetClinicalTrialRelatedEntityResponseDto:
type: object
properties:
target:
type: array
example:
- target_id: 928facc8122849baa0dc00759cff0380
short_name:
- lang: EN
name: KRAS G12C
display_name:
- lang: EN
name: GTPase KRas G12C
- lang: CN
name: KRAS G12C突变
description: Targets
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonTarget'
condition:
type: array
example:
- Non-small Cell Lung Cancer
description: Original indications
control_drug:
type: array
example:
- drug_id: 79c4211933534056b4a84db1766df362
display_name:
- lang: EN
name: Osimertinib mesylate
- lang: CN
name: 甲磺酸奥希替尼
description: Control Drug
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonDrug'
organization:
type: array
example:
- display_name:
- lang: EN
name: Sichuan Baili Pharmaceuticals Co.,Ltd
- lang: CN
name: 四川百利药业有限责任公司
organization_id: 685e5cad5351555103932a4c484281c2
description: Sponsor/Collaborator
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonOrganization'
register_number:
type: string
example: NCT06498986
description: Trial Number
clinical_trial_id:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical Trial ID
condition_disease:
type: array
example:
- disease_id: 6c9886cb25eb45faba70292cee1f5518
display_name:
- lang: EN
name: Locally Advanced Lung Non-Small Cell Carcinoma
- lang: CN
name: 局部晚期非小细胞肺癌
description: Indications
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonDisease'
main_experimentation_drug:
type: array
example:
- drug_id: 79c4211933534056b4a84db1766df362
display_name:
- lang: EN
name: Osimertinib mesylate
- lang: CN
name: 甲磺酸奥希替尼
description: Experimental Drug
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonDrug'
B022ClinicalTrialDetail_GetClinicalTrialBasicInformationResponseDto:
type: object
properties:
phase:
$ref: '#/components/schemas/B022ClinicalTrialDetail_CommonDictionary'
brief_title:
type: string
example: A Study of BL-B01D1 in Combination With Osimertinib Mesylate Tablets in Patients With Locally Advanced or Metastatic Non-small Cell Lung Cancer
description: Trial Title
data_source:
type: string
example: CTGOV
description: 'Registry, enumeration values: WHO, CTGOV, CTR'
official_title:
type: string
example: A Phase II Clinical Study to Evaluate the Efficacy and Safety of BL-B01D1 in Combination With Osimertinib Mesylate Tablets in Patients With Locally Advanced or Metastatic Non-small Cell Lung Cancer
description: Official Title
register_number:
type: string
example: NCT06498986
description: Trial Number
clinical_trial_id:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical Trial ID
recruitment_status:
type: string
example: Not yet recruiting
description: Recruitment Status
B023ClinicalTrialRelatedEntity_CommonOrganization:
type: object
properties:
display_name:
type: array
example:
- lang: EN
name: Roche Holding AG
- lang: CN
name: 罗氏
description: Organization Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonName'
organization_id:
type: string
example: 87bfaf037f8e60c9e25595cd98bb27e4
description: Organization ID
B048CtResultGroup_CommonName:
type: object
properties:
lang:
type: string
example: EN
description: Language
name:
type: string
example: Ranibizumab (Genentech)
description: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
B032CtResultDetail_CommonDictionary:
type: object
properties:
display_name:
type: array
example:
- lang: EN
name: Autologous CAR-T
- lang: CN
name: 自体CAR-T
description: Dict Name
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
normalized_id:
type: string
example: 2fbfdb3e92d942c48cbb0adb79f23526
description: Dict ID
B032CtResultDetail_CommonMechanismAction:
type: object
properties:
short_name:
type: array
example:
- lang: EN
name: KRAS G12C inhibitors
- lang: CN
name: KRAS G12C抑制剂
description: Mechanism Action Short Name
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
display_name:
type: array
example:
- lang: EN
name: GTPase KRas G12C inhibitors
- lang: CN
name: KRAS G12C突变抑制剂
description: Mechanism Action Name
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
mechanism_id:
type: string
example: 27c0848a265e4332836e10d0e8202b4c
description: Mechanism Action ID
B032CtResultDetail_CommonDisease:
type: object
properties:
disease_id:
type: string
example: 06a9082fe1ec4c97bea31d888b9cfdce
description: Disease ID
display_name:
type: array
example:
- lang: EN
name: Uveitic Macular Edema
- lang: CN
name: 葡萄膜炎黄斑水肿
description: Disease Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
B032CtResultDetail_CommonEntity:
type: object
properties:
id:
type: string
example: 11acf267a4fc42f392751e023482aac3
description: ID
display_name:
type: array
example:
- lang: EN
name: CTNNB1 Mutation
description: Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
B032CtResultDetail_CommonOrganization:
type: object
properties:
display_name:
type: array
example:
- lang: EN
name: Roche Holding AG
- lang: CN
name: 罗氏
description: Organization Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
organization_id:
type: string
example: 87bfaf037f8e60c9e25595cd98bb27e4
description: Organization ID
B025ClinicalTrialEligibilityResponse:
type: object
properties:
data:
$ref: '#/components/schemas/B025ClinicalTrialEligibility_GetClinicalTrialEligibilityResponseDto'
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
B027ClinicalTrialContact_GetClinicalTrialContactResponseDto:
type: object
properties:
central_contact:
type: array
example:
- name: Sa Xiao, PHD
email: xiaosa@baili-pharm.com
phone: '15013238943'
description: Contact
items:
$ref: '#/components/schemas/B027ClinicalTrialContact_CentralContact'
register_number:
type: string
example: NCT06498986
description: Trial Number
clinical_trial_id:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical Trial ID
B026ClinicalTrialDesign_Enrollment:
type: object
properties:
location:
type: string
example: Domestic
description: Location. 'Domestic' means China.
enrollment:
type: string
example: 98
description: Enrollment
enrollment_text:
type: string
example: 国内:150
description: Enrollment Original Value
enrollment_type:
type: string
example: Anticipated
description: Enrollment Type
B024ClinicalTrialDescription_GetClinicalTrialResearchDescriptionResponseDto:
type: object
properties:
country:
type: array
example:
- country_id: 5a365096-b2a6-31cb-acdf-1de1f5ab3abe
alpha2_code: CN
display_name:
- lang: EN
name: China
- lang: CN
name: 中国
description: Country/Location
items:
$ref: '#/components/schemas/B024ClinicalTrialDescription_CommonCountry'
brief_summary:
type: string
example: This phase II clinical study is a study to explore the efficacy and safety of BL-B01D1 in combination with Osimertinib Mesylate Tablets in patients with histologically and/or cytologically confirmed locally advanced or metastatic non-small cell lung cancer.
description: Brief
register_number:
type: string
example: NCT06498986
description: Trial Number
clinical_trial_id:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical Trial ID
detailed_description:
type: string
example: This phase II clinical study is a study to explore the efficacy and safety of BL-B01D1 in combination with Osimertinib Mesylate Tablets in patients with histologically and/or cytologically confirmed locally advanced or metastatic non-small cell lung cancer.
description: Detailed
B026ClinicalTrialDesign_DateItem:
type: object
properties:
time_ts:
type: integer
format: int64
example: 1785542400000
description: Timestamp
date_type:
type: string
example: Anticipated
description: 'Date Type, enumeration values: Anticipated, Actual'
B032CtResultDetail_CommonDrug:
type: object
properties:
drug_id:
type: string
example: e82b83b42eba4e5ea3f26f8e06081a5a
description: Drug ID
display_name:
type: array
example:
- lang: EN
name: Ranibizumab (Genentech)
- lang: CN
name: 雷珠单抗
description: Drug Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
B032CtResultDetail_RelatedId:
type: object
properties:
id_type:
type: string
example: study_identifier
description: ID type, study_identifier:Trial Code
id_value:
type: string
example: DESTINY-Breast04
description: value
B032CtResultDetail_GetClinicalTrialResultResponseDto:
type: object
properties:
drug:
type: array
example:
- drug_id: 2838b95ade834c96b17ac8bcd2b68c27
display_name:
- lang: EN
name: Sotorasib
- lang: CN
name: 索托拉西布
description: Drug
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonDrug'
phase:
$ref: '#/components/schemas/B032CtResultDetail_CommonDictionary'
title:
type: string
example: Matching-Adjusted Indirect Treatment Comparisons (MAIC) of Sotorasib 960mg (soto960) Plus Panitumumab (pani) Vs. Trifluridine/Tipiracil(T/T) Plus Bevacizumab (bev) in Chemorefractory Metastatic Colorectal Cancer (mCRC)
description: title
target:
type: array
example:
- target_id: 8556307199154d34b1f9bc9685f2ec47
short_name:
- lang: EN
name: IL-6RA
display_name:
- lang: EN
name: Interleukin-6 receptor alpha subunit
- lang: CN
name: 白细胞介素-6受体α亚基
description: Target
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonTarget'
biomarker:
type: array
example:
- id: 11acf267a4fc42f392751e023482aac3
display_name:
- lang: EN
name: CTNNB1 Mutation
description: Biomarker Id
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonEntity'
conclusion:
type: string
example: Sotorasib-panitumumab demonstrated acceptable safety with promising efficacy in chemotherapy-refractory KRASG12C-mutated metastatic colorectal cancer.
description: Conclusion
related_id:
type: array
example:
- id_type: study_identifier
id_value: CodeBreaK 300
description: Study code
items:
$ref: '#/components/schemas/B032CtResultDetail_RelatedId'
ct_result_id:
type: string
example: 5400a5a2dee3da90dd52408a3585d805
description: Clinical Trial Result Id
organization:
type: array
example:
- display_name:
- lang: EN
name: Amgen, Inc.
- lang: CN
name: 安进股份有限公司
organization_id: 11ef8a9e8bf5ca80213a1183511cded3
description: Organization master entity id view
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonOrganization'
study_design:
$ref: '#/components/schemas/B032CtResultDetail_StudyDesignDto'
therapy_type:
type: array
example:
- display_name:
- lang: EN
name: Third line
- lang: CN
name: 三线
normalized_id: 62662f0b1d5b3fafabeb571a211e9a31
description: Therapy type view
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonDictionary'
published_time:
type: integer
format: int64
example: 1719446400000
description: Publication Date
register_number:
type: array
example:
- NCT05198934
description: Register number
single_or_multi:
type: string
example: single_drug
description: Single or multi, options:single_drug,multiple_drugs
mechanism_action:
type: array
example:
- short_name:
- lang: EN
name: IL-6RA antagonists
- lang: CN
name: IL-6RA拮抗剂
display_name:
- lang: EN
name: Interleukin-6 receptor alpha subunit antagonists
- lang: CN
name: 白细胞介素-6受体α亚基拮抗剂
mechanism_id: b30a0bdb2e0bd9c03a908a84588c4217
description: Mechanism Action
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonMechanismAction'
therapeutic_area:
type: array
example:
- disease_id: 042cbe45c973477b957717ded29ef7b6
display_name:
- lang: EN
name: Nervous System Diseases
- lang: CN
name: 神经系统疾病
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/patsnap/refs/heads/main/openapi/patsnap-drug-clinical-trial-data-api-openapi.yml