/ensembl/genes

POST /api/ensembl/genes

Price: 10 credits

Get an Ensembl gene by stable id or by symbol within a species

How to use it

Takes either an Ensembl stable id or a gene symbol. A stable id resolves on its own and `species` is ignored; a symbol is only meaningful inside one species, so set `species` whenever the input is not a stable id. A version suffix such as ENSG00000139618.19 is accepted and stripped. Transcript, translation and exon stable ids resolve here too and come back with `object_type` saying Transcript, Translation or Exon rather than Gene, so check that field before treating the answer as a gene; on those `parent_id` carries the feature one level up, the gene of a transcript or the transcript of a translation, which is how to walk back to the gene. `species` is echoed back as it was spelled, so an alias like `human` stays `human`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• gene string required — Ensembl stable id, with or without its version suffix, or a gene symbol (examples: "ENSG00000139618", "ENSG00000139618.19", "BRCA2", "ENST00000380152"; minLength: 1)
• species string — Ensembl species name, used when `gene` is a symbol (default: "homo_sapiens"; examples: "homo_sapiens", "mus_musculus", "danio_rerio"; minLength: 1)
• include_transcripts boolean — Also return the transcripts of the gene with their exons and translation (default: false)

Response

• @type string (default: "EnsemblGene")
• id string required
• display_name string (default: "")
• description string (default: "")
• biotype string (default: "")
• object_type string (default: "")
• species string (default: "")
• assembly_name string (default: "")
• seq_region_name string (default: "")
• start integer nullable
• end integer nullable
• strand integer nullable
• version integer nullable
• source string (default: "")
• logic_name string (default: "")
• db_type string (default: "")
• canonical_transcript string (default: "")
• parent_id string (default: "")
• length integer nullable
• is_canonical boolean nullable
• is_gencode_primary boolean nullable
• is_canonical_extended boolean nullable
• transcripts array (default: [])
  • @type string (default: "EnsemblTranscript")
  • id string (default: "")
  • display_name string (default: "")
  • gene_id string (default: "")
  • biotype string (default: "")
  • start integer nullable
  • end integer nullable
  • strand integer nullable
  • length integer nullable
  • version integer nullable
  • source string (default: "")
  • logic_name string (default: "")
  • seq_region_name string (default: "")
  • assembly_name string (default: "")
  • is_canonical boolean nullable
  • is_gencode_primary boolean nullable
  • is_canonical_extended boolean nullable
  • exons array (default: [])
    • @type string (default: "EnsemblExon")
    • id string (default: "")
    • start integer nullable
    • end integer nullable
    • strand integer nullable
    • version integer nullable
    • seq_region_name string (default: "")
  • translation object nullable
    • @type string (default: "EnsemblTranslation")
    • id string (default: "")
    • transcript_id string (default: "")
    • start integer nullable
    • end integer nullable
    • length integer nullable
    • version integer nullable
• url string (default: "")

Errors

• 422 — Unknown species 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 — Gene 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.