A generated flowground connector for the Transport for London Unified API (version v1).
Generated from: https://api.apis.guru/v2/specs/tfl.gov.uk/v1/swagger.json
Generated at: 2019-05-07T17:44:22+03:00
Our unified API brings together data across all modes of transport into a single RESTful API. This API provides access to the most highly requested realtime and status infomation across all the modes of transport, in a single and consistent way. Access to the developer documentation is available at https://api.tfl.gov.uk
Supported authorization schemes:
- API Key- API Key
Tags: AccidentStats
year
- required - The year for which to filter the accidents on.
Tags: AirQuality
Gets all bike point locations. The Place object has an addtionalProperties array which contains the nbBikes, nbDocks and nbSpaces
> numbers which give the status of the BikePoint. A mismatch in these numbers i.e. nbDocks - (nbBikes + nbSpaces) != 0 indicates broken docks.
Tags: BikePoint
Search for bike stations by their name, a bike point's name often contains information about the name of the street
> or nearby landmarks, for example. Note that the search result does not contain the PlaceProperties i.e. the status
> or occupancy of the BikePoint, to get that information you should retrieve the BikePoint by its id on /BikePoint/id.
Tags: BikePoint
query
- required - The search term e.g. "St. James"
Tags: BikePoint
id
- required - A bike point id (a list of ids can be obtained from the above BikePoint call)
Tags: Cabwise
lat
- required - Latitudelon
- required - Longitudeoptype
- optional - Operator Type e.g Minicab, Executive, Limousinewc
- optional - Wheelchair accessibleradius
- optional - The radius of the bounding circle in metresname
- optional - Trading name of operating companymaxResults
- optional - An optional parameter to limit the number of results return. Default and maximum is 20.legacyFormat
- optional - Legacy FormatforceXml
- optional - Force XmltwentyFourSevenOnly
- optional - Twenty Four Seven Only
Tags: Journey
from
- required - Origin of the journey. Can be WGS84 coordinates expressed as "lat,long", a UK postcode, a Naptan (StopPoint) id, an ICS StopId, or a free-text string (will cause disambiguation unless it exactly matches a point of interest name).to
- required - Destination of the journey. Can be WGS84 coordinates expressed as "lat,long", a UK postcode, a Naptan (StopPoint) id, an ICS StopId, or a free-text string (will cause disambiguation unless it exactly matches a point of interest name).via
- optional - Travel through point on the journey. Can be WGS84 coordinates expressed as "lat,long", a UK postcode, a Naptan (StopPoint) id, an ICS StopId, or a free-text string (will cause disambiguation unless it exactly matches a point of interest name).nationalSearch
- optional - Does the journey cover stops outside London? eg. "nationalSearch=true"date
- optional - The date must be in yyyyMMdd formattime
- optional - The time must be in HHmm formattimeIs
- optional - Does the time given relate to arrival or leaving time? Possible options: "departing" | "arriving" Possible values: Arriving, Departing.journeyPreference
- optional - The journey preference eg possible options: "leastinterchange" | "leasttime" | "leastwalking" Possible values: LeastInterchange, LeastTime, LeastWalking.mode
- optional - The mode must be a comma separated list of modes. eg possible options: "public-bus,overground,train,tube,coach,dlr,cablecar,tram,river,walking,cycle"accessibilityPreference
- optional - The accessibility preference must be a comma separated list eg. "noSolidStairs,noEscalators,noElevators,stepFreeToVehicle,stepFreeToPlatform"fromName
- optional - An optional name to associate with the origin of the journey in the results.toName
- optional - An optional name to associate with the destination of the journey in the results.viaName
- optional - An optional name to associate with the via point of the journey in the results.maxTransferMinutes
- optional - The max walking time in minutes for transfer eg. "120"maxWalkingMinutes
- optional - The max walking time in minutes for journeys eg. "120"walkingSpeed
- optional - The walking speed. eg possible options: "slow" | "average" | "fast". Possible values: Slow, Average, Fast.cyclePreference
- optional - The cycle preference. eg possible options: "allTheWay" | "leaveAtStation" | "takeOnTransport" | "cycleHire" Possible values: None, LeaveAtStation, TakeOnTransport, AllTheWay, CycleHire.adjustment
- optional - Time adjustment command. eg possible options: "TripFirst" | "TripLast"bikeProficiency
- optional - A comma separated list of cycling proficiency levels. eg possible options: "easy,moderate,fast"alternativeCycle
- optional - Option to determine whether to return alternative cycling journeyalternativeWalking
- optional - Option to determine whether to return alternative walking journeyapplyHtmlMarkup
- optional - Flag to determine whether certain text (e.g. walking instructions) should be output with HTML tags or not.useMultiModalCall
- optional - A boolean to indicate whether or not to return 3 public transport journeys, a bus journey, a cycle hire journey, a personal cycle journey and a walking journeywalkingOptimization
- optional - A boolean to indicate whether to optimize journeys using walkingtaxiOnlyTrip
- optional - A boolean to indicate whether to return one or more taxi journeys. Note, setting this to true will override "useMultiModalCall".
Tags: Journey
Tags: Line
Tags: Line
Tags: Line
Tags: Line
Tags: Line
modes
- required - A comma-separated list of modes e.g. tube,dlr
Tags: Line
modes
- required - A comma-separated list of modes e.g. tube,dlr
Gets all lines and their valid routes for given modes, including the name and id of the originating and terminating stops for each route
Tags: Line
modes
- required - A comma-separated list of modes e.g. tube,dlrserviceTypes
- optional - A comma seperated list of service types to filter on. Supported values: Regular, Night. Defaulted to 'Regular' if not specified
Tags: Line
modes
- required - A comma-separated list of modes to filter by. e.g. tube,dlrdetail
- optional - Include details of the disruptions that are causing the line status including the affected stops and routes
Get all valid routes for all lines, including the name and id of the originating and terminating stops for each route.
Tags: Line
serviceTypes
- optional - A comma seperated list of service types to filter on. Supported values: Regular, Night. Defaulted to 'Regular' if not specified
Tags: Line
query
- required - Search term e.g victoriamodes
- optional - Optionally filter by the specified modesserviceTypes
- optional - A comma seperated list of service types to filter on. Supported values: Regular, Night. Defaulted to 'Regular' if not specified
> A list of valid severity codes can be obtained from a call to Line/Meta/Severity
Tags: Line
severity
- required - The level of severity (eg: a number from 0 to 14)
Tags: Line
ids
- required - A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.
Tags: Line
ids
- required - A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.stopPointId
- required - Optional. Id of stop to get arrival predictions for (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)direction
- optional - Optional. The direction of travel. Can be inbound or outbound or all. If left blank, and destinationStopId is set, will default to all Possible values: inbound, outbound, all.destinationStationId
- optional - Optional. Id of destination stop
Tags: Line
ids
- required - A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.
Get all valid routes for given line ids, including the name and id of the originating and terminating stops for each route.
Tags: Line
ids
- required - A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.serviceTypes
- optional - A comma seperated list of service types to filter on. Supported values: Regular, Night. Defaulted to 'Regular' if not specified
Tags: Line
ids
- required - A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.detail
- optional - Include details of the disruptions that are causing the line status including the affected stops and routes
Tags: Line
ids
- required - A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.detail
- optional - Include details of the disruptions that are causing the line status including the affected stops and routesstartDate
- requiredendDate
- requireddateRange.startDate
- optionaldateRange.endDate
- optionalStartDate
- requiredEndDate
- required
Tags: Line
id
- required - A single line id e.g. victoriadirection
- required - The direction of travel. Can be inbound or outbound. Possible values: inbound, outbound, all.serviceTypes
- optional - A comma seperated list of service types to filter on. Supported values: Regular, Night. Defaulted to 'Regular' if not specifiedexcludeCrowding
- optional - That excludes crowding from line disruptions. Can be true or false.
Tags: Line
id
- required - A single line id e.g. victoriatflOperatedNationalRailStationsOnly
- optional - If the national-rail line is requested, this flag will filter the national rail stations so that only those operated by TfL are returned
Tags: Line
fromStopPointId
- required - The originating station's stop point id (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)id
- required - A single line id e.g. victoria
Tags: Line
fromStopPointId
- required - The originating station's stop point id (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)id
- required - A single line id e.g. victoriatoStopPointId
- required - The destination stations's Naptan code
> Currently only supports tube
Tags: Mode
Tags: Mode
mode
- required - A mode name e.g. tube, dlrcount
- optional - A number of arrivals to return for each stop, -1 to return all available.
Tags: Occupancy
ids
- required
Tags: Occupancy
Tags: Occupancy
id
- required
Tags: Occupancy
Tags: Occupancy
ids
- required
Gets the places that lie within the bounding box defined by the lat/lon of its north-west and south-east corners. Optionally filters
> on type and can strip properties for a smaller payload.
Tags: Place
categories
- optional - an optional list of comma separated property categories to return in the Place's property bag. If null or empty, all categories of property are returned. Pass the keyword "none" to return no properties (a valid list of categories can be obtained from the /Place/Meta/categories endpoint)includeChildren
- optional - Defaults to false. If true child places e.g. individual charging stations at a charge point while be included, otherwise just the URLs of any child places will be returnedtype
- optional - place types to filter on, or null to return all typesactiveOnly
- optional - An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported)bbBoxpoints.swLat
- requiredbbBoxpoints.swLon
- requiredbbBoxpoints.neLat
- requiredbbBoxpoints.neLon
- required
Tags: Place
postcode
- requiredpostcodeInput.postcode
- optionalPostcode
- required
Tags: Place
Tags: Place
Tags: Place
name
- required - The name of the place, you can use the /Place/Types/{types} endpoint to get a list of places for a given type including their names.types
- optional - A comma-separated list of the types to return. Max. approx 12 types.
Tags: Place
types
- required - A comma-separated list of the types to return. Max. approx 12 types. A valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint.activeOnly
- optional - An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported)
Tags: Place
id
- required - The id of the place, you can use the /Place/Types/{types} endpoint to get a list of places for a given type including their idsincludeChildren
- optional - Defaults to false. If true child places e.g. individual charging stations at a charge point while be included, otherwise just the URLs of any child places will be returned
Gets any places of the given type whose geography intersects the given latitude and longitude. In practice this means the Place
> must be polygonal e.g. a BoroughBoundary.
Tags: Place
type
- required - The place type (a valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint)lat
- requiredlon
- requiredlocation.lat
- requiredlocation.lon
- requiredLat
- requiredLon
- required
Tags: Place
z
- required - The zoom leveltype
- required - The place type (a valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint)width
- required - The width of the requested overlay.height
- required - The height of the requested overlay.lat
- requiredlon
- requiredlocation.lat
- requiredlocation.lon
- requiredLat
- requiredLon
- required
Tags: Road
Tags: Road
Tags: Road
Tags: Road
disruptionIds
- required - Comma-separated list of disruption identifiers to filter by.stripContent
- optional - Optional, defaults to false. When true, removes every property/node except for id, point, severity, severityDescription, startDate, endDate, corridor details, location and comments.
Gets a list of disrupted streets. If no date filters are provided, current disruptions are returned.
Tags: Road
startDate
- required - Optional, the start time to filter on.endDate
- required - Optional, The end time to filter on.
Tags: Road
ids
- required - Comma-separated list of road identifiers e.g. "A406, A2" (a full list of supported road identifiers can be found at the /Road/ endpoint)
Tags: Road
ids
- required - Comma-separated list of road identifiers e.g. "A406, A2" use all for all to ignore id filter (a full list of supported road identifiers can be found at the /Road/ endpoint)stripContent
- optional - Optional, defaults to false. When true, removes every property/node except for id, point, severity, severityDescription, startDate, endDate, corridor details, location, comments and streetsseverities
- optional - an optional list of Severity names to filter on (a valid list of severities can be obtained from the /Road/Meta/severities endpoint)categories
- optional - an optional list of category names to filter on (a valid list of categories can be obtained from the /Road/Meta/categories endpoint)closures
- optional - Optional, defaults to true. When true, always includes disruptions that have road closures, regardless of the severity filter. When false, the severity filter works as normal.
Gets the specified roads with the status aggregated over the date range specified, or now until the end of today if no dates are passed.
Tags: Road
ids
- required - Comma-separated list of road identifiers e.g. "A406, A2" or use "all" to ignore id filter (a full list of supported road identifiers can be found at the /Road/ endpoint)dateRangeNullable.startDate
- optionaldateRangeNullable.endDate
- optional
Search the site for occurrences of the query string. The maximum number of results returned is equal to the maximum page size
> of 100. To return subsequent pages, use the paginated overload.
Tags: Search
query
- required - The search query
Tags: Search
query
- required - The search query
Tags: Search
Tags: Search
Tags: Search
Tags: StopPoint
stopTypes
- required - a list of stopTypes that should be returned (a list of valid stop types can be obtained from the StopPoint/meta/stoptypes endpoint)radius
- optional - the radius of the bounding circle in metres (default : 200)useStopPointHierarchy
- optional - Re-arrange the output into a parent/child hierarchymodes
- optional - the list of modes to search (comma separated mode names e.g. tube,dlr)categories
- optional - an optional list of comma separated property categories to return in the StopPoint's property bag. If null or empty, all categories of property are returned. Pass the keyword "none" to return no properties (a valid list of categories can be obtained from the /StopPoint/Meta/categories endpoint)returnLines
- optional - true to return the lines that each stop point serves as a nested resourcelocation.lat
- requiredlocation.lon
- required
Tags: StopPoint
Tags: StopPoint
Tags: StopPoint
Tags: StopPoint
modes
- required - A comma-seperated list of modes e.g. tube,dlrpage
- optional - The data set page to return. Page 1 equates to the first 1000 stop points, page 2 equates to 1001-2000 etc. Must be entered for bus mode as data set is too large.
Tags: StopPoint
modes
- required - A comma-seperated list of modes e.g. tube,dlrincludeRouteBlockedStops
- optional
Tags: StopPoint
query
- required - The query string, case-insensitive. Leading and trailing wildcards are applied automatically.modes
- optional - An optional, parameter separated list of the modes to filter byfaresOnly
- optional - True to only return stations in that have Fares data available for single fares to another station.maxResults
- optional - An optional result limit, defaulting to and with a maximum of 50. Since children of the stop point heirarchy are returned for matches, it is possible that the flattened result set will contain more than 50 items.lines
- optional - An optional, parameter separated list of the lines to filter byincludeHubs
- optional - If true, returns results including HUBs.tflOperatedNationalRailStationsOnly
- optional - If the national-rail mode is included, this flag will filter the national rail stations so that only those operated by TfL are returned
Tags: StopPoint
query
- required - The query string, case-insensitive. Leading and trailing wildcards are applied automatically.modes
- optional - An optional, parameter separated list of the modes to filter byfaresOnly
- optional - True to only return stations in that have Fares data available for single fares to another station.maxResults
- optional - An optional result limit, defaulting to and with a maximum of 50. Since children of the stop point heirarchy are returned for matches, it is possible that the flattened result set will contain more than 50 items.lines
- optional - An optional, parameter separated list of the lines to filter byincludeHubs
- optional - If true, returns results including HUBs.tflOperatedNationalRailStationsOnly
- optional - If the national-rail mode is included, this flag will filter the national rail stations so that only those operated by TfL are returned
Tags: StopPoint
id
- required - The Naptan id of the stoplineIds
- optional - The lines which contain the given Naptan id (all lines relevant to the given stoppoint if empty)modes
- optional - The modes which the lines are relevant to (all if empty)
Tags: StopPoint
id
- required - A 5-digit Countdown Bus Stop Code e.g. 73241, 50435, 56334.output
- optional - If set to "web", a 302 redirect to relevant website bus stop page is returned. Valid values are : web. All other values are ignored.
Tags: StopPoint
types
- required - A comma-separated list of the types to return. Max. approx. 12 types. A list of valid stop types can be obtained from the StopPoint/meta/stoptypes endpoint.
Tags: StopPoint
types
- requiredpage
- required
Tags: StopPoint
ids
- required - A comma-separated list of stop point ids (station naptan code e.g. 940GZZLUASL). Max. approx. 20 ids. You can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name.includeCrowdingData
- optional - Include the crowding data (static). To Filter further use: /StopPoint/{ids}/Crowding/{line}
Gets all disruptions for the specified StopPointId, plus disruptions for any child Naptan records it may have.
Tags: StopPoint
ids
- required - A comma-seperated list of stop point ids. Max. approx. 20 ids. You can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name.getFamily
- optional - Specify true to return disruptions for entire family, or false to return disruptions for just this stop point. Defaults to false.includeRouteBlockedStops
- optionalflattenResponse
- optional - Specify true to associate all disruptions with parent stop point. (Only applicable when getFamily is true).
Tags: StopPoint
id
- required - A StopPoint id (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)
Tags: StopPoint
id
- required - The id (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name) of the stop point to filter bylineId
- required - Line id of the line to filter by (e.g. victoria)serviceTypes
- optional - A comma-separated list of service types to filter on. If not specified. Supported values: Regular, Night. Defaulted to 'Regular' if not specified
Gets all the Crowding data (static) for the StopPointId, plus crowding data for a given line and optionally a particular direction.
Tags: StopPoint
id
- required - The Naptan id of the stopline
- required - A particular line e.g. victoria, circle, northern etc.direction
- required - The direction of travel. Can be inbound or outbound. Possible values: inbound, outbound, all.
Returns the canonical direction, "inbound" or "outbound", for a given pair of stop point Ids in the direction from -> to.
Tags: StopPoint
id
- required - Originating stop id (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)toStopPointId
- required - Destination stop id (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)lineId
- optional - Optional line id filter e.g. victoria
Tags: StopPoint
id
- required - A stop point id (station naptan codes e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)serviceTypes
- optional - A comma-separated list of service types to filter on. If not specified. Supported values: Regular, Night. Defaulted to 'Regular' if not specified
Tags: StopPoint
id
- required - A naptan id for a stop point (station naptan code e.g. 940GZZLUASL).placeTypes
- required - A comcomma-separated value representing the place types.
Tags: StopPoint
stopPointId
- required - stopPointId is required to get the car parks.
Tags: StopPoint
stopPointId
- required - stopPointId is required to get the taxi ranks.
Tags: TravelTime
z
- required - The zoom level.pinLat
- required - The latitude of the pin.pinLon
- required - The longitude of the pin.mapCenterLat
- required - The map center latitude.mapCenterLon
- required - The map center longitude.scenarioTitle
- required - The title of the scenario.timeOfDayId
- required - The id for the time of day (AM/INTER/PM)modeId
- required - The id of the mode.width
- required - The width of the requested overlay.height
- required - The height of the requested overlay.direction
- required - The direction of travel. Possible values: Average, From, To.travelTimeInterval
- required - The total minutes between the travel time bandscompareType
- requiredcompareValue
- required
Tags: TravelTime
z
- required - The zoom level.pinLat
- required - The latitude of the pin.pinLon
- required - The longitude of the pin.mapCenterLat
- required - The map center latitude.mapCenterLon
- required - The map center longitude.scenarioTitle
- required - The title of the scenario.timeOfDayId
- required - The id for the time of day (AM/INTER/PM)modeId
- required - The id of the mode.width
- required - The width of the requested overlay.height
- required - The height of the requested overlay.direction
- required - The direction of travel. Possible values: Average, From, To.travelTimeInterval
- required - The total minutes between the travel time bands
Tags: Vehicle
vrm
- required - The Vehicle Registration Mark
Tags: Vehicle
vrm
- required - The Vehicle Registration Mark
Tags: Vehicle
ids
- required - A comma-separated list of vehicle ids e.g. LX58CFV,LX11AZB,LX58CFE. Max approx. 25 ids.
flowground :- Telekom iPaaS / tfl-gov-uk-connector
Copyright © 2019, Deutsche Telekom AG
contact: [email protected]
All files of this connector are licensed under the Apache 2.0 License. For details see the file LICENSE on the toplevel directory.