SimRail API SDK

This is a simple SDK (community edition) for interacting with the SimRail APIs.

This API module builds a layer on top of a Core API module (like @simrail-sdk/api-core-node) by providing:

• Methods to request single resources. (A single server, station or train)
• Automatic pulling of remote data updates.
• Update event subcriptions.
• Caching of remote API responses.

This API module is only about interacting with SimRail's remote APIs. If you are looking for a more developer-friendly SDK, checkout:

• @simrail-sdk/core for an SDK consuming only live data.
• @simrail-sdk/sdk for an SDK providing extended data about the game. (upcoming)

This module requires the use of a Core API module to be able to extend it. By default this module will use @simrail-sdk/api-core-node. To provide another Core API module or a custom one, check out the example providing a (custom) Core API class below.

Content index

• Usage details

  • Installation

  • Examples

    • Simple API usage

    • Automatic updates

    • Handling events

    • Working with result caching

    • Providing a (custom) Core API class

• API reference

• About this module

  • Module dependencies

    • Module package dependencies

    • Internal module dependencies

  • Module code statistics

Usage details

Installation

Using NPM:

$ npm i @simrail-sdk/api

or

$ npm i github:simrail-sdk/api#VERSION

Where VERSION specifies the version to install.

Examples

Simple API usage

import Api from "@simrail-sdk/api";

const api = new Api({
    endpoints: {
        liveData: "https://panel.simrail.eu:8084",
        timetable: "https://api1.aws.simrail.eu:8082/api",
    },
});
const serverCode: Api.ServerCode = "en1";

api.getActiveServers().then(...);
api.getActiveServer(serverCode).then(...);
// {
//     id: "638fec40d089346098624eb5",
//     isActive: true,
//     serverCode: "en1",
//     serverName: "EN1 (English)",
//     serverRegion: "Europe",
// },

api.getActiveStations(serverCode).then(...);
api.getActiveStation(serverCode, "KO").then(...);
// {
//     additionalImage1URL: "https://api.simrail.eu:8083/Thumbnails/Stations/ko2.jpg",
//     additionalImage2URL: "https://api.simrail.eu:8083/Thumbnails/Stations/ko3.jpg",
//     difficultyLevel: 5,
//     dispatchedBy: [],
//     id: "644133f3858f72cc3d476e42",
//     latitude: 50.25686264038086,
//     longitude: 19.01921844482422,
//     mainImageURL: "https://api.simrail.eu:8083/Thumbnails/Stations/ko1m.jpg",
//     name: "Katowice",
//     prefix: "KO"
// },

api.getActiveTrains(serverCode).then(...);
api.getActiveTrain(serverCode, "446004").then(...);
// {
//     endStation: "Częstochowa",
//     id: "662f96b3766d379b4f3f525f",
//     runId: "73c0f0ea-20d9-4317-8339-8bc7d098bd35",
//     serverCode: "en1",
//     startStation: "Jaworzno Szczakowa",
//     trainData: {
//     inBorderStationArea: true,
//     latitude: 50.262142181396484,
//     longitude: 19.269641876220703,
//     vdDelayedTimetableIndex: 1,
//     velocity: 40,
//     distanceToSignalInFront: 386.6281433105469,
//     signalInFront: "SMA_G@7129,82510,8",
//     signalInFrontSpeed: 40
//     },
//     trainName: "PWJ",
//     trainNoLocal: "446004",
//     type: "bot",
//     vehicles: [ "EN57/EN57-1003", "EN57/EN57-614", "EN57/EN57-1755" ]
// },

api.getTimetable(serverCode).then(...);
api.getTimetable(serverCode, "446004").then(...);
// {
//     endStation: "Częstochowa",
//     endsAt: "03:53:00",
//     locoType: "EN57 (5B+6B+5B)",
//     runId: "73c0f0ea-20d9-4317-8339-8bc7d098bd35",
//     startStation: "Jaworzno Szczakowa",
//     startsAt: "02:15:00",
//     timetable: [
//       {
//         departureTime: "2024-08-05 02:15:00",
//         displayedTrainNumber: "446004",
//         line: 133,
//         maxSpeed: 100,
//         kilometrage: 15.81,
//         nameForPerson: "Jaworzno Szczakowa",
//         nameOfPoint: "Jaworzno Szczakowa",
//         pointId: "1472",
//         stopType: "NoStopOver",
//         trainType: "PWJ",
//         supervisedBy: "Jaworzno Szczakowa"
//       },
//       ...
//     ],
//     trainLength: 60,
//     trainName: "PWJ",
//     trainNoLocal: "446004",
//     trainWeight: 60
// }

Automatic updates

import Api from "@simrail-sdk/api";

const api = new Api(...);
const serverCode: Api.ServerCode = "en1";

// Start auto updates using data from "en1".
api.startAutoUpdates(serverCode);

// Stop auto updates.
api.stopAutoUpdates();

// Restart auto updates.
api.startAutoUpdates();

// Or, do the same thing using accessors
api.autoUpdateServer = serverCode;
api.autoUpdate = true;
const updatesEnabled = api.autoUpdate;

Handling events

import Api from "@simrail-sdk/api";

const api = new Api(...);

// Subscribe to API events.
const eventSubscription = api.events.subscribe((event) => {
    switch (event.type) {
        case Api.Event.Type.ActiveServersUpdated:  event.activeServers[0].id;       break;
        case Api.Event.Type.ActiveStationsUpdated: event.activeStations[0].code;    break;
        case Api.Event.Type.ActiveTrainsUpdated:   event.activeTrains[0].id;        break;
        case Api.Event.Type.AutoUpdateChanged:     event.autoUpdate === true;       break;
        case Api.Event.Type.TimetableUpdated:      event.timetable[0].trainNoLocal; break;
    }
});

