Global

Methods

createBoundingBox(minLat, maxLat, minLng, maxLng) → {BoundingBox|undefined}

Creates a bounding box to be used in API Calls
Parameters:
Name Type Description
minLat Number Smallest latitude to use
maxLat Number Largest latitude to use
minLng Number Smallest longitude to use
maxLng Number Largest longitude to use
Source:
Returns:
- A BoundingBox Object to use in the boundingBox parameters of API Calls, or undefined if not all parameters are given.
Type
BoundingBox | undefined

Type Definitions

AdminAreaObject

Contains ATCO Codes and Admin Area names
Type:
  • Object
Properties:
Name Type Description
atco_code String The ATCO code for the area - See https://mullinscr.github.io/naptan/atco_codes/#lookup-table
name String The name of the area
Source:

Agency

An object containing information on an agency
Type:
  • Object
Properties:
Name Type Description
agency_id String The ID of the agency
agency_name String The name of the agency
agency_url String The related URL. Many (if not all) of these link to traveline.
agency_timezone String Timezone data, in the IANA TZDB format.
agency_lang String ISO 639-1 code for the agency's main language
agency_phone String Phone number for the agency
agency_noc String National Operator Code for this agency
Source:

BoundingBox

A bounding box to be used in the boundingBox API call parameter
Type:
  • Object
Properties:
Name Type Description
minLat Number Smallest latitude in the selection
maxLat Number Largest latitude in the selection
minLng Number Smallest longitude in the selection
maxLng Number Largest longitude in the selection
Source:

BusLocationDatafeedOptions

Type:
  • Object
Properties:
Name Type Attributes Description
boundingBox BoundingBox <optional>
 Limit results to fares data sets that contain information for the area within the rectangular boundingBox you set using `require("bodsjs").createBoundingBox()`.
operatorRef String <optional>
 Limit results to data feeds with the operatorRef. The National Operator Code is often used by publishers as the input for operatorRef, which can be found on the Traveline website, https://www.travelinedata.org.uk/traveline-open-data/transport-operations/about-2/
lineRef String <optional>
 Limit results to bus location data with the specified Line Ref.
producerRef String <optional>
 Limit results to bus location data with the specified Producer Ref.
originRef String <optional>
 Limit results to bus location data with the specified Origin Ref. Inputs for Origin Ref are normally National Public Transport Access Nodes (NaPTAN), which can be found on the following website: https://data.gov.uk/dataset/ff93ffc1-6656-47d8-9155-85ea0b8f2251/national-public-transport-access-nodes-naptan
destinationRef String <optional>
 Limit results to bus location data with the specified Destination Ref. Inputs for Destination Ref are normally National Public Transport Access Nodes (NaPTAN), which can be found on the following website: https://data.gov.uk/dataset/ff93ffc1-6656-47d8-9155-85ea0b8f2251/national-public-transport-access-nodes-naptan
vehicleRef String <optional>
 Limit results to bus location data with the specified vehicleRef. The vehicleRef is a unique reference for the vehicle that is consistent and is generated by the vehicle equipment.
Source:

BusLocationDataset

Data containing location and other data for a bus
Type:
  • Object
Properties:
Name Type Description
RecordedAtTime String String containing date/time when the data was last recorded
ItemIdentifier String String containing UUID that identifies this data
ValidUntilTime String String containing date/time of when this data expires
MonitoredVehicleJourney Object Contains information about the ongoing bus journey
Properties
Name Type Description
LineRef String String containing the line number this bus is operating on
DirectionRef String The direction the bus is going. Usually "outbound" or "inbound"
FramedVehicleJourneyRef Object Contains date information for this journey
Properties
Name Type Description
DataFrameRef String
DatedVehicleJourneyRef String
PublishedLineName String The published name of the line the bus is operating on
OperatorRef String The operator running this bus journey
OriginRef String The NAPTAN code for the stop/stand this journey started at
OriginName String The name of the stop that this journey started at. May not include the full stop name!
DestinationRef String The NAPTAN code for the stop/stand this journey will terminate at
DestinationName String The name of the stop that this journey will terminate at. May not include the full stop name!
OriginAimedDepartureTime String String containing date/time when the bus was due to leave its origin
DestinationAimedArrivalTime String String containing date/time when the bus was due to arrive at its destination
VehicleLocation Object Object containing latitude and longitude of the buses
Properties
Name Type Description
Longitude String String containing number of the current longitude of the bus
Latitude String String containing number of the current latitude of the bus
Bearing String The current bearing/direction of the bus.
BlockRef String
VehicleRef String The number of the vehicle
Extensions Object Additional information about this bus
Source:

