Patsnap Drug Clinical Trial Data API
Drug Clinical Trial Data APIs.
Drug Clinical Trial Data APIs.
openapi: 3.2.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:
B023ClinicalTrialRelatedEntityResponse:
type: object
properties:
data:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_GetClinicalTrialRelatedEntityResponseDto'
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
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_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'
B023ClinicalTrialRelatedEntity_CommonTarget:
type: object
properties:
target_id:
type: string
example: 1c2067e5ab054a8995f73efcfcf56207
description: Target ID
short_name:
type: array
example:
- lang: EN
name: VEGF
description: Target Short Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_CommonName'
display_name:
type: array
example:
- lang: EN
name: Vascular endothelial growth factor
- lang: CN
name: 血管内皮生长因子
description: Target Full Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B023ClinicalTrialRelatedEntity_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
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
B048CtResultGroup_AppPhsCtGroupEntityDto:
type: object
properties:
group_id:
type: string
example: e2e088e8e8aeda8aa2a2924ee3a59828
description: Clinical trial result group id
group_type:
type: string
example: outcome_group
description: Clinical trial result group type
ct_result_id:
type: string
example: 5adee5585028aaa5da5982d22a808a99
description: Clinical trial result id
characteristic:
type: array
example:
- name: Tocilizumab
type: drug
description: Clinical trial result grouping characteristics and medication plan
items:
$ref: '#/components/schemas/B048CtResultGroup_CharacteristicDto'
participant_number:
type: string
example: 7
description: Clinical trial result group participant number
B048CtResultGroup_ResultDto:
type: object
properties:
pct:
type: string
example: 20
description: Evaluation result ratio
value:
type: string
example: 5080
description: Evaluation result value
spread:
type: string
example: 108.5
description: Evaluation result spread
group_id:
type: string
example: e2e088e8e8aeda8aa2a2924ee3a59828
description: Evaluation result group id
lower_value:
type: string
example: 0.1
description: Evaluation result lower Value
upper_value:
type: string
example: 0.5
description: Evaluation result upper Value
participant_analyzed:
type: string
example: 7
description: Evaluation result participants count
participant_analyzed_units:
type: string
example: Participants
description: Evaluation result participants count units
B027ClinicalTrialContact_CentralContact:
type: object
properties:
name:
type: string
example: Xiao Ming, PHD
description: Name
email:
type: string
example: xxx@patsnap.com
description: Email
phone:
type: string
example: 15012341234
description: Phone
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
B026ClinicalTrialDesign_ArmIntervention:
type: object
properties:
intervention:
type: array
example:
- intervention_name: BL-B01D1
intervention_type: Drug
intervention_description: Administration by intravenous infusion for a cycle of 3 weeks.
- intervention_name: Osimertinib Mesylate Tablets
intervention_type: Drug
intervention_description: Oral administration, 80mg daily for a cycle of 3 weeks.
description: Intervention
items:
$ref: '#/components/schemas/B026ClinicalTrialDesign_ArmInterventionIntervention'
design_group_type:
type: string
example: Experimental
description: Design Group Type
design_group_title:
type: string
example: BL-B01D1+Osimertinib Mesylate Tablets
description: Design Group Title
design_group_description:
type: string
example: Participants receive BL-B01D1+Osimertinib Mesylate Tablets in the first cycle (3 weeks). Participants with clinical benefit could receive additional treatment for more cycles. The administration will be terminated because of disease progression or intolerable toxicity occurring or other reasons.
description: Design Group Description
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
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
B022ClinicalTrialDetail_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
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
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
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
B048CtResultGroupResponse:
type: object
properties:
data:
$ref: '#/components/schemas/B048CtResultGroup_AppPhsCtResultEndPointDto'
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
B048CtResultGroup_AppPhsCtResultEndPointDto:
type: object
properties:
groups:
type: array
example:
- group_id: 854d42290a95a38d05d90422e5392822
group_type: outcome_group
ct_result_id: a452da8e32d890452d5ea82ee823d8e5
characteristic:
- name: Tocilizumab
type: drug
description: Group information
items:
$ref: '#/components/schemas/B048CtResultGroup_AppPhsCtGroupEntityDto'
outcome_measures:
type: array
example:
- name: CRP levels
measure_id: M1
result_list:
- value: '4.6'
group_id: 854d42290a95a38d05d90422e5392822
ct_result_id: a452da8e32d890452d5ea82ee823d8e5
display_name:
- lang: EN
name: CRP levels
- lang: CN
name: CRP levels
outcome_order: 1
unit_of_measure: mg/L
description: Outcome measure information
items:
$ref: '#/components/schemas/B048CtResultGroup_AppPhsCtOutcomeMeasureEntityDto'
outcome_measure_safety:
type: array
example:
- name: CRP levels
measure_id: M1
result_list:
- value: '4.6'
group_id: 854d42290a95a38d05d90422e5392822
ct_result_id: a452da8e32d890452d5ea82ee823d8e5
display_name:
- lang: EN
name: CRP levels
- lang: CN
name: CRP levels
outcome_order: 1
unit_of_measure: mg/L
description: Outcome measure information - safety
items:
$ref: '#/components/schemas/B048CtResultGroup_AppPhsCtOutcomeMeasureEntityDto'
outcome_measure_efficacy:
type: array
example:
- name: CRP levels
measure_id: M1
result_list:
- value: '4.6'
group_id: 854d42290a95a38d05d90422e5392822
ct_result_id: a452da8e32d890452d5ea82ee823d8e5
display_name:
- lang: EN
name: CRP levels
- lang: CN
name: CRP levels
outcome_order: 1
unit_of_measure: mg/L
description: Outcome measure information - efficacy
items:
$ref: '#/components/schemas/B048CtResultGroup_AppPhsCtOutcomeMeasureEntityDto'
B023ClinicalTrialRelatedEntity_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_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_CommonTarget:
type: object
properties:
target_id:
type: string
example: 1c2067e5ab054a8995f73efcfcf56207
description: Target ID
short_name:
type: array
example:
- lang: EN
name: VEGF
description: Target Short Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
display_name:
type: array
example:
- lang: EN
name: Vascular endothelial growth factor
- lang: CN
name: 血管内皮生长因子
description: Target Full Name, Referencing "CommonName"
items:
$ref: '#/components/schemas/B032CtResultDetail_CommonName'
B023ClinicalTrialRelatedEntity_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/B023ClinicalTrialRelatedEntity_CommonName'
B026ClinicalTrialDesign_GetClinicalTrialDesignResponseDto:
type: object
properties:
masking:
type: string
example: None (Open Label)
description: Masking
outcome:
type: array
example:
- title: Recommended Phase II Dose (RP2D)
time_frame: Up to approximately 24 months
description: 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.
outcome_type: Primary
- title: Objective response rate (ORR)
time_frame: Up to approximately 24 months
description: ORR is defined as the percentage of participants, who has a CR (disappearance of all target lesions) or PR (at least a 30% decrease in the sum of diameters of target lesions). The percentage of participants who experiences a confirmed CR or PR is according to RECIST 1.1.
outcome_type: Primary
description: Outcome Measures
items:
$ref: '#/components/schemas/B026ClinicalTrialDesign_Outcome'
allocation:
type: string
example: N/A
description: Allocation
enrollment:
type: array
example:
- enrollment: '40'
description: Enrollment
items:
$ref: '#/components/schemas/B026ClinicalTrialDesign_Enrollment'
start_date:
$ref: '#/components/schemas/B026ClinicalTrialDesign_DateItem'
study_type:
type: string
example: Interventional
description: 'Study Type, enumeration values: "Prevention", "Expanded Access", "Health Services Research", "Interventional", "Diagnosis", "Cause", "Observational", "Basic Science", "Unknown", "Others"'
completion_date:
$ref: '#/components/schemas/B026ClinicalTrialDesign_DateItem'
primary_purpose:
type: string
example: Treatment
description: Primary Purpose
register_number:
type: string
example: NCT06498986
description: Trial Number
arm_intervention:
type: array
example:
- intervention:
- intervention_name: BL-B01D1
intervention_type: Drug
intervention_description: Administration by intravenous infusion for a cycle of 3 weeks.
- intervention_name: Osimertinib Mesylate Tablets
intervention_type: Drug
intervention_description: Oral administration, 80mg daily for a cycle of 3 weeks.
design_group_type: Experimental
design_group_title: BL-B01D1+Osimertinib Mesylate Tablets
design_group_description: Participants receive BL-B01D1+Osimertinib Mesylate Tablets in the first cycle (3 weeks). Participants with clinical benefit could receive additional treatment for more cycles. The administration will be terminated because of disease progression or intolerable toxicity occurring or other reasons.
description: Arms and Interventions
items:
$ref: '#/components/schemas/B026ClinicalTrialDesign_ArmIntervention'
clinical_trial_id:
type: string
example: 202425a889e52ae802432a8295220e53
description: Clinical Trial ID
first_posted_date:
type: integer
format: int64
example: 1720742400000
description: First Posted Date
intervention_model:
type: string
example: Single Group Assignment
description: Intervention Model
primary_completion_date:
$ref: '#/components/schemas/B026ClinicalTrialDesign_DateItem'
B025ClinicalTrialEligibility_GetClinicalTrialEligibilityResponseDto:
type: object
properties:
gender:
type: string
example: All
description: Sexes
max_age:
$ref: '#/components/schemas/B025ClinicalTrialEligibility_Age'
min_age:
$ref: '#/components/schemas/B025ClinicalTrialEligibility_Age'
register_number:
type: string
example: NCT06498986
description: Trial Number
exclude_criteria:
type: string
example: <ul><li>1. Patients with prior systemic therapy;</li><li>2. Previous treatment with EGFR-TKI;</li><li>3. Participants who participated in any other clinical trial within 4 weeks before the trial dose;</li><li>4. Traditional Chinese medicine (TCM) which had received radiotherapy within 4 weeks before the first use of the study drug and had anti-tumor indications within 2 weeks before the first use of the study drug;</li><li>5. Had undergone major surgery within 4 weeks before the first dose;</li><li>6. History of severe heart disease or cerebrovascular disease;</li><li>7. Unstable thrombotic events requiring therapeutic intervention within 6 months before screening; Infusion-related thrombosis was excluded;</li><li>8. QT prolongation, complete left bundle branch block, III degree atrioventricular block, frequent and uncontrollable arrhythmia;</l
# --- 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