// Unsubscribe from events.
eventSubscription.unsubscribe();

Working with result caching

import Api from "@simrail-sdk/api";

// Cache configuration can be specified at API class construction.
const api = new Api({

    /** Specifies a config for requests to the timetable endpoint. */
    timetable: {
        cache: {
            /**
             * Specifies if caching is enabled.
             * @default true
             */
            enabled: true,
            /**
             * Specifies for how long a timetable record is cached in seconds.
             * This value also specifies the update interval for auto updates.
             * @default 1440
             */
            retention: 1440,
            /**
             * Specifies if only one timetable record should be cached.
             *
             * When set to:
             * - `true` only the last timetable record will be cached.
             * - `false` a timetable record will be cached for
             *   each server that was queried for a timetable.
             *   Use this when you are actively querying multiple servers.
             *
             * @default true
             */
            singleRecordOnly: true,
        },
    },

    /** Specifies a config for requests to the live data endpoint. */
    liveData: {
        cache: {
            // Values displayed are the defaults.
            activeServers:  { enabled: true, retention: 30 },
            activeStations: { enabled: true, retention: 30 },
            activeTrains:   { enabled: true, retention: 5  },
        },
    },

    ...

});


// Independent of the cache config you can prevent a cached result
//   to be returned by specifying the `noCache` argument.
const serverCode: Api.ServerCode = "de1";
const noCache: Api.NoCache = true;
const nonCachedServers        = await api.getActiveServers(noCache);
const nonCachedServer         = await api.getActiveServer(serverCode, noCache);
const nonCachedStations       = await api.getActiveStations(serverCode, noCache);
const nonCachedStation        = await api.getActiveStation(serverCode, "KO", noCache);
const nonCachedTrains         = await api.getActiveTrains(serverCode, noCache);
const nonCachedTrain          = await api.getActiveTrain(serverCode, "446004", noCache);
const nonCachedTimetable      = await api.getTimetable(serverCode, noCache);
const nonCachedTrainTimetable = await api.getTimetable(serverCode, "446004", noCache);


// If you need to, flush cached data.
api.flushCache();
// Or
api.flushActiveServerCache();
api.flushActiveStationCache();
api.flushActiveTrainCache();
api.flushTimetableCache();

Providing a (custom) Core API class

import Api from "@simrail-sdk/api";
import Core from "different-api-core";

// By default the API will use the Core API class from package `@simrail-sdk/api-core-node`.
// To provide another Core API class or a custom one, just include the instance in the API config.
const core = new Core({ endpoints });
const api = new Api({ core });

API reference

NOTE: The API reference section doesn't account for namespaces, this unfortunately means the documentation below is not entirely complete. Please investigate the TypeScript definition files for the full API.

• class Api

  • new Api.constructor(config)

  • property Api.autoUpdateServer

  • property Api.config

  • property Api.core

  • property Api.events

  • property Api.autoUpdate

  • method Api.flushActiveServerCache()

  • method Api.flushActiveStationCache()

  • method Api.flushActiveTrainCache()

  • method Api.flushCache()

  • method Api.flushTimetableCache()

  • method Api.getActiveServer(serverCode, noCache)

  • method Api.getActiveServers(noCache)

  • method Api.getActiveStation(serverCode, stationCode, noCache)

  • method Api.getActiveStations(serverCode, noCache)

  • method Api.getActiveTrain(serverCode, trainNoLocal, noCache)

  • method Api.getActiveTrains(serverCode, noCache)

  • method Api.getTimetable(serverCode, noCache)

  • method Api.getTimetable(serverCode, trainNoLocal, noCache)

  • method Api.getTimetable(serverCode, trainNoOrNoCache, noCache)

  • method Api.startAutoUpdates(autoUpdateServer)

  • method Api.stopAutoUpdates()

• const DEFAULT_ACTIVE_SERVER_RETENTION

• const DEFAULT_ACTIVE_STATION_RETENTION

• const DEFAULT_ACTIVE_TRAIN_RETENTION

• const DEFAULT_TIMETABLE_RETENTION

• const VERSION

• const VMAX

• const VMAX_VALUE

• enum Type

  • member Type.ActiveServersUpdated

  • member Type.ActiveStationsUpdated

  • member Type.ActiveTrainsUpdated

  • member Type.AutoUpdateChanged

  • member Type.TimetableUpdated

• interface ActiveServer

• interface ActiveServers

  • property ActiveServers.map

  • property ActiveServers.timestamp

• interface ActiveServersUpdated

  • property ActiveServersUpdated.activeServers

• interface ActiveStation

  • property ActiveStation.code

• interface ActiveStationsUpdated

  • property ActiveStationsUpdated.activeStations

• interface ActiveTrain

• interface ActiveTrainsUpdated

  • property ActiveTrainsUpdated.activeTrains

• interface AutoUpdateChanged

  • property AutoUpdateChanged.autoUpdate

• interface Base

  • property Base.api

  • property Base.type

• interface Cache

  • property Cache.activeServers

  • property Cache.activeStations

  • property Cache.activeTrains

  • property Cache.timetables

• interface Config

  • property Config.endpoints

