/genbank/sequences

POST /api/genbank/sequences

Price: 1 credit

Get a GenBank or RefSeq nucleotide record by accession or GI number

How to use it

Resolves a nucleotide record from NCBI's nuccore database. The accession may be versioned (NM_007300.4), unversioned (NM_007300, which resolves to the current version), lowercase, or the numeric GI number - all four forms return the same record. Protein, BioSample, BioProject and assembly accessions are not nucleotide records and do not resolve here. The nucleotide letters themselves are only returned when include_sequence is set, and only for shorter records; read `sequence_length` for the size in every case. Source organism qualifiers such as strain, host, isolation country and collection date arrive as `qualifiers` name/value pairs rather than as dedicated fields.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Nucleotide accession, with or without its version suffix, or the numeric GI number (examples: "NM_007300.4", "NM_007300", "NC_002695.2", "1677529721"; minLength: 1)
• include_sequence boolean — Also return the nucleotide sequence itself in the `sequence` field. It is returned only for records up to 1,000,000 bases; longer records keep `sequence` empty and report their size in `sequence_length` (default: false)

Response

• @type string (default: "GenbankSequence")
• id string required
• accession string (default: "")
• gi string (default: "")
• definition string (default: "")
• organism string (default: "")
• taxid string (default: "")
• sequence_length integer nullable
• molecule_type string (default: "")
• strandedness string (default: "")
• biomolecule string (default: "")
• topology string (default: "")
• completeness string (default: "")
• genome string (default: "")
• genetic_code string (default: "")
• source_database string (default: "")
• sequencing_technique string (default: "")
• strain string (default: "")
• biosample_accession string (default: "")
• bioproject_id string (default: "")
• assembly_accession string (default: "")
• assembly_gi string (default: "")
• qualifiers array (default: [])
  • @type string (default: "GenbankSequenceQualifier")
  • name string required
  • value string required
• is_indexed boolean (default: false)
• created_date string (default: "")
• updated_date string (default: "")
• sequence string (default: "")
• url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Sequence not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.