Submit route-scan job

Run route scanning asynchronously.

POST /v1/jobs/route-scan

Scope charts:write · Credits 25 at submission · Plans Scale and Enterprise

Creates a durable route-scan job, retries once on processing failure, and optionally calls your callback URL at completion.

Authentication

Send your key in the X-RailCore-Key header. This operation requires the charts:write scope. See the authentication guide.

Request parameters

This operation takes no path or query parameters.

JSON body

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 POST \
  -H "X-RailCore-Key: $RAILCORE_KEY" \
  -H "Content-Type: application/json" \
  --data '{"from":"BSL","to":"ADI","date":"2026-08-27","quota":"GN","max_trains":"8","only_running":"true","include_fare":"false","prefer_class":"3A,2A"}' \
  "https://ir.railcore.tech/v1/jobs/route-scan"

JavaScript

const response = await fetch("https://ir.railcore.tech/v1/jobs/route-scan", {
  method: "POST",
  headers: {
    "X-RailCore-Key": process.env.RAILCORE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "from": "BSL",
  "to": "ADI",
  "date": "2026-08-27",
  "quota": "GN",
  "max_trains": "8",
  "only_running": "true",
  "include_fare": "false",
  "prefer_class": "3A,2A"
}),
});

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

Python

import json
import os
import requests

response = requests.request(
    "POST",
    "https://ir.railcore.tech/v1/jobs/route-scan",
    headers={"X-RailCore-Key": os.environ["RAILCORE_KEY"]},
    json=json.loads("{\"from\":\"BSL\",\"to\":\"ADI\",\"date\":\"2026-08-27\",\"quota\":\"GN\",\"max_trains\":\"8\",\"only_running\":\"true\",\"include_fare\":\"false\",\"prefer_class\":\"3A,2A\"}"),
    timeout=20,
)
print(response.status_code, response.json())

Rate limits and credits

This call costs 25 at submission credits and is available on Scale and Enterprise. Per-minute and daily budgets, and the headers reporting remaining quota, are documented in rate limits and credits and billing.

Response fields

Example response

{
  "success": true,
  "data": {
    "job_id": "job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8",
    "status": "processing",
    "poll_url": "/v1/jobs/job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8",
    "stream_url": "/v1/jobs/job_01J5Z7Y8N2K4M6P8R0T2V4X6Z8/stream",
    "message": "Route scan submitted. Poll the poll_url for results."
  },
  "meta": {
    "api_version": "v1",
    "request_id": "req_01J5Z7Y8N2K4M6P8R0T2V4X6Z8",
    "trace_id": "trc_01J5Z7Y8N2K4M6P8R0T2V4X6Z9",
    "timestamp": "2026-08-20T17:12:23.305Z",
    "freshness": {
      "mode": "live",
      "retrieved_at": "2026-08-20T17:12:23.305Z",
      "sources": [
        {
          "confidence": "high"
        }
      ]
    }
  }
}

Errors

Related Jobs endpoints

• Submit hopping job
• Get job
• Cancel job
• Stream job progress
• List jobs

All RailCore Indian Railways API endpoints · Quickstart · Rate limits