• interface Data

  • property Data.continuesAs

  • property Data.endStation

  • property Data.endsAt

  • property Data.locoType

  • property Data.runId

  • property Data.startStation

  • property Data.startsAt

  • property Data.timetable

  • property Data.trainLength

  • property Data.trainName

  • property Data.trainNoInternational

  • property Data.trainNoLocal

  • property Data.trainWeight

• interface Disabled

• interface DispatchedBy

  • property DispatchedBy.ServerCode

  • property DispatchedBy.SteamId

• interface Enabled

  • property Enabled.retention

  • property Enabled.singleRecordOnly

• interface Endpoints

  • property Endpoints.liveData

  • property Endpoints.timetable

• interface Error

• interface LiveData

  • property LiveData.cache

• interface Regular

• interface Server

  • property Server.id

  • property Server.isActive

  • property Server.serverCode

  • property Server.serverName

  • property Server.serverRegion

• interface Station

  • property Station.code

• interface Stations

  • property Stations.map

  • property Stations.timestamp

• interface Successful

  • property Successful.count

  • property Successful.data

  • property Successful.description

• interface Timetable

  • property Timetable.map

  • property Timetable.timestamp

• interface TimetableUpdated

  • property TimetableUpdated.timetable

• interface Train

  • property Train.endStation

  • property Train.id

  • property Train.runId

  • property Train.serverCode

  • property Train.startStation

  • property Train.trainData

  • property Train.trainName

  • property Train.trainNoLocal

  • property Train.type

  • property Train.vehicles

• interface TrainData

  • property TrainData.controlledBySteamId

  • property TrainData.distanceToSignalInFront

  • property TrainData.inBorderStationArea

  • property TrainData.latitude

  • property TrainData.longitude

  • property TrainData.signalInFront

  • property TrainData.signalInFrontSpeed

  • property TrainData.vdDelayedTimetableIndex

  • property TrainData.velocity

• interface Trains

  • property Trains.map

  • property Trains.timestamp

• interface WithCore

  • property WithCore.core

• type ActiveServers

• type ActiveStations

• type ActiveTrains

• type ApiResponse

• type ArrivalTime

• type AutoUpdate

• type AutoUpdateServer

• type Cache

• type Code

• type Config

• type ContinuesAs

• type ControlledBySteamId

• type Count

• type DepartureTime

• type Description

• type DifficultyLevel

• type DisplayedTrainNumber

• type DistanceToSignalInFront

• type Emitter

• type EndsAt

• type EndStation

• type Event

• type Id

• type ImageUrl

• type InBorderStationArea

• type IsActive

• type Kilometrage

• type Latititude

• type Latititute

• type Latitude

• type Line

• type List

• type LocoType

• type Longitude

• type Longitute

• type Map

• type MaxSpeed

• type Mileage

• type Name

• type NameForPerson

• type NameOfPoint

• type NoCache

• type Platform

• type PointId

• type Prefix

• type RadioChannel

• type RadioChannels

• type Result

• type Retention

• type RunId

• type ServerCode

• type ServerName

• type ServerRegion

• type SignalInFront

• type SignalInFrontSpeed

• type SingleRecordOnly

• type StartsAt

• type StartStation

• type StationCategory

• type SteamId

• type StopType

• type SupervisedBy

• type Timestamp

• type Timetables

• type Track

• type TrainLength

• type TrainName

• type TrainNoInternational

• type TrainNoLocal

• type TrainType

• type TrainWeight

• type Type

• type Url

• type VdDelayedTimetableIndex

• type Vehicle

• type Vehicles

• type Velocity

• type Version

class Api   ↑

Specifies an API class instance for interacting with SimRail's remote API.

Implements:  Omit<Api.Core, "config">

Since: 0.1.0

Definition:  index.ts:29

new Api.constructor(config)   ↑

Arguments:	Type
config	Config

Returns:  Api

Since: 0.1.0

Definition:  index.ts:94

property Api.autoUpdateServer   ↑

optional

Specifies the unique code of the server to automatically retrieve data from.

Type:  string

Since: 0.1.0

Definition:  index.ts:47

property Api.config   ↑

read-only

Specifies the configuration of the API.

Type:  Config

Since: 0.1.0

Definition:  index.ts:35

property Api.core   ↑

read-only

Specifies a reference to the Core API.

Type:  Api.Core

Since: 0.1.0

Definition:  index.ts:32

property Api.events   ↑

read-only

Specifies the event emitter for API events.

Type:  Emitter

Since: 0.1.0

Definition:  index.ts:38

property Api.autoUpdate   ↑

Since: 0.1.0

Definition:  index.ts:73

method Api.flushActiveServerCache()   ↑

Method to flush all cached active server records.

Returns:  Api  - This API instance.

Since: 0.1.0

Definition:  index.ts:109

method Api.flushActiveStationCache()   ↑

Method to flush all cached active station records.

Returns:  Api  - This API instance.

Since: 0.1.0

Definition:  index.ts:119

method Api.flushActiveTrainCache()   ↑

Method to flush all cached active train records.

Returns:  Api  - This API instance.

Since: 0.1.0

Definition:  index.ts:129

method Api.flushCache()   ↑

Method to flush all cached records.

Returns:  Api  - This API instance.

Since: 0.1.0

Definition:  index.ts:139

method Api.flushTimetableCache()   ↑

Method to flush all cached timetable records.

Returns:  Api  - This API instance.

Since: 0.1.0

Definition:  index.ts:152

method Api.getActiveServer(serverCode, noCache)   ↑

Method to retrieve an active server from the live data endpoint.

