@simrail-sdk/api

v0.1.1

Published

a year ago

SimRail SDK - API

0High
0Medium
0Low

niekvb

simrail sdk api rest

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
API reference
[About this module][about-this-module]
- [Module dependencies][module-dependencies]
  - [Module package dependencies][module-package-dependencies]
  - [Internal module dependencies][internal-module-dependencies]
- [Module code statistics][module-code-statistics]

Usage details

Installation

Using NPM:

$ npm i @simrail-sdk/api

$ 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][api-reference-index.ts~Cache]
- [property Cache.activeServers][api-reference-index.ts~Cache.activeServers]
- [property Cache.activeStations][api-reference-index.ts~Cache.activeStations]
- [property Cache.activeTrains][api-reference-index.ts~Cache.activeTrains]
- [property Cache.timetables][api-reference-index.ts~Cache.timetables]
[interface Config][api-reference-node_modules/@simrail-sdk/api-core-node/index.d.ts~Config]
- [property Config.endpoints][api-reference-node_modules/@simrail-sdk/api-core-node/index.d.ts~Config.endpoints]
[interface Data][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data]
- [property Data.continuesAs][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.continuesAs]
- [property Data.endStation][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.endStation]
- [property Data.endsAt][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.endsAt]
- [property Data.locoType][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.locoType]
- [property Data.runId][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.runId]
- [property Data.startStation][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.startStation]
- [property Data.startsAt][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.startsAt]
- [property Data.timetable][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.timetable]
- [property Data.trainLength][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.trainLength]
- [property Data.trainName][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.trainName]
- [property Data.trainNoInternational][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.trainNoInternational]
- [property Data.trainNoLocal][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.trainNoLocal]
- [property Data.trainWeight][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Data.trainWeight]
[interface Disabled][api-reference-index.ts~Disabled]
[interface DispatchedBy][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~DispatchedBy]
- [property DispatchedBy.ServerCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~DispatchedBy.ServerCode]
- [property DispatchedBy.SteamId][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~DispatchedBy.SteamId]
[interface Enabled][api-reference-index.ts~Enabled]
- [property Enabled.retention][api-reference-index.ts~Enabled.retention]
- [property Enabled.singleRecordOnly][api-reference-index.ts~Enabled.singleRecordOnly]
[interface Endpoints][api-reference-node_modules/@simrail-sdk/api-core-node/index.d.ts~Endpoints]
- [property Endpoints.liveData][api-reference-node_modules/@simrail-sdk/api-core-node/index.d.ts~Endpoints.liveData]
- [property Endpoints.timetable][api-reference-node_modules/@simrail-sdk/api-core-node/index.d.ts~Endpoints.timetable]
[interface Error][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Error]
[interface LiveData][api-reference-index.ts~LiveData]
- [property LiveData.cache][api-reference-index.ts~LiveData.cache]
[interface Regular][api-reference-index.ts~Regular]
[interface Server][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Server]
- [property Server.id][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Server.id]
- [property Server.isActive][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Server.isActive]
- [property Server.serverCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Server.serverCode]
- [property Server.serverName][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Server.serverName]
- [property Server.serverRegion][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Server.serverRegion]
[interface Station][api-reference-index.ts~Station]
- [property Station.code][api-reference-index.ts~Station.code]
[interface Stations][api-reference-index.ts~Stations]
- [property Stations.map][api-reference-index.ts~Stations.map]
- [property Stations.timestamp][api-reference-index.ts~Stations.timestamp]
[interface Successful][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Successful]
- [property Successful.count][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Successful.count]
- [property Successful.data][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Successful.data]
- [property Successful.description][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Successful.description]
[interface Timetable][api-reference-index.ts~Timetable]
- [property Timetable.map][api-reference-index.ts~Timetable.map]
- [property Timetable.timestamp][api-reference-index.ts~Timetable.timestamp]
[interface TimetableUpdated][api-reference-index.ts~TimetableUpdated]
- [property TimetableUpdated.timetable][api-reference-index.ts~TimetableUpdated.timetable]
[interface Train][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train]
- [property Train.endStation][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.endStation]
- [property Train.id][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.id]
- [property Train.runId][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.runId]
- [property Train.serverCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.serverCode]
- [property Train.startStation][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.startStation]
- [property Train.trainData][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.trainData]
- [property Train.trainName][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.trainName]
- [property Train.trainNoLocal][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.trainNoLocal]
- [property Train.type][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.type]
- [property Train.vehicles][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Train.vehicles]
[interface TrainData][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData]
- [property TrainData.controlledBySteamId][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.controlledBySteamId]
- [property TrainData.distanceToSignalInFront][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.distanceToSignalInFront]
- [property TrainData.inBorderStationArea][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.inBorderStationArea]
- [property TrainData.latitude][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.latitude]
- [property TrainData.longitude][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.longitude]
- [property TrainData.signalInFront][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.signalInFront]
- [property TrainData.signalInFrontSpeed][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.signalInFrontSpeed]
- [property TrainData.vdDelayedTimetableIndex][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.vdDelayedTimetableIndex]
- [property TrainData.velocity][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~TrainData.velocity]
[interface Trains][api-reference-index.ts~Trains]
- [property Trains.map][api-reference-index.ts~Trains.map]
- [property Trains.timestamp][api-reference-index.ts~Trains.timestamp]
[interface WithCore][api-reference-index.ts~WithCore]
- [property WithCore.core][api-reference-index.ts~WithCore.core]
type ActiveServers
[type ActiveStations][api-reference-index.ts~ActiveStations]
[type ActiveTrains][api-reference-index.ts~ActiveTrains]
[type ApiResponse][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ApiResponse]
[type ArrivalTime][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~ArrivalTime]
[type AutoUpdate][api-reference-index.ts~AutoUpdate]
[type AutoUpdateServer][api-reference-index.ts~AutoUpdateServer]
[type Cache][api-reference-index.ts~Cache]
[type Code][api-reference-index.ts~Code]
[type Config][api-reference-index.ts~Config]
[type ContinuesAs][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~ContinuesAs]
[type ControlledBySteamId][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ControlledBySteamId]
[type Count][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Count]
[type DepartureTime][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~DepartureTime]
[type Description][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Description]
[type DifficultyLevel][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~DifficultyLevel]
[type DisplayedTrainNumber][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~DisplayedTrainNumber]
[type DistanceToSignalInFront][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~DistanceToSignalInFront]
[type Emitter][api-reference-index.ts~Emitter]
[type EndsAt][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~EndsAt]
[type EndStation][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~EndStation]
[type Event][api-reference-index.ts~Event]
[type Id][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Id]
[type ImageUrl][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ImageUrl]
[type InBorderStationArea][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~InBorderStationArea]
[type IsActive][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~IsActive]
[type Kilometrage][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Kilometrage]
[type Latititude][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Latititude]
[type Latititute][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Latititute]
[type Latitude][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Latitude]
[type Line][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Line]
[type List][api-reference-index.ts~List]
[type LocoType][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~LocoType]
[type Longitude][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Longitude]
[type Longitute][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Longitute]
[type Map][api-reference-index.ts~Map]
[type MaxSpeed][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~MaxSpeed]
[type Mileage][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Mileage]
[type Name][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Name]
[type NameForPerson][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~NameForPerson]
[type NameOfPoint][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~NameOfPoint]
[type NoCache][api-reference-index.ts~NoCache]
[type Platform][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Platform]
[type PointId][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~PointId]
[type Prefix][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Prefix]
[type RadioChannel][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~RadioChannel]
[type RadioChannels][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~RadioChannels]
[type Result][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Result]
[type Retention][api-reference-index.ts~Retention]
[type RunId][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~RunId]
[type ServerCode][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~ServerCode]
[type ServerName][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ServerName]
[type ServerRegion][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~ServerRegion]
[type SignalInFront][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~SignalInFront]
[type SignalInFrontSpeed][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~SignalInFrontSpeed]
[type SingleRecordOnly][api-reference-index.ts~SingleRecordOnly]
[type StartsAt][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~StartsAt]
[type StartStation][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~StartStation]
[type StationCategory][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~StationCategory]
[type SteamId][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~SteamId]
[type StopType][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~StopType]
[type SupervisedBy][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~SupervisedBy]
[type Timestamp][api-reference-index.ts~Timestamp]
[type Timetables][api-reference-index.ts~Timetables]
[type Track][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~Track]
[type TrainLength][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~TrainLength]
[type TrainName][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~TrainName]
[type TrainNoInternational][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~TrainNoInternational]
[type TrainNoLocal][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~TrainNoLocal]
[type TrainType][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~TrainType]
[type TrainWeight][api-reference-node_modules/@simrail-sdk/api-core-node/types/timetable/index.d.ts~TrainWeight]
[type Type][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Type]
[type Url][api-reference-node_modules/@simrail-sdk/api-core-node/index.d.ts~Url]
[type VdDelayedTimetableIndex][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~VdDelayedTimetableIndex]
[type Vehicle][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Vehicle]
[type Vehicles][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~Vehicles]
[type Velocity][api-reference-node_modules/@simrail-sdk/api-core-node/types/liveData/index.d.ts~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][api-reference-index.ts~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][api-reference-index.ts~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][api-reference-index.ts~Emitter]

Since: 0.1.0

Definition: index.ts:38

`property Api.autoUpdate` ↑

Since: 0.1.0

Definition: index.ts:73