Back to Dashboard

REST API

v1

A curated, open, read-only HTTP API for programmatic access to genes, isoforms, summary metrics, and predicted structures. Base URL: https://splisoforms.org/api/v1. Isoform endpoints accept either a transcript id (ENST…/PB…) or a transcript name (e.g. F2-201). All responses are JSON, except the structure endpoint, which 307-redirects to an mmCIF file.

Authentication

No key is required — the API is open and read-only. Anonymous requests are rate-limited per IP (see below). For higher sustained or bulk volume, request an API key by emailing abdullah.kahraman@fhnw.ch (FHNW · Kahraman Lab) with your name, affiliation, and intended use — full contact details are on the Imprint page. Send the key as a Bearer token:

Authorization: Bearer spl_live_xxxxxxxxxxxxxxxxxxxx   # optional — higher-volume tier only

Rate limits

There are two access tiers:

AnonymousOpen, no key. Rate-limited per IP; requests over the limit return 429 Too Many Requests. Fine for interactive and light programmatic use.
API keyA higher per-key quota for sustained or bulk access — request one as described above.

Endpoints

GET/genes/{symbol}
Gene summary and its isoforms.
GET/genes/{symbol}/isoforms
Paginated isoforms of a gene (limit ≤ 100).
GET/isoforms/{transcript_id}
Core record + summary metrics (Δlength, NMD, domains, neoantigens, PTM, pLDDT).
GET/isoforms/{transcript_id}/structure
Redirect (307) to the predicted mmCIF structure.
GET/isoforms/{transcript_id}/domains
Pfam + TED domain annotations.
GET/isoforms/{transcript_id}/neoantigens
Top predicted neoantigens (limit ≤ 50).
GET/search?query=
Search genes + isoforms (limit ≤ 25).

Example

# no key needed for standard use
curl https://splisoforms.org/api/v1/genes/TP53
curl https://splisoforms.org/api/v1/isoforms/TP53-208

# fetch the structure (follow the 307 redirect to the mmCIF)
curl -L https://splisoforms.org/api/v1/isoforms/TP53-208/structure -o model.cif

# only for higher-volume access: add your key
curl -H "Authorization: Bearer $SPLISOFORMS_KEY" \
     "https://splisoforms.org/api/v1/search?query=kinase"

Scope

The API is intentionally coarse-grained: it serves gene/isoform records, summary metrics, and structures. It does not provide bulk database dumps, raw per-residue mass data, or write/compute access. For full interactive exploration, use the web interface.