Arguments:	Type	Optional	Default	Description
serverCode	string	No	N/A	The unique code of the server.
noCache	boolean	Yes	false	Prevent returning a cached result.

Returns:  Promise<Server>  - The multiplayer server.

Since: 0.1.0

Definition:  index.ts:164

method Api.getActiveServers(noCache)   ↑

Method to retrieve active servers from the live data endpoint.

Arguments:	Type	Optional	Default	Description
noCache	boolean	Yes	false	Prevent returning a cached result.

Returns:  Promise<Server[]>  - A list of multiplayer servers.

Since: 0.1.0

Definition:  index.ts:178

method Api.getActiveStation(serverCode, stationCode, noCache)   ↑

Method to retrieve an active dispatch station from the live data endpoint.

The value for stationCode can be either:

• The prefix of the station.
• The code which is the prefix but stripped from diacritics. Example: prefix ŁA equals code LA.

Arguments:	Type	Optional	Default	Description
serverCode	string	No	N/A	The code of the related server.
stationCode	string	No	N/A	The unique code of the dispatch station.
noCache	boolean	Yes	false	Prevent returning a cached result.

Returns:  Promise<Station>  - The active dispatch station.

Since: 0.1.0

Definition:  index.ts:210

method Api.getActiveStations(serverCode, noCache)   ↑

Method to retrieve active dispatch stations from the live data endpoint.

Arguments:	Type	Optional	Default	Description
serverCode	string	No	N/A	The unique code of the multiplayer server.
noCache	boolean	Yes	false	Prevent returning a cached result.

Returns:  Promise<Station[]>  - A list of active dispatch stations.

Since: 0.1.0

Definition:  index.ts:225

method Api.getActiveTrain(serverCode, trainNoLocal, noCache)   ↑

Method to retrieve an active train from the live data endpoint.

Arguments:	Type	Optional	Default	Description
serverCode	string	No	N/A	The code of the related server.
trainNoLocal	string	No	N/A	The national number of the train.
noCache	boolean	Yes	false	Prevent returning a cached result.

Returns:  Promise<Train>  - The active dispatch train.

Since: 0.1.0

Definition:  index.ts:257

method Api.getActiveTrains(serverCode, noCache)   ↑

Method to retrieve active trains from the live data endpoint.

Arguments:	Type	Optional	Default	Description
serverCode	string	No	N/A	The unique code of the multiplayer server.
noCache	boolean	Yes	false	Prevent returning a cached result.

Returns:  Promise<Train[]>  - A list of active trains.

Since: 0.1.0

Definition:  index.ts:272

method Api.getTimetable(serverCode, noCache)   ↑

Method to retrieve timetable data from the timetable endpoint.

Arguments:	Type	Optional	Description
serverCode	string	No	The unique code of the multiplayer server.
noCache	boolean	Yes

Returns:  Promise<Data[]>

Since: 0.1.0

Definition:  index.ts:297

method Api.getTimetable(serverCode, trainNoLocal, noCache)   ↑

Arguments:	Type	Optional
serverCode	string	No
trainNoLocal	string	No
noCache	boolean	Yes

Returns:  Promise<Data>

Since: 0.1.0

Definition:  index.ts:297

method Api.getTimetable(serverCode, trainNoOrNoCache, noCache)   ↑

Arguments:	Type	Optional
serverCode	string	No
trainNoOrNoCache	string	Yes
noCache	boolean	Yes

Returns:  Promise<Data | Data[]>

Since: 0.1.0

Definition:  index.ts:297

method Api.startAutoUpdates(autoUpdateServer)   ↑

Method to start auto updating cached data.

This will update cached data and enable events. The update interval is determined by checking the cache retention value.

NOTE: Auto update only works for records which have caching enabled.

Arguments:	Type	Optional
autoUpdateServer	string	Yes

Returns:  Api  - This Api instance.

Since: 0.1.0

Definition:  index.ts:337

method Api.stopAutoUpdates()   ↑

Method to stop auto updating cached data.

Returns:  Api  - This Api instance.

Since: 0.1.0

Definition:  index.ts:381

const DEFAULT_ACTIVE_SERVER_RETENTION   ↑

Specifies the default retention for active server records.

Type:  Config.LiveData.Cache.ActiveServers.Retention

Since: 0.1.0

Definition:  index.ts:441

const DEFAULT_ACTIVE_STATION_RETENTION   ↑

Specifies the default retention for active station records.

Type:  Config.LiveData.Cache.ActiveStations.Retention

Since: 0.1.0

Definition:  index.ts:443

const DEFAULT_ACTIVE_TRAIN_RETENTION   ↑

Specifies the default retention for active train records.

Type:  Config.LiveData.Cache.ActiveTrains.Retention

Since: 0.1.0

Definition:  index.ts:445

const DEFAULT_TIMETABLE_RETENTION   ↑

Specifies the default retention for timetable records.

Type:  Config.Timetable.Cache.Retention

Since: 0.1.0

Definition:  index.ts:447

const VERSION   ↑

Specifies the version of the API.

Type:  Version

Since: 0.1.0

Definition:  index.ts:432

const VMAX   ↑

Specifies the maximum allowable operating speed. (Vmax)

Type:  "vmax"

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:15

const VMAX_VALUE   ↑

Specifies the "speed" value that will indicate "vmax".

Type:  32767

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:18

enum Type   ↑

Specifies a type of API event.

Since: 0.1.0

Definition:  index.ts:700

member Type.ActiveServersUpdated   ↑

Specifies an event that fires when cached active servers updated.

Type:  "activeServersUpdated"

