Skip to content

Instantly share code, notes, and snippets.

@Nithanim

Nithanim/oebb-live.openapi.yml

Created May 26, 2022 19:20
Show Gist options
  • Save Nithanim/a39bf84984f4288714dc7916680ebd35 to your computer and use it in GitHub Desktop.
Save Nithanim/a39bf84984f4288714dc7916680ebd35 to your computer and use it in GitHub Desktop.
Download ZIP
ÖBB live openapi schema
Raw
oebb-live.openapi.yml
openapi: 3.0.3
info:
title: OEBB LIVE
version: '1'
servers:
- url: https://live.oebb.at/
paths:
/backend/info:
get:
parameters:
- in: query
name: trainNr
example: "5912"
required: true
schema:
type: integer
- in: query
name: station
required: true
schema:
type: string
example: "8100013"
- in: query
name: date
required: true
schema:
type: string
format: date
example: "2022-05-26"
responses:
200:
description: 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/TrainInfo'
/assets/assets/stations.json:
get:
responses:
200:
description: 200 response
content:
application/json:
schema:
type: array
items:
type: object
properties:
eva:
type: string
example: "8100013"
name:
type: string
example: "Linz/Donau Hbf"
components:
schemas:
TrainInfo:
title: Result
type: object
properties:
timeTableInfo:
type: object
properties:
date:
type: string
format: date
example: "2022-05-27"
trainNr:
type: integer
example: 61
trainName:
type: string
example: "RJX 61"
stationName:
type: string
example: "Linz/Donau Hbf"
platform:
type: object
properties:
scheduled:
type: integer
example: 7
sectors:
type: object
properties:
scheduled:
type: string
example: "A-F"
time:
type: object
properties:
scheduled:
type: object
properties:
days:
type: integer
example: 0
hours:
type: integer
example: 10
minutes:
type: integer
example: 16
portions:
type: array
description: "Lists all trains that are linked together and are used/move as a single unit. Other trains that are not part of the query might have reduced infos. E.g. the 'load' section has only data about the queried train, not the others."
items:
type: object
properties:
trainNr:
type: integer
example: 861
trainName:
type: string
example: "RJX 861"
stops:
type: array
items:
type: string
example: "8098262"
train:
type: object
properties:
trainNr:
type: integer
example: 61
date:
type: string
format: date
example: "2022-05-27"
version:
type: integer
example: 0
isReported:
type: boolean
example: false
assemblyStation:
type: string
example: "SB"
source:
type: string
example: "1_PV-61-00-Sb-8101114_31519231185_20220524_1739_Plan_PTCP_IN_653631.XML"
seasoning:
type: object
properties:
startDate:
type: string
format: date
example: "2021-12-12"
seasoningString:
type: string
example: "7123456712345881234587123856712345671234567123456712345671234567123456712345671234567123456712345671234567123456712345671234568823456712345681234567123456712345671238567123456882345671238567123456712345671234567123456712345671234567123456712345678234567123456712345671234567123456712345671234567123456712345671234567128456718345671234567123456712345671234567123856"
wagons:
type: array
description: "Holds all individual wagons that make up the whole train compound, not only the queried train."
items:
type: object
properties:
uicNumber:
type: string
example: "738180907000"
kind:
type: string
example: "Afmpz"
origin:
type: string
example: "80MH"
destination:
type: string
example: "55SU"
ranking:
type: integer
example: 27
capacityBusinessClass:
type: integer
example: 16
capacityFirstClass:
type: integer
example: 27
capacitySecondClass:
type: integer
example: 0
capacityCouchette:
type: integer
example: 0
capacitySleeper:
type: integer
example: 0
capacityWheelChair:
type: integer
example: 0
capacityBicycle:
type: integer
example: 0
isBicycleAllowed:
type: boolean
example: false
isWheelChairAccessible:
type: boolean
example: false
hasWifi:
type: boolean
example: false
isInfoPoint:
type: boolean
example: false
isPlayZone:
type: boolean
example: false
isChildCinema:
type: boolean
example: false
isDining:
type: boolean
example: false
isQuietZone:
type: boolean
example: false,
isLowFloor:
type: boolean
example: false
isLocked:
type: boolean
example: false
destinationName:
type: string
example: "Budapest Keleti"
lengthOverBuffers:
type: number
example: 26.9
originTime:
type: string
format: datetime
example: "2022-05-25T07:24:00"
destinationTime:
type: string
format: datetime
example: "2022-05-25T14:19:00"
seasoning:
type: object
properties:
startDate:
type: string
format: date
example: "2021-12-12"
seasoningString:
type: string
example: "7123456712345881234587123856712345671234567123456712345671234567123456712345671234567123456712345671234567123456712345671234568823456712345681234567123456712345671238567123456882345671238567123456712345671234567123456712345671234567123456712345678234567123456712345671234567123456712345671234567123456712345671234567128456718345671234567123456712345671234567123856"
trainOnPlatform:
type: object
properties:
position:
type: number
example: 27.509999999999998
departureTowardsFirstSector:
type: boolean
example: true
load:
type: object
properties:
stats:
type: array
description: "Seems to hold the percentage (0 to 1) of reserved seats. Only contains the wagons of the queried train, not the whole compound."
items:
type: object
properties:
ranking:
type: integer
example: 27
designation:
type: string
example: "RG000"
ratio:
type: number
example: 0.6222222222222221
station:
type: string
example: "8100013"
timestamp:
type: string
format: datetime
example: "2022-05-20T11:00:18"
platform:
type: object
properties:
platform:
type: integer
example: 7
length:
type: number
example: 499.85999999999996
sectors:
type: array
items:
type: object
properties:
name:
type: string
example: "A"
length:
type: number
example: 82.53
egresses:
type: array
items:
type: object
properties:
platform:
type: string
example: "7"
distance:
type: number
example: 81.12
name:
type: string
description: "Warning: names are not unique! The same name can occur multiple times in the same array."
example:
- "AUFZUG_LZ"
- "ROLLTREPPE_LZ"
- "ROLLTREPPE_LZ_RUNTER"
- "STIEGENAUFGANG_LZ"
type:
type: string
example:
- "AUFZUG"
- "ROLLTREPPE"
- "STIEGENAUFGANG"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment