Back to Dashboard

REST API

v1

A curated, read-only HTTP API for programmatic access to genes, isoforms, summary metrics, and predicted structures. Base URL: /api/v1.

Authentication

Every request needs an API key sent as a Bearer token. Keys are issued on request — contact the maintainers (FHNW · Kahraman Lab) with your name, affiliation, and intended use.

Authorization: Bearer spl_live_xxxxxxxxxxxxxxxxxxxx

Rate limits

Default 60 requests/minute and 5,000/day per key, plus a coarse per-IP edge limit. Exceeding a limit returns 429 Too Many Requestswith a Retry-After header. Need more? Ask for a higher tier.

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

curl -H "Authorization: Bearer $SPLISOFORMS_KEY" \
     https://splisoforms.fhnw.ch/api/v1/isoforms/TP53-201

# fetch the structure (follows the 307 redirect to the mmCIF)
curl -L -H "Authorization: Bearer $SPLISOFORMS_KEY" \
     https://splisoforms.fhnw.ch/api/v1/isoforms/TP53-201/structure -o model.cif

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.