What is the endpoint for [L001]Literature Search?

The [L001]Literature Search endpoint is POST https://connect.patsnap.com/search/literature/query-search.

Where can I find the OpenAPI schema for [L001]Literature Search?

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

[L001]Literature Search

Q: What data can [L001]Literature Search return?

[L001]Literature Search returns and query our global literature database by entering the title, abstract, author, and other details of the literature. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/search/literature/query-search

Try in Sandbox

Search and query our global literature database by entering the title, abstract, author, and other details of the literature.

Note: A single call supports a maximum of 20 results and allows the use of an offset to retrieve later results. The maximum length for supported search text is 800 characters.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`date_time`	`string`	`[1714521600000 TO 1748011043000]`	Publication timestamp range
`limit`	`integer<int32>`	`10`	limit of returned response; must be <= 1,00
`offset`	`integer<int32>`	-	offset value; limit + offset <= 10000
`query_text`	`string`	`title:(car) and author:("haiyang") and abstract:(car) and publication:(car) and date_time:[1714521600000 TO 1748011043000]`	You can search and query our global literature repository by entering document titles, abstracts, authors, and other metadata. Maximum Search Text Length: 800 characters. Support logic connector AND/OR Supported Search Fields: title: Document title abstract: Document abstract author: Author name date_time: Publication timestamp range publication: Journal name author Parameters need to be enclosed in double quotation marks
`text`	`string`	`Journal of Personalized Medicine`	The text input for literature search.
`type`	`string`	`publication`	Supported text types for literature include： title: (literature title) abstract：(literature abstract) author：(literature author) publication：(literature publication) title/abstract：(literature title or abstract) all：(the above fields)

Request Example

Example request body for this API endpoint

JSON

{
  "text": "Journal of Personalized Medicine",
  "type": "publication",
  "limit": 10,
  "offset": 0,
  "date_time": "[1714521600000 TO 1748011043000]",
  "query_text": "title:(car) and author:(\"haiyang\") and abstract:(car) and publication:(car) and date_time:[1714521600000 TO 1748011043000]"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`results`	`array`	`LiteratureBaseResponse`	result
`doi`	`string`	`10.3390/jpm13121685`	DOI
`title`	`array`	`[ "Variability in Provider Assessment of Sepsis and Potential of Host Response Technology to Address this Dilemma—Results of an Online Delphi Study" ]`	Title
`author`	`array`	`[ "Kraus, Chadd K", "O'Neal, Hollis R", "Ledeboer, Nathan A", "Rice, Todd W", "Self, Wesley H" ]`	Author
`paper_id`	`string`	`938ad823-46f7-485b-959d-610a767e5a6e`	Paper ID
`result_count`	`integer<int32>`	`10`	Received result count
`total_search_result_count`	`integer<int32>`	`7113`	Total search result 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": {
    "results": [
      {
        "doi": "10.3390/jpm13121685",
        "title": [
          "Variability in Provider Assessment of Sepsis and Potential of Host Response Technology to Address this Dilemma—Results of an Online Delphi Study"
        ],
        "author": [
          "Kraus, Chadd K",
          "O'Neal, Hollis R",
          "Ledeboer, Nathan A",
          "Rice, Todd W",
          "Self, Wesley H"
        ],
        "paper_id": "938ad823-46f7-485b-959d-610a767e5a6e"
      }
    ],
    "result_count": 10,
    "total_search_result_count": 7113
  },
  "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