/genbank/bioprojects

POST /api/genbank/bioprojects

Price: 1 credit

Get an NCBI BioProject record by accession or uid

How to use it

Resolves the umbrella research project that sequence records, BioSamples and SRA runs are filed under. Accepts the PRJNA/PRJEB/PRJDB accession or the numeric uid. This returns the project's own registration - scope, material, methodology, objectives and submitters - and not the records filed under it, which is why `project_title` is a study description rather than a dataset name. `relevance` is a submitter-declared free-text list, so treat an absent category as undeclared rather than as a denial.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — BioProject accession or the numeric BioProject uid (examples: "PRJNA31257", "PRJEB6403", "31257"; minLength: 1)

Response

• @type string (default: "GenbankBioProject")
• id string required
• accession string (default: "")
• project_title string (default: "")
• name string (default: "")
• description string (default: "")
• project_type string (default: "")
• project_subtype string (default: "")
• data_type string (default: "")
• target_scope string (default: "")
• target_material string (default: "")
• target_capture string (default: "")
• method_type string (default: "")
• method string (default: "")
• objectives array (default: [])
  • @type string (default: "GenbankBioProjectObjective")
  • objective_type string required
  • value string (default: "")
• relevance array (default: [])
  • @type string (default: "GenbankBioProjectRelevance")
  • category string required
  • value string required
• sequencing_status string (default: "")
• organism string (default: "")
• organism_strain string (default: "")
• organism_label string (default: "")
• taxid string (default: "")
• supergroup string (default: "")
• keyword string (default: "")
• submitter_organizations array (default: [])
• registration_date 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 — BioProject 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.