Since: 0.1.0

Definition:  index.ts:704

member Type.ActiveStationsUpdated   ↑

Specifies an event that fires when cached active dispatch stations updated.

Type:  "activeStationsUpdated"

Since: 0.1.0

Definition:  index.ts:706

member Type.ActiveTrainsUpdated   ↑

Specifies an event that fires when cached active trains updated.

Type:  "activeTrainsUpdated"

Since: 0.1.0

Definition:  index.ts:708

member Type.AutoUpdateChanged   ↑

Specifies an event that fires when the value of Api.autoUpdate changes.

Type:  "autoUpdateChanged"

Since: 0.1.0

Definition:  index.ts:702

member Type.TimetableUpdated   ↑

Specifies an event that fires when cached timetable data updated.

Type:  "timetableUpdated"

Since: 0.1.0

Definition:  index.ts:710

interface ActiveServer   ↑

Extends:  Server

Since: 0.1.0

Definition:  index.ts:623

interface ActiveServers   ↑

Since: 0.1.0

Definition:  index.ts:625

property ActiveServers.map   ↑

Type:  Map

Since: 0.1.0

Definition:  index.ts:626

property ActiveServers.timestamp   ↑

Type:  number

Since: 0.1.0

Definition:  index.ts:627

interface ActiveServersUpdated   ↑

Specifies an event that fires when cached active servers updated.

Extends:  Base<Type.ActiveServersUpdated>

Since: 0.1.0

Definition:  index.ts:729

property ActiveServersUpdated.activeServers   ↑

Type:  Server[]

Since: 0.1.0

Definition:  index.ts:730

interface ActiveStation   ↑

Extends:  Station

Since: 0.1.0

Definition:  index.ts:635

property ActiveStation.code   ↑

Type:  string

Since: 0.1.0

Definition:  index.ts:636

interface ActiveStationsUpdated   ↑

Specifies an event that fires when cached active dispatch stations updated.

Extends:  Base<Type.ActiveStationsUpdated>

Since: 0.1.0

Definition:  index.ts:734

property ActiveStationsUpdated.activeStations   ↑

Type:  List

Since: 0.1.0

Definition:  index.ts:735

interface ActiveTrain   ↑

Extends:  Train

Since: 0.1.0

Definition:  index.ts:654

interface ActiveTrainsUpdated   ↑

Specifies an event that fires when cached active trains updated.

Extends:  Base<Type.ActiveTrainsUpdated>

Since: 0.1.0

Definition:  index.ts:739

property ActiveTrainsUpdated.activeTrains   ↑

Type:  Train[]

Since: 0.1.0

Definition:  index.ts:740

interface AutoUpdateChanged   ↑

Specifies an event that fires when the value of Api.autoUpdate changes.

Extends:  Base<Type.AutoUpdateChanged>

Since: 0.1.0

Definition:  index.ts:724

property AutoUpdateChanged.autoUpdate   ↑

Type:  boolean

Since: 0.1.0

Definition:  index.ts:725

interface Base   ↑

Type params:	Extends
EventType	Type

Since: 0.1.0

Definition:  index.ts:713

Extended by

• AutoUpdateChanged
• ActiveServersUpdated
• ActiveStationsUpdated
• ActiveTrainsUpdated
• TimetableUpdated

property Base.api   ↑

Specifies a reference to the related Api instance.

Type:  Api

Since: 0.1.0

Definition:  index.ts:715

property Base.type   ↑

Specifies the type of API event.

Type:  EventType

Since: 0.1.0

Definition:  index.ts:717

interface Cache   ↑

Specifies the internal cache of an API class instance.

Since: 0.1.0

Definition:  index.ts:615

property Cache.activeServers   ↑

optional

Type:  ActiveServers

Since: 0.1.0

Definition:  index.ts:616

property Cache.activeStations   ↑

Type:  ActiveStations

Since: 0.1.0

Definition:  index.ts:617

property Cache.activeTrains   ↑

Type:  ActiveTrains

Since: 0.1.0

Definition:  index.ts:618

property Cache.timetables   ↑

Type:  Timetables

Since: 0.1.0

Definition:  index.ts:619

interface Config   ↑

Specifies the configuration of the API.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/index.d.ts:96

property Config.endpoints   ↑

read-only

Specifies the configuration for API endpoints.

Type:  Endpoints

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/index.d.ts:104

interface Data   ↑

Specifies information about a train in a timetable.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:15

property Data.continuesAs   ↑

optional

Specifies under which train number the train will continue.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:17

property Data.endStation   ↑

Specifies the name of the destination station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:19

property Data.endsAt   ↑

Specifies when the train arrives at it's destination. Format: hh:mm:ss

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:21

property Data.locoType   ↑

Specifies the name of the train's locomotive.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:23

property Data.runId   ↑

Specifies the unique ID of the train. (independent from the train number)

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:25

property Data.startStation   ↑

Specifies the name of the origin station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:27

property Data.startsAt   ↑

Specifies when the train departs from it's origin. Format: hh:mm:ss

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:29

property Data.timetable   ↑

Specifies a list of timetable entries for this train.

Type:  Api.Timetable.Timetable

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:31

property Data.trainLength   ↑

Specifies the length of the train in meters.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:33

property Data.trainName   ↑

Specifies the name of the train or train series.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:35

property Data.trainNoInternational   ↑

optional

Specifies the international train number of this train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:37

property Data.trainNoLocal   ↑

Specifies the national train number of this train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:39

property Data.trainWeight   ↑

