Get started
API keys, scopes, expiry, and IP allowlists.
GET /v1/trains/12656 HTTP/1.1
Host: ir.railcore.tech
X-RailCore-Key: rk_live_your_key_hereKeys are opaque values with at least 24 characters. Do not place them in browser bundles, URLs, logs, public repositories, mobile apps, or support messages.
Send the key in X-RailCore-Key, or as Authorization: Bearer <key>, or in X-Api-Key. Use one header: two headers with different keys answer 401 AMBIGUOUS_API_KEY. The other two headers carry the same key:
Authorization: Bearer rk_live_your_key_here
X-Api-Key: rk_live_your_key_hereGrowth, Scale and Enterprise keys must also sign every request with HMAC-SHA256, sending X-RailCore-Timestamp, X-RailCore-Nonce and X-RailCore-Signature. Free and Starter keys send the key alone. The signature does not cover the key, so it verifies the same whichever header carries it. How to sign a request.
Issue a separate least-privilege key for each integration and environment. All keys on an account share its rate limits and monthly requests.
| Scope | Access |
|---|---|
stations:read | Station search and static station details |
trains:read | Train search and static train details |
schedule:read | Schedules, stops, routes, and coach positions |
live:read | Live station boards and live train status |
journeys:read | Route discovery, journey search, and comparison |
availability:read | Seat availability, calendars, and classes |
fares:read | Reserved and unreserved fares |
charts:read | Chart, vacancy, and job-result reads |
charts:write | Submit and cancel premium analysis jobs |
| Control | Free | Starter | Growth | Scale | Enterprise |
|---|---|---|---|---|---|
| API-key header | Yes | Yes | Yes | Yes | Yes |
| IPv4 and IPv6 allowlist | No | No | Optional | Optional | Optional |
| HMAC signing | No | No | Required | Required | Required |
| Premium chart scopes | No | No | No | Yes | Yes |
Growth, Scale and Enterprise keys can restrict requests to fixed egress CIDR blocks.
203.0.113.42/32
203.0.113.0/24
2001:db8:abcd::/48IPv4 prefixes may be /8 to /32. IPv6 prefixes may be /48 to /128. Allowlist the public NAT or proxy address that reaches RailCore.
Expiration
Keys do not expire by default. Add expires_at for temporary integrations.
Rotation
Rotation creates a replacement secret and revokes the previous credential.
Revocation
Dashboard revocation is immediate and propagates in under a second.
HMAC mode
Growth, Scale and Enterprise keys must sign every request and come with a one-time signing secret. A key issued before November 3, 2026 has no secret: rotate it to get one.
Last updated