FaresDatasetOptions

Type:
  • Object
Properties:
Name Type Attributes Description
noc String <optional>
 Input a comma separated list of National Operator Codes to limit results to data sets of the publishers associated to the specified National Operator Code. A publisher may have multiple National Operator Codes associated with it. Your response will include data for all National Operator Codes associated with that publisher. Not just those included in the query parameter. National Operator codes can be found on the Traveline website, https://www.travelinedata.org.uk/traveline-open-data/transport-operations/about-2/
status 'published' | 'inactive' <optional>
 Limit results to data sets with the specified status String, accepted values are published, inactive.
boundingBox BoundingBox <optional>
 Limit results to fares data sets that contain information for the area within the rectangular boundingBox you set using `require("bodsjs").createBoundingBox()`.
limit Number <optional>
 The maximum number of records to return.
offset Number <optional>
 Return results that match the query starting from the specified offset. e.g. &offset=10&limit=25 returns results from 11 to 35. The default is set to 0.
Source:

LocalityObject

Type:
  • Object
Properties:
Name Type Description
gazetteer_id String The National Public Transport Gazeteer (NPTG) ID that relates to the locality
name String The locality name
Source:

Route

An object containing information about a bus route
Type:
  • Object
Properties:
Name Type Description
route_id Number The ID of this route
agency_id String The ID of the agency operating this route
route_short_name String The shortened name of this route (E.G `X17`)
route_long_name String The longer name of this route (often not provided).
route_type Number An integer determining the type of route.
Source:

Shape

An array of individual shape points
Type:
Source:

ShapePoint

An object containing information about a bus route shape. This is not the whole shape, but a single point along it.
Type:
  • Object
Properties:
Name Type Description
id Number A unique ID for this entry
shape_id String The ID of the shape this entry belongs to
shape_pt_lat Number The latitude of this point
shape_pt_lon Number The longitude of this point
shape_pt_sequence Number Where in the sequence of all ShapePoints this point comes (zero-indexed).
shape_dist_travelled String The distance from the start of the shape (often not provided).
Source:

Stop

An object containing information about a stop
Type:
  • Object
Properties:
Name Type Description
stop_id String The BODS stop ID
stop_code String The printed stop ID, often presented on signage for easier reading
stop_name String The name of this stop.
stop_lat Number The latitude of this stop
stop_long Number The longitude of this stop
wheelchair_boarding Boolean If this stop allows for wheelchair boarding (false may mean no data provided, which is often the case)
location_type location_type The type of location this stop is
parent_station String The BODS Stop ID of the station that contains this stop
platform_code String The code for this platform (within a station) - E.G "A"
Source:

StopTime

An object containing information about a time when a bus stops along a trip
Type:
  • Object
Properties:
Name Type Description
id Number A unique ID for this entry
trip_id String The ID of the trip that stops here
arrival_time Date The time the bus is due to arrive at the stop
departure_time Date The time the bus is due to leave the stop
stop_id String The ID of the stop this bus uses on this trip
stop_sequence Number Determines the order this stop comes on this trip (zero-indexed)
stop_headsign String What the bus headsign should display at this stop
pickup_type pickup_type If and how this stop boards passengers
drop_off_type drop_off_type If passengers can alight at this stop
shape_dist_travelled String The distance along the trip this stop can be found at (often not provided).
timepoint Boolean If this stop is a timing point (bus will stop and wait if early)
stop_direction_name String The direction buses go from this stop (often not provided).
Source:

TimetableDatasetOptions

Type:
  • Object
Properties:
Name Type Attributes Description
adminArea Number <optional>
 adminArea is a field within the data, and therefore if any of the TransXChange files within a specific data set has the specified adminArea the whole data set will be returned. A list of adminAreas can be found on the NPTG website: https://data.gov.uk/dataset/3b1766bf-04a3-44f5-bea9-5c74cf002e1d/national-public-transport-gazetteer-nptg
endDateStart Date | String <optional>
 Limit results to data sets with services with end dates after this date. String formatted as YYYY-MM-DDTHH:MM:SS.
endDateEnd Date | String <optional>
 Limit results to data sets with services with end dates before this date. String formatted as YYYY-MM-DDTHH:MM:SS.
limit Number <optional>
 The maximum number of records to return.
modifiedDate Date | String <optional>
 Limit results to data sets that have been created/updated since the specified date. String formatted as YYYY-MM-DDTHH:MM:SS.
