NBDC logo logo en

NBDC Human Database Beacon API Help

A NBDC Beacon API is compliant to a Global Alliance for Genomics and Health (GA4GH) Beacon.

REST endpoint /beacon/api/query

parameters

  • chromosome: 1 - 22, X, Y or M
  • allele: A,C,T,G.
  • position: 0-based position on chromosome
  • dataset: optional. If not specified all datasets will be queried.
  • reference: optional. If specified, has to be GRCh37
  • format: if "text", does not return JSON, but just one of the words "true", or "false". Easier to parse for shell scripts.

Examples

REST endpoint /beacon/api/info

It shows info about beacon, e.g. number of variants served. no parameters

Examples