Skip to main content

Rail Deck is being prepared for an invitation-only Alpha. Check current availability

Developer documentation

Find your railway feature

Find JavaScript calls and workflows for your railway feature.

Source 0.1.0 Private source package

Browse SDK features

Connect and get access

API and sign-in configuration

Read the identity and API configuration before choosing an approved integration flow.

1 method example and a workflow

Operator and preferences

Read the signed-in person and their appearance preferences.

4 method examples and a workflow

Account access

Check the current Product access decision for an account.

1 method example and a workflow

Build your railway and collection

Layouts

Find, create and maintain a railway layout and its library order.

8 method examples and a workflow

Product and decoder catalogue

Find product and decoder profiles before applying them to your collection.

4 method examples and a workflow

Locomotives

Manage locomotives, layout assignments, groups and saved driving settings.

22 method examples and a workflow

Rolling stock

Maintain rolling stock, pictures, catalogue choices and layout assignments.

12 method examples and a workflow

Saved trains

Build formations, set driving profiles, group functions and assign trains to layouts.

17 method examples and a workflow

Read state and operate

Layout state

Read a decoded snapshot with account and layout scope, cancellation and a bounded timeout.

1 method example and a workflow

Train and accessory commands

Submit locomotive, function, accessory and emergency Stop requests and recover original accessory outcomes.

5 method examples and a workflow

Track power

Read and deliberately change a controller’s track-power scope.

2 method examples and a workflow

Speed limits and operating rules

Preview the speed envelope and explanation for a chosen locomotive and train.

1 method example and a workflow

Locomotive functions

Define, arrange and copy locomotive functions.

7 method examples and a workflow

CVs and programming

Read saved CV values, tuning, programming presets and batch progress.

17 method examples and a workflow

Locomotive matching

Review independent saved comparisons between locomotives.

4 method examples and a workflow

Points, signals and lights

Manage accessory records, configurations, specifications and ordering.

29 method examples and a workflow

Guided signal setup

Start, inspect, try, cancel and save a signal setup.

5 method examples and a workflow

Routes and linked accessories

Build saved routes and linked arrangements, then review activation separately.

17 method examples and a workflow

Personalise and share

Personal favourites

Keep personal shortcuts and their order with the selected layout.

2 method examples and a workflow

Pictures and media

Manage media assets, approved uploads and links to railway items.

11 method examples and a workflow

Events and exhibitions

Manage event readiness, layout assignments and guest QR sessions.

17 method examples and a workflow

Sharing and guest access

Manage layout invitations, members, share groups and guest access.

22 method examples and a workflow

Connect equipment

Command stations

Read and maintain command-station records for a layout.

6 method examples and a workflow

Bridge management

Read bridge records, status and retirement consequences.

7 method examples and a workflow

Physical controls

Manage paired controls, shared quick lists, personal profiles and assistive outputs.

15 method examples and a workflow

External displays

Manage assigned displays and inspect their diagnostics.

6 method examples and a workflow

Go from one call to a workflow

Start with a short JavaScript call. Each feature also includes parameter and return-type details, downloadable TypeScript examples and a complete workflow.

Information reviewed .