Stations

As the organizing structure of Lux's ecosystem, stations are central to our multiplayer internet experience. Each station represents a distinct origin (like youtube.com, twitch.tv) that wraps around channels and transforms static websites into vibrant, interactive spaces. This page details the various station endpoints you can leverage to manage these wrappers programmatically. We'll explore how to query, create, update, and delete stations within the Lux environment.

The station model

The station model encompasses all essential information about a Lux station, including its origin, associated channels, and customization options. It maintains references to all user interactions happening within that domain and tracks activity metrics across the Lux network, enabling seamless multiplayer experiences throughout specific websites. Stations serve as containers that organize and enhance the browsing experience within particular domains of the web.

Properties

Name
id
Type
string
Description
Unique identifier for the station.
Name
name
Type
string
Description
The customizable name of the station.
Name
origin
Type
string
Description
The unique origin for the station.
Name
flags
Type
integer
Description
The public flags for the station.
Name
created_at
Type
timestamp
Description
Timestamp of when the station was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the station was last updated.

GET/v1/stations/:station_id

Get a station

This endpoint allows you to retrieve a station by providing its Lux id. Refer to the properties list at the top of this page to see which properties are included with station objects.

Request

GET

/v1/stations/1344387816333352652

curl https://api.lux.gg/v1/stations/1344387816333352652 \
  -H "Authorization: {token}"

Response

{
  "id": "1344387816333352652",
  "name": "Lux",
  "origin": "https://lux.gg/",
  "flags": null,
  "created_at": 2025-02-26 19:17:12.848375,
  "updated_at": 2025-02-26 19:17:12.848375
}

POST/v1/stations

Create a station

This endpoint allows you to create a new station for a origin.

Required attributes

Name
origin
Type
string
Description
Unique identifier for the station.

Request

POST

/v1/stations

curl https://api.lux.gg/v1/stations \
  -H "Authorization: {token}" \
  -d origin="https://lux.gg/"

Response

{
  "id": "1344387816333352652",
  "name": "New Station",
  "origin": "https://lux.gg/",
  "flags": null,
  "created_at": 2025-02-26 19:17:12.848375,
  "updated_at": 2025-02-26 19:17:12.848375
}