What is the endpoint for [B045] Medical Deal Search?

The [B045] Medical Deal Search endpoint is POST https://connect.patsnap.com/synapse/drug-deal/search.

What data can [B045] Medical Deal Search return?

[B045] Medical Deal Search Obtain drug deal search information about partner, principle, deal time, drug etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B045] Medical Deal Search?

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

[B045] Medical Deal Search

post

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

Try in Sandbox

Obtain drug deal search information about partner, principle, deal time, drug etc.

By default, the criteria involving organization, targets, disease, and drug types use a Roll-Up logic.

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": [ "dc5440fb07a44174930e2ee62c137e54" ], "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`	`[ "dc5440fb07a44174930e2ee62c137e54" ]`	Value List
`drug_type`	`object`	`{ "value": [ "1151dbc710f64a85923dc05d4a5a0ba9" ], "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`	`[ "1151dbc710f64a85923dc05d4a5a0ba9" ]`	Value List
`principle`	`object`	`{ "value": [ "e7655969b809388df5bfc8ffc865f3cc" ], "condition": "OR" }`	Principle 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`	`[ "e7655969b809388df5bfc8ffc865f3cc" ]`	Value List
`partner`	`object`	`{ "value": [ "8e9a09c415413dc4cd1c139b8fcb6993" ], "condition": "OR" }`	Partner 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`	`[ "8e9a09c415413dc4cd1c139b8fcb6993" ]`	Value List
`target`	`object`	`{ "value": [ "d9ded8f23b4140a5828314a55d2d66b4" ], "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`	`[ "d9ded8f23b4140a5828314a55d2d66b4" ]`	Value List
`mechanism_action`	`object`	`{ "value": [ "27c0848a265e4332836e10d0e8202b4c" ], "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`	`[ "27c0848a265e4332836e10d0e8202b4c" ]`	Value List
`drug_disease`	`object`	`{ "value": [ "62eaee6d9ee44410b8aca59dfc7408e9" ], "condition": "OR" }`	Drug 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`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	Value List
`deal_disease`	`object`	`{ "value": [ "62eaee6d9ee44410b8aca59dfc7408e9" ], "condition": "OR" }`	Deal 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`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	Value List
`highest_dev_status`	`array`	`[ "Phase_2_3" ]`	Highest Phase (Deal). 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" ]`	Country/Location. The value is an enum with the following values: US, JP, CN, EU, OTHER.
`deal_type`	`array`	`[ "License" ]`	Agreement Type. The value is an enum with the following values: Collaboration, License, Acquisition, Investment, Option
`amount_disclosure`	`boolean`	`true`	Amount Fully Disclosed
`deal_total_value`	`object`	`{ "to": 1000, "from": 500 }`	Total Payment, unit: million dollar, Referencing "LongRangeItem"
`from`	`integer<int64>`	`500`	from
`to`	`integer<int64>`	`1000`	to
`deal_upfront_payment`	`object`	`{ "to": 100, "from": 50 }`	Upfront Payment, unit: million dollar, Referencing "LongRangeItem"
`from`	`integer<int64>`	`50`	from
`to`	`integer<int64>`	`100`	to
`deal_milestone_payment`	`object`	`{ "to": 1000, "from": 500 }`	Milestone, unit: million dollar, Referencing "LongRangeItem"
`from`	`integer<int64>`	`500`	from
`to`	`integer<int64>`	`1000`	to
`deal_time`	`object`	`{ "to": 1754438399999, "from": 1659657600000 }`	Deal Date, using timestamp. Referencing "LongRangeItem"
`from`	`integer<int64>`	`1659657600000`	from
`to`	`integer<int64>`	`1754438399999`	to
`keyword`	`object`	`{ "value": [ "genentech" ], "condition": "OR" }`	Keyword, 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`	`[ "genentech" ]`	Value List
`sort`	`array`	`[ { "sort_field": "DEAL_TIME", "sort_order": "desc" }, { "sort_field": "TOTAL_VALUE", "sort_order": "desc" }, { "sort_field": "NORMALIZED_PHASE_SIGN_RANK_MAX", "sort_order": "desc" } ]`	Sorting fields. The value is an enum with the following values: DEAL_TIME, TOTAL_VALUE, NORMALIZED_PHASE_SIGN_RANK_MAX. The default sorting is by deal time, total value, and highest R&D phase, all in descending order. Referencing "SortDto"
`sort_field`	`string`	`DEAL_TIME`	sort field, enum values: DEAL_TIME, TOTAL_VALUE, NORMALIZED_PHASE_SIGN_RANK_MAX
`sort_order`	`string`	`desc`	sort order, support:desc,asc

Request Example

Example request body for this API endpoint

JSON

{
  "drug": {
    "value": [
      "dc5440fb07a44174930e2ee62c137e54"
    ],
    "condition": "OR"
  },
  "sort": [
    {
      "sort_field": "DEAL_TIME",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "offset": 0,
  "target": {
    "value": [
      "d9ded8f23b4140a5828314a55d2d66b4"
    ],
    "condition": "OR"
  },
  "country": [
    "US"
  ],
  "keyword": {
    "value": [
      "genentech"
    ],
    "condition": "OR"
  },
  "partner": {
    "value": [
      "8e9a09c415413dc4cd1c139b8fcb6993"
    ],
    "condition": "OR"
  },
  "deal_time": {
    "to": 1754438399999,
    "from": 1659657600000
  },
  "deal_type": [
    "License"
  ],
  "drug_type": {
    "value": [
      "1151dbc710f64a85923dc05d4a5a0ba9"
    ],
    "condition": "OR"
  },
  "principle": {
    "value": [
      "e7655969b809388df5bfc8ffc865f3cc"
    ],
    "condition": "OR"
  },
  "deal_disease": {
    "value": [
      "62eaee6d9ee44410b8aca59dfc7408e9"
    ],
    "condition": "OR"
  },
  "drug_disease": {
    "value": [
      "62eaee6d9ee44410b8aca59dfc7408e9"
    ],
    "condition": "OR"
  },
  "deal_total_value": {
    "to": 1000,
    "from": 500
  },
  "mechanism_action": {
    "value": [
      "27c0848a265e4332836e10d0e8202b4c"
    ],
    "condition": "OR"
  },
  "amount_disclosure": true,
  "highest_dev_status": [
    "Phase_2_3"
  ],
  "deal_upfront_payment": {
    "to": 100,
    "from": 50
  },
  "deal_milestone_payment": {
    "to": 1000,
    "from": 500
  }
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`items`	`array`	`Please check the form:DrugDealDetailDto`	Result Items
`deal_id`	`string`	`284929245a22a8a9e2ed5ee82ae52250`	Drug Deal ID
`deal_title`	`string`	`Janssen Enters Worldwide Collaboration and License Agreement with Chinese Company Legend Biotech to Develop Investigational CAR-T Anti-Cancer Therapy`	Drug Deal Title
`source_url`	`string`	`https://pipelinereview.com/index.php/2017122266940/More-News/Janssen-Enters-Worldwide-Collaboration-and-License-Agreement-with-Chinese-Company-Legend-Biotech-to-Develop-Investigational-CAR-T-Anti-Cancer-Therapy.html`	News link
`limit`	`integer<int64>`	`10`	limit
`total`	`integer<int64>`	`10`	total
`offset`	`integer<int64>`	-	offset
`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": [
      {
        "deal_id": "284929245a22a8a9e2ed5ee82ae52250",
        "deal_title": "Janssen Enters Worldwide Collaboration and License Agreement with Chinese Company Legend Biotech to Develop Investigational CAR-T Anti-Cancer Therapy",
        "source_url": "https://pipelinereview.com/index.php/2017122266940/More-News/Janssen-Enters-Worldwide-Collaboration-and-License-Agreement-with-Chinese-Company-Legend-Biotech-to-Develop-Investigational-CAR-T-Anti-Cancer-Therapy.html"
      }
    ],
    "limit": 10,
    "total": 10,
    "offset": 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