noc Array.<String> | String <optional>
 Input a comma separated list of (or array of strings including) National Operator Codes to limit results to data sets of the publishers associated to the specified National Operator Code. A publisher may have multiple National Operator Codes associated with it. Your response will include data for all National Operator Codes associated with that publisher. Not just those included in the query parameter. National Operator codes can be found on the Traveline website, https://www.travelinedata.org.uk/traveline-open-data/transport-operations/about-2/
offset Number <optional>
 Return results that match the query starting from the specified offset. e.g. &offset=10&limit=25 returns results from 11 to 35. The default is set to 0.
search String <optional>
 Return data sets where the data set name, data set description, organisation name, or admin area name contain the specified value.
status 'published' | 'inactive' <optional>
 Limit results to data sets with the specified status String, accepted values are published, inactive.
startDateStart Date | String <optional>
 Limit results to data sets with services with start dates after this date. String formatted as YYYY-MM-DDTHH:MM:SS.
startDateEnd Date | String <optional>
 Limit results to data sets with services with start dates before this date. String formatted as YYYY-MM-DDTHH:MM:SS.
datasetID String <optional>
 Limit results to a specific data set of a publisher using the data set ID.
dqRag 'red' | 'amber' | 'green' <optional>
 Data rating. Limit results to data sets with the specified String value, accepted values are red, amber, green.
bodsCompliance Boolean <optional>
 Is BODS compliant. Limit results to data sets with the specified boolean value.
Source:

TimetableDatasetResponse

Type:
  • Object
Properties:
Name Type Description
count Number The number of entries found
results Array.<TimetableDatasetResponseResult> Array of the found entries
Source:

TimetableDatasetResponseResult

Type:
  • Object
Properties:
Name Type Description
id Number The timetable entry ID
created String The time the timetable entry was created
modified String The last time the timetable entry was updated/edited
operatorName String The name of the bus company who operates the lines in this entry
noc Array.<String> An array containing the National Operator Codes linked to this entry
name String The name of this timetable dataset entry
description String The description of this timetable dataset entry
comment String Additional comment to this dataset
status 'inactive' | 'published' The status of this dataset entry - published or inactive
url String The URL to download this dataset entry
extension String The file type/extension of the file located at the URL (see url property)
lines Array.<String> An array containing a list of line numbers/names this affects
firstStartDate String
lastStartDate String
lastEndDate String
adminAreas AdminAreaObject Array containing objects with ATCO Codes and area names. Often relates to a region of the UK
locaities LocalityObject Array containing objects with NPTG IDs and their names. Often relates to a local area.
dqScore String How compliant the data is with the BODS standard. Given as a number and % sign
dqRag 'red' | 'amber' | 'green' The rating based upon the BODS data standard score. Either "red", "amber" or "green"
bodsCompliance Boolean Whether the dataset is compliant with the BODS standards. Using data that isn't is not recommended
Source:

Trip

An object containing information about a bus trip along a route
Type:
  • Object
Properties:
Name Type Description
route_id Number The ID of the route this bus is travelling along
service_id Number The ID of the service that this bus is operating on (obsolete due to no calendar files provided)
trip_id String The ID of this trip
trip_headsign String What the bus headsign should display for this trip (should be overrided by the StopTime stop_headsign property as it arrives at that stop)
direction_id Number Direction of travel (0 = outbound, 1 = inbound)
block_id String Specifies the block that this trip belongs to
shape_id String The shape that corresponds to the trip
wheelchair_accessible wheelchair_accessible Whether wheelchairs users can board on this trip
trip_direction_name String The name of the direction the bus is going
vehicle_journey_code String The code of this bus journey
Source:

drop_off_type

0 = Passengers can be dropped off here 1 = Passengers cannot be dropped off here
Type:
  • 0 | 1
Source:

location_type

0 or null = A stop (or a platform, if part of a station) 1 = A station (contains multiple stops) 2 = Entrance/Exit (to a station) 3 = Generic Node (on a path through/to a station) 4 = Boarding Area (a specifc part of a station where people can board/alight vehicles)
Type:
  • null | 0 | 1 | 2 | 3 | 4
Source:

pickup_type

0 = Regularly scheduled pickup 1 = No pickup available 2 = Must phone the agency to arrange pickup 3 = Must communicate with driver to arrange pickup
Type:
  • 0 | 1 | 2 | 3
Source:

wheelchair_accessible

0 = No accessibility info 1 = Can accomodate at least 1 wheelchair rider 2 = Cannot accomodate any wheelchair riders
Type:
  • 0 | 1 | 2
Source: