What is the endpoint for [B062]Extract Single Patent Sequence?

The [B062]Extract Single Patent Sequence endpoint is POST https://connect.patsnap.com/bio-openapi/patent/extract/single.

Where can I find the OpenAPI schema for [B062]Extract Single Patent Sequence?

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

[B062]Extract Single Patent Sequence

Q: What data can [B062]Extract Single Patent Sequence return?

[B062]Extract Single Patent Sequence Extract all sequences from a single patent and provide the total count, sequence numbers, sequence codes, and sequence details. Present the information in a paginated format. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/bio-openapi/patent/extract/single

Try in Sandbox

Extract all sequences from a single patent and provide the total count, sequence numbers, sequence codes, and sequence details. Present the information in a paginated format.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`extract_type` Required	`string`	`EXTRACT_ALL`	Extract Type(EXTRACT_ALL、EXTRACT_RANGE、EXTRACT_NUM、EXTRACT_MANUAL)
`page` Required	`integer<int32>`	`1`	Current page number, start from 1
`patent_id`	`string`	`d10f8044-d3b9-4b53-b27f-b0f4fe9092cd`	Patent ID
`patent_number`	`string`	`WO2004050828A2`	Patent publication number. One of patent_number、patent_id must be filled in, and if they are filled in at the same time, patent_id shall prevail, followed by patent_number
`sequence_length`	`object`	`{ "end": 200, "start": 50 }`	Sequence Length Range
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`sequence_no_range` Required	`string`	`1-10`	SEQ ID range(Example:1-10,23,24)
`sequence_type`	`string`	`PROTEIN`	Sequence Type, PROTEIN or NUCLEOTIDE
`size` Required	`integer<int32>`	`10`	Current page result size, support maximum 100

Request Example

Example request body for this API endpoint

JSON

{
  "page": 1,
  "size": 10,
  "patent_id": "d10f8044-d3b9-4b53-b27f-b0f4fe9092cd",
  "extract_type": "EXTRACT_ALL",
  "patent_number": "WO2004050828A2",
  "sequence_type": "PROTEIN",
  "sequence_length": {
    "end": 100,
    "start": 0
  },
  "sequence_no_range": "1-10"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`total`	`integer<int32>`	`1000`	Query Results Count
`results`	`array`	`Please check the form: OpenApiExtractHit`	Query Results
`s_len`	`integer<int32>`	`123`	Subject sequence length
`seq_id`	`string`	`834879`	Sequence ID
`location`	`object`	`{ "APP": [ "5" ], "FIG": [ "1A" ], "PAGE": [ "55/56" ], "ANNEX": [ "2" ], "TABLE": [ "A-1" ], "EXAMPLE": [ "8" ] }`	Sequence location in patent
`s_sequence`	`string`	`MQPDLHSRALAAHTLHQFRTLSPLTHCMTNEVVQSFTANTLLALGASPAMVIEPEEASQFAAIASALLVNVGTLTQERATAMRAAVERAYHAKTPWTLDPVAVGALEFRRRFCLDLLSLQPAA`	Subject sequence
`sequence_type`	`string`	`PROTEIN`	Sequence Type, PROTEIN or NUCLEOTIDE
`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,
    "results": [
      {
        "s_len": 123,
        "seq_id": 834879,
        "location": {
          "APP": [
            "5"
          ],
          "FIG": [
            "1A"
          ],
          "PAGE": [
            "55/56"
          ],
          "ANNEX": [
            "2"
          ],
          "TABLE": [
            "A-1"
          ],
          "EXAMPLE": [
            "8"
          ]
        },
        "s_sequence": "MQPDLHSRALAAHTLHQFRTLSPLTHCMTNEVVQSFTANTLLALGASPAMVIEPEEASQFAAIASALLVNVGTLTQERATAMRAAVERAYHAKTPWTLDPVAVGALEFRRRFCLDLLSLQPAA",
        "sequence_type": "PROTEIN",
        "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
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!
`67200007`	Exceeded the call limit, call failed!
`67200008`	apiKey not Pass and call failed.
`67200009`	apiKey not match Token and call failed.

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`53000001`	Invalid parameter.
`53000003`	Server internal exception.

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms