JoGo API

JoGo API v1 provides read-only JSON endpoints for RDF generation and other programmatic access to JoGo 1.0 region, sample population, haplotype membership, and upstream/downstream records.

API v1

Base URL

https://jogo.csml.org/api/v1
Method Endpoint Purpose
GET /regions List JoGo 1.0 region names with gene, chromosome, coordinate, and source metadata.
GET /regions/{regionname} Return one canonical region record and MANE metadata.
GET /samples List sample IDs with fine population, global population, and available group names.
GET /samples/{sampleid} Return one sample population record.
GET /regions/{regionname}/samples Return per-region sample haplotype membership. Use level=actg, g, u, or d.
GET /regions/{regionname}/flanks Return upstream/downstream haplotype and variant annotation records in separate namespaces.
GET /meta/sources Return machine-readable source provenance.

Query and response rules

  • All /api/v1/* endpoints are read-only and return JSON.
  • Paginated endpoints use limit and cursor. The default limit is 100, and the maximum limit is 1000.
  • Responses include meta.api_version and source provenance in meta.source.
  • Source provenance uses public source IDs and table names; internal filesystem paths are not exposed.
  • Upstream/downstream payloads keep flanking_haplotypes and variant_annotations separate for RDF predicates.

Examples

Sample population metadata:

curl -s 'https://jogo.csml.org/api/v1/samples/HG00096' | jq '.' curl -s 'https://jogo.csml.org/api/v1/samples/NA18525' | jq '.'

Region lookup:

curl -s 'https://jogo.csml.org/api/v1/regions?gene=ALDH2&limit=1' | jq '.'

Upstream/downstream records:

curl -s 'https://jogo.csml.org/api/v1/regions/ALDH2_chr12_111761933_111822532/flanks?limit=2' | jq '.'

Legacy Portal JSON Endpoints

The portal pages below also provide JSON output by appending format=json. New RDF-oriented integrations should prefer API v1.

Gene endpoint

Browser:

https://jogo.csml.org/gene?genename=ALDH2&format=json

curl:

curl -s 'https://jogo.csml.org/gene?genename=ALDH2&format=json' | jq '.'

Genic region endpoint

https://jogo.csml.org/genicregion?regionname=BRCA1_chr17_43039295_43130364&format=json

Find region names from the full genic region list

Notes

  • API v1 response fields are intended to remain stable, but new optional fields may be added.
  • Please avoid heavy polling and cite JoGo appropriately when reusing data under the license.