Specifies the weight of this train in metric tonnes.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:41

interface Disabled   ↑

Specifies a configuration for caching timetable data.

Since: 0.1.0

Definition:  index.ts:601

interface DispatchedBy   ↑

Specifies a player dispatching at a station in the raw API format.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:196

property DispatchedBy.ServerCode   ↑

Specifies the unique code of the server the player is using in the raw API format.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:198

property DispatchedBy.SteamId   ↑

Specifies the Steam ID of the player in the raw API format.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:200

interface Enabled   ↑

Specifies a configuration for caching timetable data.

Since: 0.1.0

Definition:  index.ts:577

property Enabled.retention   ↑

read-only optional

Specifies for how long a timetable record should be cached in seconds.

Defaults to 24 hours.

Type:  number

Since: 0.1.0

Definition:  index.ts:585

property Enabled.singleRecordOnly   ↑

read-only optional

Specifies if only one timetable record should be cached.

When set to:

• true only the last timetable record will be cached.
• false a timetable record will be cached for each server that was queried for a timetable. Use this when you are actively querying multiple servers.

Type:  boolean

Since: 0.1.0

Definition:  index.ts:597

interface Endpoints   ↑

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/index.d.ts:110

property Endpoints.liveData   ↑

read-only

Specifies the URL for the live data API endpoint.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/index.d.ts:112

property Endpoints.timetable   ↑

read-only

Specifies the URL for the timetable API endpoint.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/index.d.ts:114

interface Error   ↑

Specifies a response for a failed request.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:39

interface LiveData   ↑

Specifies a configuration for live data queries.

Since: 0.1.0

Definition:  index.ts:476

property LiveData.cache   ↑

read-only optional

Specifies a configuration for caching live data data.

Type:  Cache

Since: 0.1.0

Definition:  index.ts:478

interface Regular   ↑

Specifies a configuration of the API.

Extends

• Core
• Omit<Core.Config<true> | "convertData">

Since: 0.1.0

Definition:  index.ts:473

interface Server   ↑

Specifies a multiplayer server.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:64

Extended by:  ActiveServer

property Server.id   ↑

Specifies the unique ID of the server. (independent of code)

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:66

property Server.isActive   ↑

Specifies if the server is active.

Type:  boolean

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:68

property Server.serverCode   ↑

Specifies the unique code of the server.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:70

property Server.serverName   ↑

Specifies the name of the server.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:72

property Server.serverRegion   ↑

Specifies in which region the server is located.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:74

interface Station   ↑

Specifies an active dispatch station.

Since: 0.1.0

Definition:  index.ts:758

Extended by:  ActiveStation

property Station.code   ↑

Type:  string

Since: 0.1.0

Definition:  index.ts:759

interface Stations   ↑

Since: 0.1.0

Definition:  index.ts:643

property Stations.map   ↑

Type:  Map

Since: 0.1.0

Definition:  index.ts:644

property Stations.timestamp   ↑

Type:  number

Since: 0.1.0

Definition:  index.ts:645

interface Successful   ↑

Specfies a response for a successful request.

Type params:	Description
ResponseData	The requested data.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:47

property Successful.count   ↑

Specifies the number of results.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:49

property Successful.data   ↑

Specifies the requested data.

Type:  ResponseData

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:51

property Successful.description   ↑

Specifies a description for the response.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:53

interface Timetable   ↑

Since: 0.1.0

Definition:  index.ts:675

property Timetable.map   ↑

Type:  Map

Since: 0.1.0

Definition:  index.ts:676

property Timetable.timestamp   ↑

Type:  number

Since: 0.1.0

Definition:  index.ts:677

interface TimetableUpdated   ↑

Specifies an event that fires when cached timetable data updated.

Extends:  Base<Type.TimetableUpdated>

Since: 0.1.0

Definition:  index.ts:744

property TimetableUpdated.timetable   ↑

Type:  Data[]

Since: 0.1.0

Definition:  index.ts:745

interface Train   ↑

Specifies an active train.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:220

Extended by:  ActiveTrain

property Train.endStation   ↑

Specifies the name of the destination station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:222

property Train.id   ↑

Specifies the unique ID of the train. (independent from runId)

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:224

property Train.runId   ↑

Specifies the unique ID of this train on the timetable server. (independent from id)

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:226

property Train.serverCode   ↑

Specifies the unique code of the server the train is running on.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:228

property Train.startStation   ↑

Specifies the name of the origin station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:230

property Train.trainData   ↑

Specifies live data about the train.

Type:  TrainData

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:232

property Train.trainName   ↑

Specifies the name of the train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:234

property Train.trainNoLocal   ↑

Specifies the national train number of this train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:236

property Train.type   ↑

Specifies if this train is operated by a "bot" or a "user".

Type:  Type

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:238

property Train.vehicles   ↑

Specifies a list of vehicles of this train.

NOTE: This data hasn't be deciphered yet, if you know what this data describes please open a new issue in the project repository.

Type:  Vehicles

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:245

interface TrainData   ↑

Specifies live data about a train.

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:281

property TrainData.controlledBySteamId   ↑

optional

Specifies the Steam ID of the player controlling this train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:283

property TrainData.distanceToSignalInFront   ↑

optional

Specifies the distance to the next signal in meters.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:285

property TrainData.inBorderStationArea   ↑

Specifies if the train is in the border area of the map. (unplayable area)

Type:  boolean

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:287

property TrainData.latitude   ↑

Specifies the current global latitude of the train.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:289

property TrainData.longitude   ↑

