Get job

Poll status and retrieve a completed result.

GET /v1/jobs/{job_id}

Scope charts:read · Cost 0 requests · Plans Scale and Enterprise

Returns progress while active, result data when complete, or a terminal error for failed and cancelled jobs.

Authentication

Send your key in one header: X-RailCore-Key, Authorization: Bearer or X-Api-Key. Two headers with different keys answer 401 AMBIGUOUS_API_KEY. This operation requires the charts:read scope. Growth, 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. See the authentication guide and HMAC signing.

Request parameters

NameInTypeRequiredDescription
job_idpathstringRequiredJob identifier returned by a submission endpoint.

Code examples

Base URL https://ir.railcore.tech/v1. Keep the key in an environment variable and call from a trusted server-side environment.

cURL

curl -sS -X GET \
  -H "X-RailCore-Key: $RAILCORE_KEY" \
  "https://ir.railcore.tech/v1/jobs/job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8"

JavaScript

const response = await fetch("https://ir.railcore.tech/v1/jobs/job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8", {
  method: "GET",
  headers: {
    "X-RailCore-Key": process.env.RAILCORE_KEY,
  },
});

const body = await response.json();
console.log(response.status, body);

Python

import os
import requests

response = requests.request(
    "GET",
    "https://ir.railcore.tech/v1/jobs/job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8",
    headers={"X-RailCore-Key": os.environ["RAILCORE_KEY"]},
    timeout=20,
)
print(response.status_code, response.json())

Rate limits and cost

This operation counts as 0 requests and is available on Scale and Enterprise. Failed requests are free. Per-minute budgets, daily caps and the headers reporting what is left are in rate limits; plans and prices are in requests and billing.

Response fields

FieldTypeDescription
job_idstringPersistent job identifier.
statusJobStatuspending, processing, complete, failed, or cancelled.
typestringroute-scan or hopping.
created_at / completed_atstring(date-time)Lifecycle timestamps in IST.
progressstringCurrent human-readable processing stage.
callback_statusstringnot_configured when no callback_url was given. pending until the callback is settled: the job's status is saved before the callback is sent, so a poll can see the result first. sent when your endpoint answered 2xx; failed when it never did, or the address was refused.
callback_attemptsintegerHow many times the callback was sent, 0 to 4: 0 when the address was refused before the first send. Present once the callback is settled.
dataobjectCompleted route-scan or hopping result.
errorobjectTerminal code and message when the job failed.

Example response

{
  "success": true,
  "data": {
    "success": true,
    "job_id": "job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8",
    "status": "processing",
    "type": "route-scan",
    "created_at": "2026-11-20T10:55:51.794+05:30",
    "progress": "Scanning trains (from: BSL, to: ADI)..."
  },
  "meta": {
    "api_version": "v1",
    "request_id": "req_01J5Z7Y8N2K4M6P8R0T2V4X6Z8",
    "trace_id": "trc_01J5Z7Y8N2K4M6P8R0T2V4X6Z9",
    "timestamp": "2026-11-20T10:57:05.609Z",
    "freshness": {
      "mode": "live",
      "retrieved_at": "2026-11-20T10:57:05.609Z",
      "sources": [
        {
          "confidence": "high"
        }
      ]
    }
  }
}

Errors

StatusCodeDescriptionRetry
404JOB_NOT_FOUNDThe job does not exist or has expired.Not retryable
400VALIDATION_ERRORA required field is missing or invalid. error.details[].field names the parameter, such as date or items[2].date.Not retryable
401MISSING_API_KEYNo key in X-RailCore-Key, Authorization: Bearer or X-Api-Key, or the key is too short.Not retryable
401INVALID_API_KEYThe key is unknown or revoked. A disabled or expired key answers API_KEY_DISABLED or API_KEY_EXPIRED.Not retryable
401AMBIGUOUS_API_KEYMore than one key header was sent, with different keys. Send the key in one header.Not retryable
401SIGNATURE_INVALIDHMAC signature missing or not verified. Growth, Scale and Enterprise keys must sign every request; a key with no signing secret must be rotated.Not retryable
403SCOPE_MISSINGThe key lacks this operation's scope.Not retryable
403PLAN_ENDPOINT_DISABLEDThe account's plan does not include this endpoint.Not retryable
402CREDITS_EXHAUSTEDThe month's requests are used up, or too few are left for this request. Nothing is fetched.Not retryable
429RATE_LIMITEDThe account's per-minute budget, or a Free account's daily budget, is used up. Every key on the account shares it. Honor Retry-After.Retryable
410API_VERSION_SUNSETThis API version has reached its announced sunset date. Migrate to a supported major version.Not retryable
503UPSTREAM_UNAVAILABLELive data could not be retrieved. Wait for Retry-After, then retry with backoff. Not counted.Retryable
503UPSTREAM_TIMEOUTThe live-data request ran past its deadline. Wait for Retry-After, then retry with backoff. Not counted.Retryable
503METERING_UNAVAILABLEThe request could not be counted, so no data was returned. Retry with backoff.Retryable

Related Jobs endpoints

All RailCore Indian Railways API endpoints · Quickstart · Rate limits

Last updated