GA4GH Beacon v2 API Documentation

Neuroscience Genomics Platform

Base URL: https://beacon-server-demo.niagads.org/api/v2

Version: v2.0.0

Beacon Information

Beacon ID
org.beacon.neuroscience
Name
Neuroscience Genomics Beacon
API Version
v2.0.0
Environment
Dev

API Endpoints

Beacon Information

Get Beacon metadata and configuration

Public
GET /api/v2

Example Request

curl -X GET "https://beacon-server-demo.niagads.org/api/v2"

Query Genomic Variations

Query genomic variants by position, allele, or gene

Public
GET|POST /api/v2/g_variants

Query Parameters

Parameter Description
referenceName Chromosome (e.g., chr1)
start Start position
end End position (optional)
referenceBases Reference allele
alternateBases Alternate allele

Example Request

curl -X GET "https://beacon-server-demo.niagads.org/api/v2/g_variants"

Query Individuals

Query individuals by phenotype or disease

Public
GET|POST /api/v2/individuals

Example Request

curl -X GET "https://beacon-server-demo.niagads.org/api/v2/individuals"

Query Biosamples

Query biosamples by tissue type or collection

Public
GET|POST /api/v2/biosamples

Example Request

curl -X GET "https://beacon-server-demo.niagads.org/api/v2/biosamples"

Query Datasets

List available datasets

Public
GET|POST /api/v2/datasets

Example Request

curl -X GET "https://beacon-server-demo.niagads.org/api/v2/datasets"

Authentication

The API supports three access levels:

✓

PUBLIC

Boolean responses, no authentication required

✓

REGISTERED

Count responses, requires JWT authentication

Authorization: Bearer {token}
✓

CONTROLLED

Record-level responses, requires JWT + dataset permissions

Resources