What is the endpoint for [B004]Normal Sequence Search?

The [B004]Normal Sequence Search endpoint is POST https://connect.patsnap.com/bio-openapi/sequence/job.

What data can [B004]Normal Sequence Search return?

[B004]Normal Sequence Search returns sequences with key information. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B004]Normal Sequence Search?

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

[B004]Normal Sequence Search

post

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

Try in Sandbox

Search sequences with key information.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`database`	`array`	`[ "ALLPATENT" ]`	Target Sequence Database,ALLPATENT (default) : Sequence published in patent title/abstract/claims/description;CLAIMS : Sequence published in patent claims;NONPATENT : Sequence published in non-patent publications
`limit` Required	`integer<int32>`	`1000`	Maximum returned results of each query, support maximum 10,000
`params` Required	`object`	`Please check the form: OpenApiBlastParameter`	Blast Parameters
`algorithm` Required	`string`	`blastn-short`	Blast algorithm. nucleotide searching nucleotide uses megablast, blastn or blastn-short. nucleotide searching protein uses blastx-fast. protein searching protein uses blastp, blastp-fast or blastp-short. protein searching nucleotide uses tblastn-fast.
`evalue`	`number<float>`	`100`	The higher you set this e-value threshold, the more results you are likely to see.E-Value indicates how likely it is that a sequence is similar to yours simply by chance. For instance, if your sequence is very short, there is a higher likelihood that it appears in several locations simply by chance. The greater the e-value, the more likely it is that this is just down to luck.
`filter`	`object`	`Please check the form: OpenApiFilterParameter`	Search filter parameters
`perc_identity`	`object`	`OpenApiBlastParameter`	Filter by alignment identity
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`q_perc_identity`	`object`	`OpenApiBlastParameter`	Filter by query sequence alignment identity
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`qcov_hsp_perc`	`object`	`OpenApiBlastParameter`	Filter by query sequence coverage
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`s_perc_identity`	`object`	`OpenApiBlastParameter`	Filter by subject sequence alignment identity
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`scov_hsp_perc`	`object`	`OpenApiBlastParameter`	Filter by subject sequence coverage
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`subject_length`	`object`	`OpenApiBlastParameter`	Filter by subject sequence length
`end`	`integer<int32>`	`100`	End value
`start`	`integer<int32>`	-	Start value
`with_gaps`	`boolean`	-	Matching with or without gaps indicates whether or not you want your sequence alignment to include gaps.
`word_size`	`integer<int32>`	`4`	Length of initial exact match. For nucleotide searching nucleotide valid word sizes are >= 4, others are 2-7. With smaller word size, the matching will be more exact, but the time cost will be longer.
`query_type` Required	`string`	`NUCLEOTIDE`	Target Sequence Type. NUCLEOTIDE,PROTEIN
`sequence_list` Required	`array`	`Please check the form: OpenApiRequestSequenceInfo`	Query Sequence, support single input query
`label`	`string`	`SEQ1`	User provided sequence label
`sequence`	`string`	`GGGAGGCTAAGGCAGGAG`	User provided sequence
`sequence_type` Required	`string`	`NUCLEOTIDE`	Query Sequence Type. NUCLEOTIDE,PROTEIN

Request Example

Example request body for this API endpoint

JSON

{
  "limit": 1000,
  "params": {
    "evalue": 100,
    "filter": {
      "perc_identity": {
        "end": 100,
        "start": 0
      },
      "qcov_hsp_perc": {
        "end": 100,
        "start": 0
      },
      "scov_hsp_perc": {
        "end": 100,
        "start": 0
      },
      "subject_length": {
        "end": 100,
        "start": 0
      },
      "q_perc_identity": {
        "end": 100,
        "start": 0
      },
      "s_perc_identity": {
        "end": 100,
        "start": 0
      }
    },
    "algorithm": "blastn-short",
    "with_gaps": false,
    "word_size": 4
  },
  "database": [
    "ALLPATENT"
  ],
  "query_type": "NUCLEOTIDE",
  "sequence_list": [
    {
      "label": "SEQ1",
      "sequence": "GGGAGGCTAAGGCAGGAG"
    }
  ],
  "sequence_type": "NUCLEOTIDE"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`label`	`string`	`SEQ1`	User provided sequence label
`job_id`	`string`	`953a406a18d84dc8b13f0b923e406a43`	ID of the search job in backend, use this ID for subsequent API calls
`sequence`	`string`	`GGGAGGCTAAGGCAGGAG`	User provided sequence
`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": [
    {
      "label": "SEQ1",
      "job_id": "953a406a18d84dc8b13f0b923e406a43",
      "sequence": "GGGAGGCTAAGGCAGGAG"
    }
  ],
  "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
`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