Specifies the current global longitude of the train.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:291

property TrainData.signalInFront   ↑

optional

Specifies data about the next signal.

NOTE: This data (except for the ID prefixing the @ symbol) hasn't be deciphered yet, if you know what this data describes please open a new issue in the project repository.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:298

property TrainData.signalInFrontSpeed   ↑

optional

Specifies the track limit effective at the next signal in km/h.

Type:  SignalInFrontSpeed

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:300

property TrainData.vdDelayedTimetableIndex   ↑

Specifies the index of the current entry in this train's timetable.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:302

property TrainData.velocity   ↑

Specifies the current speed of the train.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:304

interface Trains   ↑

Since: 0.1.0

Definition:  index.ts:660

property Trains.map   ↑

Type:  Map

Since: 0.1.0

Definition:  index.ts:661

property Trains.timestamp   ↑

Type:  number

Since: 0.1.0

Definition:  index.ts:662

interface WithCore   ↑

Specifies a configuration of the API.

Extends:  Core

Since: 0.1.0

Definition:  index.ts:467

property WithCore.core   ↑

read-only

Specifies a Core API class instance.

Type:  Core<true>

Since: 0.1.0

Definition:  index.ts:469

type ActiveServers   ↑

Specifies a configuration for caching active servers.

Type:  ActiveServers.Disabled | ActiveServers.Enabled

Since: 0.1.0

Definition:  index.ts:504

type ActiveStations   ↑

Type:  { [serverCode in [LiveData.Server.ServerCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ServerCode]]: ActiveStations.Stations }

Since: 0.1.0

Definition:  index.ts:639

type ActiveTrains   ↑

Type:  { [serverCode in [LiveData.Server.ServerCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ServerCode]]: ActiveTrains.Trains }

Since: 0.1.0

Definition:  index.ts:656

type ApiResponse   ↑

Specifies a response returned by the remote API.

Type params:	Description
ResponseData	The requested data.

Type:  ApiResponse.Error | ApiResponse.Successful<ResponseData>

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:28

type ArrivalTime   ↑

Specifies when the train arrives at a point.

Type:  Timetable.ArrivalTime | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:208

type AutoUpdate   ↑

Specifies if cached data is automatically updated.

Type:  boolean

Since: 0.1.0

Definition:  index.ts:450

type AutoUpdateServer   ↑

Specifies the unique code of a server to automatically retrieve data from.

Type:  [LiveData.Server.ServerCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ServerCode]

Since: 0.1.0

Definition:  index.ts:453

type Cache   ↑

Specifies a configuration for caching timetable data.

Type:  Cache.Disabled | Cache.Enabled

Since: 0.1.0

Definition:  index.ts:564

type Code   ↑

Specifies the unique code of the dispatch station.

Type:  string

Since: 0.1.0

Definition:  index.ts:772

type Config   ↑

Specifies a configuration of the API.

Type:  Config.Regular | Config.WithCore

Since: 0.1.0

Definition:  index.ts:456

type ContinuesAs   ↑

Specifies under which train number a train will continue.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:49

type ControlledBySteamId   ↑

Specifies the Steam ID of the player controlling a train in the raw API format.

Type:  string | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:358

type Count   ↑

Specifies the number of results.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:35

type DepartureTime   ↑

Specifies when a train departs at this point.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:134

type Description   ↑

Specifies a description of a response.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:37

type DifficultyLevel   ↑

Specifies the difficulty level for a station in the raw API format. (from 1 to 5)

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:194

type DisplayedTrainNumber   ↑

Specifies which train number is displayed for a train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:136

type DistanceToSignalInFront   ↑

Specifies the distance to the next signal in meters and in the raw API format.

Type:  number | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:371

type Emitter   ↑

Specifies an API event emitter.

Type:  RXJS.Observable<Event>

Since: 0.1.0

Definition:  index.ts:721

type EndsAt   ↑

Specifies when a train arrives at it's destination. Format: hh:mm:ss

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:53

type EndStation   ↑

Specifies the name of a destination station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:51

type Event   ↑

Specifies an API event.

Type:  Event.AutoUpdateChanged | Event.ActiveServersUpdated | Event.ActiveStationsUpdated | Event.ActiveTrainsUpdated | Event.TimetableUpdated

Since: 0.1.0

Definition:  index.ts:691

type Id   ↑

Specifies the unique ID of a train. (independent from Train.RunId)

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:251

type ImageUrl   ↑

Specifies the URL of an image.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:158

type InBorderStationArea   ↑

Specifies if a train is in the border area of the map. (unplayable area)

Type:  boolean

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:312

type IsActive   ↑

Specifies if a server is active.

Type:  boolean

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:80

type Kilometrage   ↑

Specifies at what distance a point will be passed.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:144

type Latititude   ↑

Specifies the global latitude of a station in the raw API format.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:207

type Latititute   ↑

Specifies the current global latitude of a train in the raw API format.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:360

type Latitude   ↑

Specifies the current global latitude of a train.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:314

type Line   ↑

Specifies the number of the line that a train will follow.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:138

type List   ↑

Specifies a list of active dispatch stations.

Type:  Station[]

Since: 0.1.0

Definition:  index.ts:774

type LocoType   ↑

Specifies the name of a train's locomotive.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:55

type Longitude   ↑

Specifies the current global longitude of a train.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:316

type Longitute   ↑

Specifies the current global longitude of a train in the raw API format.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:362

type Map   ↑

Type:  { [trainNumber in [LiveData.Train.TrainNoLocal][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainNoLocal]]: Api.Timetable.Data }

Since: 0.1.0

Definition:  index.ts:680

type MaxSpeed   ↑

Specifies the maximum speed at a point.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:142

type Mileage   ↑

Specifies at what distance a point will be passed in kilometers.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:212

type Name   ↑

Specifies the name of a station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:166

type NameForPerson   ↑

Specifies the name of the dispatcher for a point.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:146

type NameOfPoint   ↑

Specifies the name of a point.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:148

type NoCache   ↑

Specifies if a cached result can be returned.

Type:  boolean

Since: 0.1.0

Definition:  index.ts:779

type Platform   ↑

Specifies at which platform a train will stop in Roman numerals.

Type:  Timetable.Platform | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:218

type PointId   ↑

Specifies the unique ID of a point.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:156

type Prefix   ↑

Specifies the prefix of a station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:168

type RadioChannel   ↑

Specifies a radio channel.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:162

type RadioChannels   ↑

Specifies the radio channels required after a point as a comma-separated string.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:224

type Result   ↑

Specifies if a request succeeded.

Type:  boolean

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:41

type Retention   ↑

Specifies for how long a timetable record is cached in seconds.

Type:  number

Since: 0.1.0

Definition:  index.ts:604

type RunId   ↑

Specifies the unique ID of a train. (independent from the train number)

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:57

type ServerCode   ↑

Specifies the unique code of a timetable server.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:59

type ServerName   ↑

Specifies the name of a server.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:86

type ServerRegion   ↑

Specifies in which region a server is located.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:88

type SignalInFront   ↑

Specifies data about the next signal in the raw API format.

NOTE: This data (except for the ID prefixing the @ symbol) hasn't be deciphered yet, if you know what this data describes please open a new issue in the project repository.

Type:  string | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:369

type SignalInFrontSpeed   ↑

Specifies the track limit effective at the next signal in km/h and in the raw API format.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:373

type SingleRecordOnly   ↑

Specifies if only one timetable record should be cached.

Type:  boolean

Since: 0.1.0

Definition:  index.ts:607

type StartsAt   ↑

Specifies when a train departs from it's origin. Format: hh:mm:ss

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:63

type StartStation   ↑

Specifies the name of an origin station.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:61

type StationCategory   ↑

Specifies the category of a station.

Type:  Timetable.StationCategory | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:226

type SteamId   ↑

Specifies the Steam ID of a player.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:153

type StopType   ↑

Specifies the type of stop a train will make.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:228

type SupervisedBy   ↑

Specifies the name of the dispatch station a point belongs to.

Type:  Timetable.SupervisedBy | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:230

type Timestamp   ↑

Type:  number

Since: 0.1.0

Definition:  index.ts:686

type Timetables   ↑

Type:  { [serverCode in [LiveData.Server.ServerCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ServerCode]]: Timetables.Timetable }

Since: 0.1.0

Definition:  index.ts:671

type Track   ↑

Specifies the number of the track a train will stop at.

Type:  Timetable.Track | null

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:232

type TrainLength   ↑

Specifies the length of a train in meters.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:65

type TrainName   ↑

Specifies the name of a train or train series.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:67

type TrainNoInternational   ↑

Specifies the international train number of a train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:69

type TrainNoLocal   ↑

Specifies the national train number of a train.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:71

type TrainType   ↑

Specifies the name of a train series.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:178

type TrainWeight   ↑

Specifies the weight of a train in metric tonnes.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts:73

type Type   ↑

Specifies the type of train operator in the raw API format. ("bot" or "user")

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:408

type Url   ↑

Specifies an API endpoint URL.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/index.d.ts:118

type VdDelayedTimetableIndex   ↑

Specifies the index of the current entry in a train's timetable.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:327

type Vehicle   ↑

Specifies data about a vehicle of a train.

NOTE: This data hasn't be deciphered yet, if you know what this data describes please open a new issue in the project repository.

Type:  string

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:272

type Vehicles   ↑

Specifies a list of vehicles of a train.

NOTE: This data hasn't be deciphered yet, if you know what this data describes please open a new issue in the project repository.

Type:  Vehicles[]

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:279

type Velocity   ↑

Specifies the current speed of a train.

Type:  number

Since: 0.1.0

Definition:  node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts:329

type Version   ↑

Specifies the version of the API.

Type:  `${number}.${number}.${number}` | `${number}.${number}.${number}-${string}`

Since: 0.1.0

Definition:  index.ts:782

About this module

Package name: @simrail-sdk/api

Author: Niek van Bennekom

Version: 0.1.1

Repository: github:simrail-sdk/api (origin)

Keywords: simrail, sdk, api, rest.

View license   |   view open source licenses

SCTL version: 0.1.11-dev

Module dependencies

Module package dependencies

Production packages: (3)

• @simrail-sdk/api-core-node: SimRail SDK - API Core for Node.JS.

• remove-accents: Converting the accented characters to their corresponding non-accented ASCII characters.

• rxjs: Reactive Extensions for modern JavaScript.

Development packages: (2)

• @types/node: TypeScript definitions for node.

• typescript: TypeScript is a language for application scale JavaScript development.

Internal module dependencies

This module contains and uses the following internal modules:

• index.js

Dependency tree:

Module code statistics

File type	Number of files	Lines with code	Lines with comments	Blank lines
Markdown	3	3558	0	2300
TypeScript	8	793	556	199
JavaScript	7	497	7	0
JSON	3	123	0	1
YAML	1	50	0	3
All (total)	22	5021	563	2503