What is the endpoint for [B005]Single Sequence All Patent List?

The [B005]Single Sequence All Patent List endpoint is POST https://connect.patsnap.com/bio-openapi/sequence/patent.

What data can [B005]Single Sequence All Patent List return?

[B005]Single Sequence All Patent List Get all patents of single sequence by seq_id. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B005]Single Sequence All Patent List?

The OpenAPI schema is available at /openapi.json#/paths/~1bio-openapi~1sequence~1patent/post. You can also browse the full specification at /openapi.json.

[B005]Single Sequence All Patent List

post

https://connect.patsnap.com/bio-openapi/sequence/patent

Try in Sandbox

Get all patents of single sequence by seq_id.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`page` Required	`integer<int32>`	`1`	Current page number, start from 1
`seq_id` Required	`string`	`834879`	Sequence ID
`size` Required	`integer<int32>`	`10`	Current page result size, support maximum 100

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`total`	`integer<int32>`	`1000`	Total patent count of the sequence
`patents`	`array`	`Please check the form: OpenApiPatentDetail`	Patent List
`pn`	`string`	`JP1999068462A`	Patent publication number
`claimed`	`boolean`	`true`	Whether the subject sequence is in patent claims
`location`	`object`	`{ "APP": [ "5" ], "FIG": [ "1A" ], "PAGE": [ "55/56" ], "ANNEX": [ "2" ], "TABLE": [ "A-1" ], "EXAMPLE": [ "8" ] }`	Sequence location in patent
`patent_id`	`string`	`94ea8785-959f-47cf-aba2-091605d30c12`	Patent ID
`sequence_id_number`	`array`	`[ "1" ]`	Sequence ID number in patent
`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": {
    "total": 1000,
    "patents": [
      {
        "pn": "JP1999068462A",
        "claimed": true,
        "location": {
          "APP": [
            "5"
          ],
          "FIG": [
            "1A"
          ],
          "PAGE": [
            "55/56"
          ],
          "ANNEX": [
            "2"
          ],
          "TABLE": [
            "A-1"
          ],
          "EXAMPLE": [
            "8"
          ]
        },
        "patent_id": "94ea8785-959f-47cf-aba2-091605d30c12",
        "sequence_id_number": [
          "1"
        ]
      }
    ]
  },
  "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