A package built on top of IRCTC Website APIs to book train tickets, managing user profile faster and simpler. Currently this package only works on NodeJs environment and we were not recommending this to use on browser or any other Javascript environment.

NPM Downloads Dynamic JSON Badge Contributors GitHub License Dynamic JSON Badge GitHub Issues or Pull Requests GitHub last commit GitHub Actions Workflow Status

[!NOTE]

This irctc-api script for automating IRCTC ticket booking
is created strictly for educational purposes. The code and its
usage are intended to showcase irctc-api testing capabilities and
best practices. Any attempt to use this script for unauthorized
access or activities that violate IRCTC terms of service or legal
regulations is strictly prohibited. The author(s) and associated
entities are not responsible for any misuse or legal consequences 
resulting from the use of this script for any unauthorized 
activities.

GitHub Logo npm Logo Documentation Logo

Installing

To install the this package, simply type i or install irctc-api using the node package manager

npm install irctc-api

Prerequisite

This Package uses viu, A rust module uses iterm image protocol for displaying images within System Terminal.

We use that for displaying captcha images on command line for login and bookings as to make your booking flow in a seamless way.

Hence you are required to download the viu executable file related to your OS and Processor Architecture from the viu release Assets then add the folder where the viu is stored to your environment variables.

Remeber to add the folder path and not the viu.exe file path in your environment variables.

Notes

  • Currently this project is designed to accept only UPI Collect request as payment option and other payment modes are not supported as of now. When the payment request is initiated, The command line will display the payment request details such that you need to complete the payment from your UPI mobile App.

  • We request to verify whether viu is working or not by giving the below command

viu example.jpeg -t

Import

This Package exports a class named IRCTC which contains three functions.

  • book
  • last_transaction
  • pnr_status

To send a request, you only need to import the IRCTC.

// ES5 example
const { IRCTC } = require("irctc-api");

// ES6+ example
import { IRCTC } from "irctc-api";

Examples

The Code Examples are hosted at Github Repo - suryavaddiraju/irctc-api

Usage

To send a request, you:

  • Initiate IRCTC class
  • Call available function operation on class with input as javascript object.
// a client can be shared by different commands. But it is currently in development untill then use client seperately.
const client = new IRCTC();

const params = {
  // refer https://dev.vaddiraju.in/irctc-api/api_reference#book_input
};
const command = await client.book(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.book(params);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Contributing

Any modifications will be overwritten the next time the irctc-api package is updated. To contribute to the package you can check our contribution page.

License

This package is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

book Command API Reference / Input / Output
last_transaction Command API Reference / Input / Output
pnr_status Command API Reference / Input / Output

All Rights Reserved. © Vaddiraju Surya Teja, 2024