Resources

Header reference

Request, rate, credit, and trace headers.

Header, Direction, Meaning table
HeaderDirectionMeaning
X-RailCore-KeyRequestThe API key. Required, unless it is sent in Authorization or X-Api-Key instead
AuthorizationRequestBearer <key>: the API key, as an alternative to X-RailCore-Key
X-Api-KeyRequestThe API key, as an alternative to X-RailCore-Key. Two key headers with different keys answer 401 AMBIGUOUS_API_KEY
X-RailCore-TimestampRequestUnix seconds; required on Growth, Scale and Enterprise keys
X-RailCore-NonceRequestUnique replay-protection token; required on Growth, Scale and Enterprise keys
X-RailCore-SignatureRequestBase64 HMAC-SHA256 signature; required on Growth, Scale and Enterprise keys
X-RailCore-Request-IDResponseSupport and request-log identifier
X-RailCore-Trace-IDResponseDistributed trace identifier
X-RailCore-PlanResponsePlan applied to the request
X-RailCore-RateLimit-LimitResponseThe account's per-minute budget, shared by all its keys. Sent only when the plan has a per-minute limit.
X-RailCore-RateLimit-RemainingResponseRequests left in the account's current minute. Sent only when the plan has a per-minute limit.
X-RailCore-RateLimit-ResetResponseMinute reset Unix time. Sent only when the plan has a per-minute limit.
X-RailCore-RateLimit-Day-LimitResponseThe account's daily request budget, per IST day. Sent only on keys with a daily cap (Free).
X-RailCore-RateLimit-Day-RemainingResponseDaily requests left. Sent only on keys with a daily cap (Free).
X-RailCore-RateLimit-Day-ResetResponseDaily reset Unix time. Sent only on keys with a daily cap (Free).
X-RailCore-Credits-CostResponseWhat this request counted as (one credit is one request)
X-RailCore-Credits-RemainingResponseRequests left on the account
X-RailCore-ConfidenceResponsehigh, medium, or low live-data confidence. A finished run whose arrival at its last station was reported is high
Server-TimingResponseWhere the request spent its time, in milliseconds: stages such as key, limits, credits and upstream in the order they ran, then total. Sent on every response
Retry-AfterResponseSeconds to wait before retrying a 429 or a 503
DeprecationResponseWhen the path stopped answering API keys, as @ and Unix seconds (RFC 9745). Sent only with 410 ENDPOINT_RETIRED, from a retired path.
SunsetResponseThe same moment as an HTTP date (RFC 8594). Sent only with 410 ENDPOINT_RETIRED, from a retired path.
LinkResponseThe path to use instead (rel="successor-version") and the changelog entry (rel="deprecation"). Sent only with 410 ENDPOINT_RETIRED, from a retired path.
X-RailCore-Webhook-IdWebhookThe job_id, on a job's callback to your callback_url
X-RailCore-Webhook-TimestampWebhookUnix seconds when this send was signed
X-RailCore-Webhook-AttemptWebhookWhich send this is, 1 to 4
X-RailCore-Webhook-SignatureWebhookv1= and the hex HMAC-SHA256 of the timestamp, a period and the raw body, with the job's webhook_secret

Retired paths

GET /v1/trains/{train_number}/live-status and /running were retired on November 3, 2026. They answer 410 ENDPOINT_RETIRED with Deprecation, Sunset and Link, and are not counted. Live train status at /v1/trains/{train_number}/live replaces both.

Webhook headers

The four X-RailCore-Webhook-* headers come on the POST RailCore sends to a job's callback_url, not on API responses. Webhooks shows how to check them.

Browser visibility

Server clients receive every header. Browser JavaScript can read only CORS-exposed response headers.

Last updated