What is the endpoint for [B007] Drug search?

The [B007] Drug search endpoint is POST https://connect.patsnap.com/synapse/drug/search.

What data can [B007] Drug search return?

[B007] Drug search Obtain drugs through fields such as target, organization, disease, etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B007] Drug search?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1drug~1search/post. You can also browse the full specification at /openapi.json.

[B007] Drug search

post

https://connect.patsnap.com/synapse/drug/search

Try in Sandbox

Obtain drugs through fields such as target, organization, disease, etc.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`offset`	`integer<int64>`	-	Offset, default 0
`limit`	`integer<int64>`	`10`	Limit, default 10. offset + limit <= 10000， limit up to 1,000.
`drug`	`object`	`{ "value": [ "945fa31ebe9e41ae912e493aa3324576" ], "condition": "OR" }`	Drug, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	Value List
`target`	`object`	`{ "value": [ "9786d32e3d244a688ec6a60d2fe1b10b" ], "condition": "OR" }`	Target, The "condition" field defaults to OR and support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "9786d32e3d244a688ec6a60d2fe1b10b" ]`	Value List
`disease`	`object`	`{ "value": [ "3beea980d93a4cc0abc864e27514601c" ], "condition": "OR" }`	Indication, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "3beea980d93a4cc0abc864e27514601c" ]`	Value List
`organization`	`object`	`{ "value": [ "6a8c172f1efc649035845f94c31a9c1e" ], "condition": "OR" }`	Organization, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "6a8c172f1efc649035845f94c31a9c1e" ]`	Value List
`mechanism_action`	`object`	`{ "value": [ "4dd338b149b3ecd0ee860e1fb379b44f" ], "condition": "OR" }`	Mechanism, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "4dd338b149b3ecd0ee860e1fb379b44f" ]`	Value List
`drug_type`	`object`	`{ "value": [ "c38eb408d6b842f487d6a27484156633" ], "condition": "OR" }`	Drug Type, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "c38eb408d6b842f487d6a27484156633" ]`	Value List
`global_highest_dev_status`	`array`	`[ "Approved" ]`	Drug Highest Phase. The value is an enum with the following values: Discovery, Preclinical, IND, IND_Approval, Early_Phase_1, Phase_1, Phase_1_2, Phase_2, Phase_2_3, Phase_3, NDA_BLA, Approved, Clinical, Pending, Discontinued, Withdraw, Suspended, Unknown.
`exist_deal`	`boolean`	`true`	Whether Drug Deal Exist
`dev_status`	`array`	`[ "Approved" ]`	Phase(By Indication). The value is an enum with the following values: Discovery, Preclinical, IND, IND_Approval, Early_Phase_1, Phase_1, Phase_1_2, Phase_2, Phase_2_3, Phase_3, NDA_BLA, Approved, Clinical, Pending, Discontinued, Withdraw, Suspended, Unknown.
`country`	`array`	`[ "US", "EU" ]`	Phase(By Indication). The value is an enum with the following values: US, EU, JP, CN, Other
`organization_type`	`array`	`[ "Company" ]`	Organization Type. The value is an enum with the following values: Company, University_Institution, Other
`employee_number`	`array`	`[ "GREATER_THAN_500" ]`	Employee Number. The value is an enum with the following values: LESS_THAN_10, BETWEEN_10_AND_100, BETWEEN_100_AND_500, GREATER_THAN_500
`start_up`	`boolean`	-	Whether Start-Up Organization
`sort`	`array`	`[ { "sort_field": "DRUG_TYPE_SORT", "sort_order": "desc" }, { "sort_field": "GLOBAL_HIGHEST_DEV_STATUS_RANK", "sort_order": "desc" }, { "sort_field": "FIRST_APPROVED_DATE", "sort_order": "desc" } ]`	Field order, field can support: DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE; order can support:desc, asc (default desc)
`sort_field`	`string`	`DRUG_TYPE_SORT`	sort field, enum values: DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE
`sort_order`	`string`	`desc`	sort order, support:desc,asc

Request Example

Example request body for this API endpoint

JSON

{
  "drug": {
    "value": [
      "945fa31ebe9e41ae912e493aa3324576"
    ],
    "condition": "OR"
  },
  "sort": [
    {
      "sort_field": "DRUG_TYPE_SORT",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "offset": 0,
  "target": {
    "value": [
      "9786d32e3d244a688ec6a60d2fe1b10b"
    ],
    "condition": "OR"
  },
  "country": [
    "US",
    "EU"
  ],
  "disease": {
    "value": [
      "3beea980d93a4cc0abc864e27514601c"
    ],
    "condition": "OR"
  },
  "start_up": false,
  "drug_type": {
    "value": [
      "c38eb408d6b842f487d6a27484156633"
    ],
    "condition": "OR"
  },
  "dev_status": [
    "Approved"
  ],
  "exist_deal": true,
  "organization": {
    "value": [
      "6a8c172f1efc649035845f94c31a9c1e"
    ],
    "condition": "OR"
  },
  "employee_number": [
    "GREATER_THAN_500"
  ],
  "mechanism_action": {
    "value": [
      "4dd338b149b3ecd0ee860e1fb379b44f"
    ],
    "condition": "OR"
  },
  "organization_type": [
    "Company"
  ],
  "global_highest_dev_status": [
    "Approved"
  ]
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`items`	`array`	`Please check the form:DrugSummaryDto`	result items
`drug_id`	`string`	`11d208e0c26a4345946d95f92d9fcaf0`	Drug ID
`drug_name`	`array`	`[ { "lang": "CN", "name": "阿达格拉西" }, { "lang": "EN", "name": "Adagrasib" } ]`	Drug Name
`lang`	`string`	`EN`	Language
`name`	`string`	`Ranibizumab (Genentech)`	Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
`drug_type`	`array`	`[ { "display_name": [ { "lang": "EN", "name": "Small molecule drug" }, { "lang": "CN", "name": "小分子化药" } ], "normalized_id": "1151dbc710f64a85923dc05d4a5a0ba9" } ]`	drug type view
`display_name`	`array`	`[ { "lang": "EN", "name": "Autologous CAR-T" }, { "lang": "CN", "name": "自体CAR-T" } ]`	Dict Name
`normalized_id`	`string`	`2fbfdb3e92d942c48cbb0adb79f23526`	Dict ID
`limit`	`integer<int64>`	`10`	limit
`total`	`integer<int64>`	-	total
`offset`	`integer<int64>`	-	offset
`total_dev_status`	`integer<int64>`	-	Involved Dev Status Count
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "items": [
      {
        "drug_id": "11d208e0c26a4345946d95f92d9fcaf0",
        "drug_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ],
        "drug_type": [
          {
            "display_name": [
              {
                "lang": "EN",
                "name": "Ranibizumab (Genentech)"
              }
            ],
            "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
          }
        ]
      }
    ],
    "limit": 10,
    "total": 0,
    "offset": 0,
    "total_dev_status": 0
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms