Transport for London Unified API
This unified RESTful API from Transport for London consolidates real-time and status information across all London transport modes, including the Underground, buses, Overground, DLR, trams, river services, cycling, and roads, into a single consistent interface. It is aimed at developers building applications that need journey planning, service disruption, arrival times, and network status data. Documentation and endpoint details are published at api.tfl.gov.uk. The service covers the Greater London area and is maintained as part of the UK Government's open transport data provision.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.
Trust score
How is this computed?Weighted across five axes. Tap a ring for what it measures.
Data schema (186 fields)
| Field | Type | Description |
|---|---|---|
| year | integer (int32) | Year to filter accidents by.The year for which to filter the accidents on. |
| id | string | Identifier of a bike point.A bike point id (a list of ids can be obtained from the above BikePoint call) |
| query | string | Search term used to query results, e.g. a place name.The search term e.g. "St. James" |
| lat | number (double) | Latitude coordinate.Latitude |
| lon | number (double) | Longitude coordinate.Longitude |
| optype | string | Operator type, e.g. Minicab, Executive, Limousine.Operator Type e.g Minicab, Executive, Limousine |
| wc | string | Indicates whether the vehicle or venue is wheelchair accessible.Wheelchair accessible |
| radius | number (double) | Radius in metres of the search bounding circle.The radius of the bounding circle in metres |
| name | string | Trading name of the operating company.Trading name of operating company |
| maxResultsMax results | integer (int32) | Maximum number of results to return, default and max 20.An optional parameter to limit the number of results return. Default and maximum is 20. |
| legacyFormatLegacy format | boolean | Whether to return the response in the legacy format.Legacy Format |
| forceXmlForce xml | boolean | Whether to force the response to be returned as XML.Force Xml |
| twentyFourSevenOnlyTwenty four seven only | boolean | Whether to return only operators running 24/7.Twenty Four Seven Only |
| from | string | Origin of the journey, as coordinates, postcode, stop id, or free text.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 | string | Destination of the journey, as coordinates, postcode, stop id, or free text.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 | string | Point to travel through, as coordinates, postcode, stop id, or free text.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). |
| nationalSearchNational search | boolean | Whether the journey covers stops outside London.Does the journey cover stops outside London? eg. "nationalSearch=true" |
| date | string | Journey date in yyyyMMdd format.The date must be in yyyyMMdd format |
| time | string | Journey time in HHmm format.The time must be in HHmm format |
| timeIsTime is | string | Whether the given time is a departure or arrival time.Does the time given relate to arrival or leaving time? Possible options: "departing" | "arriving" |
| journeyPreferenceJourney preference | string | Preferred journey optimisation, e.g. least interchange, least time, least walking.The journey preference eg possible options: "leastinterchange" | "leasttime" | "leastwalking" |
| mode | array | Comma-separated list of transport modes to include in the journey.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" |
| accessibilityPreferenceAccessibility preference | array | Comma-separated list of accessibility requirements for the journey.The accessibility preference must be a comma separated list eg. "noSolidStairs,noEscalators,noElevators,stepFreeToVehicle,stepFreeToPlatform" |
| fromNameFrom name | string | Optional display name for the journey's origin point.An optional name to associate with the origin of the journey in the results. |
| toNameTo name | string | Optional display name for the journey's destination point.An optional name to associate with the destination of the journey in the results. |
| viaNameVia name | string | Optional display name for the journey's via point.An optional name to associate with the via point of the journey in the results. |
| maxTransferMinutesMax transfer minutes | string | Maximum walking time in minutes allowed for transfers.The max walking time in minutes for transfer eg. "120" |
| maxWalkingMinutesMax walking minutes | string | Maximum walking time in minutes allowed for the journey.The max walking time in minutes for journeys eg. "120" |
| walkingSpeedWalking speed | string | Assumed walking speed: slow, average, or fast.The walking speed. eg possible options: "slow" | "average" | "fast". |
| cyclePreferenceCycle preference | string | Cycling preference for the journey, e.g. all the way, leave at station, take on transport, cycle hire.The cycle preference. eg possible options: "allTheWay" | "leaveAtStation" | "takeOnTransport" | "cycleHire" |
| adjustmentAdjustment | string | Command to adjust the trip time, e.g. first or last trip.Time adjustment command. eg possible options: "TripFirst" | "TripLast" |
| bikeProficiencyBike proficiency | array | Comma-separated list of cycling proficiency levels, e.g. easy, moderate, fast.A comma separated list of cycling proficiency levels. eg possible options: "easy,moderate,fast" |
| alternativeCycleAlternative cycle | boolean | Whether to return an alternative cycling journey option.Option to determine whether to return alternative cycling journey |
| alternativeWalkingAlternative walking | boolean | Whether to return an alternative walking journey option.Option to determine whether to return alternative walking journey |
| applyHtmlMarkupApply html markup | boolean | Whether textual instructions should include HTML markup.Flag to determine whether certain text (e.g. walking instructions) should be output with HTML tags or not. |
| useMultiModalCallUse multi modal call | boolean | Whether to return multiple journey options across different modes.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 journey |
| walkingOptimizationWalking optimization | boolean | Whether to optimise journeys using walking.A boolean to indicate whether to optimize journeys using walking |
| taxiOnlyTripTaxi only trip | boolean | Whether to return only taxi journeys, overriding multi-modal results.A boolean to indicate whether to return one or more taxi journeys. Note, setting this to true will override "useMultiModalCall". |
| routeBetweenEntrancesRoute between entrances | boolean | Whether routes include directions between station entrances and platforms.A boolean to indicate whether public transport routes should include directions between platforms and station entrances. |
| useRealTimeLiveArrivalsUse real time live arrivals | boolean | Whether to include real-time live arrival data where available.A boolean to indicate if we want to receive real time live arrivals data where available. |
| calcOneDirectionCalc one direction | boolean | Whether to calculate journeys in only one temporal direction.A boolean to make Journey Planner calculate journeys in one temporal direction only. In other words, only calculate journeys after the 'depart' time, or before the 'arrive' time. By default, the Journey Planner engine (EFA) calculates journeys in both temporal directions. |
| includeAlternativeRoutesInclude alternative routes | boolean | Whether to include alternative routes in the journey results.A boolean to make Journey Planner return alternative routes. Alternative routes are calculated by removing one or more lines included in the fastest route and re-calculating. By default, these journeys will not be returned. |
| overrideMultiModalScenarioOverride multi modal scenario | integer (int32) | Integer identifying a multi-modal scenario to use.An optional integer to indicate what multi modal scenario we want to use. |
| combineTransferLegsCombine transfer legs | boolean | Whether to combine walking legs to and from station entrances.A boolean to indicate whether walking leg to station entrance and walking leg from station entrance to platform should be combined. Defaults to true |
| ids | array | Comma-separated list of line identifiers.A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids. |
| modes | array | Comma-separated list of transport modes.A comma-separated list of modes e.g. tube,dlr |
| serviceTypesService types | array | Comma-separated list of service types to filter on, e.g. Regular, Night.A comma seperated list of service types to filter on. Supported values: Regular, Night. Defaulted to 'Regular' if not specified |
| direction | string | Direction of travel, inbound or outbound.The direction of travel. Can be inbound or outbound. |
| excludeCrowdingExclude crowding | boolean | Whether to exclude crowding information from line disruptions.That excludes crowding from line disruptions. Can be true or false. |
| detail | boolean | Whether to include detailed disruption information such as affected stops and routes.Include details of the disruptions that are causing the line status including the affected stops and routes |
| startDateStart date | string | Start date of the filter range.Start date of the filter range. |
| endDateEnd date | string | End date of the filter range.End date of the filter range. |
| dateRange.startDateDate range.start date | string (date-time) | Start date and time of the date range.Start date and time of the date range. |
| dateRange.endDateDate range.end date | string (date-time) | End date and time of the date range.End date and time of the date range. |
| severity | integer (int32) | Numeric severity level of a disruption, e.g. 0 to 14.The level of severity (eg: a number from 0 to 14) |
| severityLevelSeverity level | string | Severity level used to filter line status results.If specified, ensures that only those line status(es) are returned within the lines that have disruptions with the matching severity level. |
| tflOperatedNationalRailStationsOnlyTfl operated national rail stations only | boolean | Whether to return only national rail stations operated by TfL.If the national-rail line is requested, this flag will filter the national rail stations so that only those operated by TfL are returned |
| fromStopPointIdFrom stop point id | string | Naptan stop point id of the originating station.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) |
| toStopPointIdTo stop point id | string | Naptan stop point id of the destination station.The destination stations's Naptan code |
| stopPointIdStop point id | string | Naptan stop point id to get arrival predictions for.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) |
| destinationStationIdDestination station id | string | Stop point id of the destination station.Optional. Id of destination stop |
| count | integer (int32) | Number of arrivals to return per stop, or -1 for all.A number of arrivals to return for each stop, -1 to return all available. |
| postcode | string | UK postcode used for the query.UK postcode used for the query. |
| postcodeInput.postcodePostcode input.postcode | string | UK postcode used as input for the query.UK postcode used as input for the query. |
| types | array | Comma-separated list of place types to return.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. |
| activeOnlyActive only | boolean | Whether to limit results to active records only.An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported) |
| includeChildrenInclude children | boolean | Whether to include child places, such as individual charging stations.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 |
| categories | array | Comma-separated list of property categories to return for the place.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) |
| type | array | Place types to filter results on.Place types to filter on, or null to return all types |
| numberOfPlacesToReturnNumber of places to return | integer (int32) | Maximum number of places to return.If specified, limits the number of returned places equal to the given value |
| placeGeo.swLatPlace geo.sw lat | number (double) | Latitude of the south-west corner of the bounding box.Latitude of the south-west corner of the bounding box. |
| placeGeo.swLonPlace geo.sw lon | number (double) | Longitude of the south-west corner of the bounding box.Longitude of the south-west corner of the bounding box. |
| placeGeo.neLatPlace geo.ne lat | number (double) | Latitude of the north-east corner of the bounding box.Latitude of the north-east corner of the bounding box. |
| placeGeo.neLonPlace geo.ne lon | number (double) | Longitude of the north-east corner of the bounding box.Longitude of the north-east corner of the bounding box. |
| placeGeo.latPlace geo.lat | number (double) | Latitude of the place's location.Latitude of the place's location. |
| placeGeo.lonPlace geo.lon | number (double) | Longitude of the place's location.Longitude of the place's location. |
| location.lat | number (double) | Latitude of the location.Latitude of the location. |
| location.lon | number (double) | Longitude of the location.Longitude of the location. |
| z | integer (int32) | Zoom level of the map.The zoom level |
| width | integer (int32) | Width of the requested map overlay.The width of the requested overlay. |
| height | integer (int32) | Height of the requested map overlay.The height of the requested overlay. |
| dateRangeNullable.startDateDate range nullable.start date | string (date-time) | Optional start date and time of the date range.Optional start date and time of the date range. |
| dateRangeNullable.endDateDate range nullable.end date | string (date-time) | Optional end date and time of the date range.Optional end date and time of the date range. |
| stripContentStrip content | boolean | Whether to strip disruption data down to core fields only.Optional, defaults to false. When true, removes every property/node except for id, point, severity, severityDescription, startDate, endDate, corridor details, location, comments and streets |
| severities | array | List of severity names to filter disruptions by.an optional list of Severity names to filter on (a valid list of severities can be obtained from the /Road/Meta/severities endpoint) |
| closures | boolean | Whether to always include disruptions involving road closures.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. |
| disruptionIdsDisruption ids | array | Comma-separated list of disruption identifiers to filter by. |
| includeCrowdingDataInclude crowding data | boolean | Whether to include static crowding data.Include the crowding data (static). To Filter further use: /StopPoint/{ids}/Crowding/{line} |
| placeTypesPlace types | array | Comma-separated list of place types.A comcomma-separated value representing the place types. |
| line | string | Identifier of a specific transport line, e.g. victoria.A particular line e.g. victoria, circle, northern etc. |
| page | integer (int32) | Page number of results to return.Page number of results to return. |
| lineIdsLine ids | array | Lines associated with the given stop point.The lines which contain the given Naptan id (all lines relevant to the given stoppoint if empty) |
| lineIdLine id | string | Identifier of the line to filter by.Line id of the line to filter by (e.g. victoria) |
| includeRouteBlockedStopsInclude route blocked stops | boolean | Whether to include stops blocked by route disruptions.Whether to include stops blocked by route disruptions. |
| getFamilyGet family | boolean | Whether to return disruptions for the whole stop point family.Specify true to return disruptions for entire family, or false to return disruptions for just this stop point. Defaults to false. |
| flattenResponseFlatten response | boolean | Whether to associate all disruptions with the parent stop point.Specify true to associate all disruptions with parent stop point. (Only applicable when getFamily is true). |
| stopTypesStop types | array | List of stop types to include in the results.a list of stopTypes that should be returned (a list of valid stop types can be obtained from the StopPoint/meta/stoptypes endpoint) |
| useStopPointHierarchyUse stop point hierarchy | boolean | Whether to arrange results into a parent/child hierarchy.Re-arrange the output into a parent/child hierarchy |
| returnLinesReturn lines | boolean | Whether to include the lines served by each stop point.true to return the lines that each stop point serves as a nested resource |
| faresOnlyFares only | boolean | Whether to return only stations with single fare data available.True to only return stations in that have Fares data available for single fares to another station. |
| lines | array | List of lines to filter results by.An optional, parameter separated list of the lines to filter by |
| includeHubsInclude hubs | boolean | Whether to include hub stations in the results.If true, returns results including HUBs. |
| output | string | Output format flag; "web" redirects to the relevant website page.If set to "web", a 302 redirect to relevant website bus stop page is returned. Valid values are : web. All other values are ignored. |
| pinLatPin lat | number (double) | Latitude of the map pin.The latitude of the pin. |
| pinLonPin lon | number (double) | Longitude of the map pin.The longitude of the pin. |
| mapCenterLatMap center lat | number (double) | Latitude of the map's center point.The map center latitude. |
| mapCenterLonMap center lon | number (double) | Longitude of the map's center point.The map center longitude. |
| scenarioTitleScenario title | string | Title of the traffic scenario.The title of the scenario. |
| timeOfDayIdTime of day id | string | Identifier for the time of day, e.g. AM, INTER, PM.The id for the time of day (AM/INTER/PM) |
| modeIdMode id | string | Identifier of the transport mode.The id of the mode. |
| travelTimeIntervalTravel time interval | integer (int32) | Number of minutes between travel time bands.The total minutes between the travel time bands |
| compareTypeCompare type | string | Type of comparison to apply to a value.Type of comparison to apply to a value. |
| compareValueCompare value | string | Value used for the comparison.Value used for the comparison. |
| locationTfl.Api.Presentation.Entities.AccidentStats.AccidentDetail | string | Location description of the accident.Location description of the accident. |
| boroughTfl.Api.Presentation.Entities.AccidentStats.AccidentDetail | string | London borough where the accident occurred.London borough where the accident occurred. |
| casualtiesTfl.Api.Presentation.Entities.AccidentStats.AccidentDetail | array<object> | List of casualties involved in the accident.List of casualties involved in the accident. |
| vehiclesTfl.Api.Presentation.Entities.AccidentStats.AccidentDetail | array<object> | List of vehicles involved in the accident.List of vehicles involved in the accident. |
| ageTfl.Api.Presentation.Entities.AccidentStats.Casualty | integer (int32) | Age of the casualty.Age of the casualty. |
| classTfl.Api.Presentation.Entities.AccidentStats.Casualty | string | Classification of the casualty, e.g. driver, passenger, pedestrian.Classification of the casualty, e.g. driver, passenger, pedestrian. |
| ageBandTfl.Api.Presentation.Entities.AccidentStats.Casualty | string | Age band category of the casualty.Age band category of the casualty. |
| accidentsTfl.Api.Presentation.Entities.AccidentStats.AccidentStatsOrderedSummary | integer (int32) | Number of accidents in the summary period.Number of accidents in the summary period. |
| urlTfl.Api.Presentation.Entities.Place | string | Unique URL identifying this place resource.The unique location of this resource. |
| commonNameTfl.Api.Presentation.Entities.Place | string | Human-readable name of the place.A human readable name. |
| distanceTfl.Api.Presentation.Entities.Place | number (double) | Distance of the place from the search point, in metres.The distance of the place from its search point, if this is the result of a geographical search, otherwise zero. |
| placeTypeTfl.Api.Presentation.Entities.Place | string | Type of place, as defined in the place types metadata.The type of Place. See /Place/Meta/placeTypes for possible values. |
| additionalPropertiesTfl.Api.Presentation.Entities.Place | array<object> | Extra key/value pairs providing additional information about the place.A bag of additional key/value pairs with extra information about this place. |
| childrenTfl.Api.Presentation.Entities.Place | array<object> | Child places nested under this place.Child places nested under this place. |
| childrenUrlsTfl.Api.Presentation.Entities.Place | array<string> | URLs of this place's child places.URLs of this place's child places. |
| categoryTfl.Api.Presentation.Entities.AdditionalProperties | string | Category of the additional property.Category of the additional property. |
| keyTfl.Api.Presentation.Entities.AdditionalProperties | string | Key name of the additional property.Key name of the additional property. |
| sourceSystemKeyTfl.Api.Presentation.Entities.AdditionalProperties | string | Identifier of the source system that provided the property.Identifier of the source system that provided the property. |
| valueTfl.Api.Presentation.Entities.AdditionalProperties | string | Value of the additional property.Value of the additional property. |
| modifiedTfl.Api.Presentation.Entities.AdditionalProperties | string (date-time) | Date and time when the property was last modified.Date and time when the property was last modified. |
| labelTfl.Api.Presentation.Entities.CycleSuperhighway | string | Long label shown for the route when the map is zoomed in.The long label to show on maps when zoomed in |
| labelShortTfl.Api.Presentation.Entities.CycleSuperhighway | string | Short label shown for the route on the map.The short label to show on maps |
| geographyTfl.Api.Presentation.Entities.CycleSuperhighway | object | Line string or multi-line string geometry describing the route.A LineString or MultiLineString that forms the route of the highway |
| segmentedTfl.Api.Presentation.Entities.CycleSuperhighway | boolean | Whether the route is split into segments.True if the route is split into segments |
| statusTfl.Api.Presentation.Entities.CycleSuperhighway | string | Status of the cycle route, e.g. Proposed, Existing.Cycle route status i.e Proposed, Existing etc |
| routeTypeTfl.Api.Presentation.Entities.CycleSuperhighway | string | Type of cycle route, e.g. CycleSuperhighways, Quietways, MiniHollands.Type of cycle route e.g CycleSuperhighways, Quietways, MiniHollands etc |
| coordinateSystemIdSystem.Data.Spatial.DbGeographyWellKnownValue | integer (int32) | Identifier of the coordinate system used for the geography.Identifier of the coordinate system used for the geography. |
| wellKnownTextSystem.Data.Spatial.DbGeographyWellKnownValue | string | Well-known text representation of the geography.Well-known text representation of the geography. |
| wellKnownBinarySystem.Data.Spatial.DbGeographyWellKnownValue | string (byte) | Well-known binary representation of the geography.Well-known binary representation of the geography. |
| passengerTypeTfl.Api.Presentation.Entities.Fares.Fare | string | Type of passenger the fare applies to.Type of passenger the fare applies to. |
| validFromTfl.Api.Presentation.Entities.Fares.Fare | string (date-time) | Date from which the fare is valid.Date from which the fare is valid. |
| validUntilTfl.Api.Presentation.Entities.Fares.Fare | string (date-time) | Date until which the fare is valid.Date until which the fare is valid. |
| ticketTimeTfl.Api.Presentation.Entities.Fares.Fare | string | Time period during which the ticket is valid.Time period during which the ticket is valid. |
| ticketTypeTfl.Api.Presentation.Entities.Fares.Fare | string | Type of ticket the fare relates to.Type of ticket the fare relates to. |
| costTfl.Api.Presentation.Entities.Fares.Fare | string | Cost of the fare.Cost of the fare. |
| capTfl.Api.Presentation.Entities.Fares.Fare | number (double) | Fare cap amount applied.Fare cap amount applied. |
| descriptionTfl.Api.Presentation.Entities.Fares.Fare | string | Description of the fare.Description of the fare. |
| zoneTfl.Api.Presentation.Entities.Fares.Fare | string | Fare zone the fare applies to.Fare zone the fare applies to. |
| headerTfl.Api.Presentation.Entities.Fares.FaresSection | string | Header text of the fares section.Header text of the fares section. |
| indexTfl.Api.Presentation.Entities.Fares.FaresSection | integer (int32) | Position index of the fares section.Position index of the fares section. |
| journeyTfl.Api.Presentation.Entities.Fares.FaresSection | object | Journey details associated with the fares section.Journey details associated with the fares section. |
| rowsTfl.Api.Presentation.Entities.Fares.FaresSection | array<object> | Rows of fare data within the section.Rows of fare data within the section. |
| messagesTfl.Api.Presentation.Entities.Fares.FaresSection | array<object> | Messages associated with the fares section.Messages associated with the fares section. |
| fromStationTfl.Api.Presentation.Entities.Fares.Journey | object | Origin station of the fare journey.Origin station of the fare journey. |
| toStationTfl.Api.Presentation.Entities.Fares.Journey | object | Destination station of the fare journey.Destination station of the fare journey. |
| boundsIdTfl.Api.Presentation.Entities.Fares.FareDetails | integer (int32) | Identifier of the fare bounds.Identifier of the fare bounds. |
| contactlessPAYGOnlyFareTfl.Api.Presentation.Entities.Fares.FareDetails | boolean | Whether the fare is only available via contactless pay-as-you-go.Whether the fare is only available via contactless pay-as-you-go. |
| routeCodeTfl.Api.Presentation.Entities.Fares.FareDetails | string | Code identifying the fare route.Code identifying the fare route. |
| displayNameTfl.Api.Presentation.Entities.Fares.FareDetails | string | Display name of the fare details.Display name of the fare details. |
| displayOrderTfl.Api.Presentation.Entities.Fares.FareDetails | integer (int32) | Order in which fare details should be displayed.Order in which fare details should be displayed. |
| routeDescriptionTfl.Api.Presentation.Entities.Fares.FareDetails | string | Description of the fare route.Description of the fare route. |
| validatorInformationTfl.Api.Presentation.Entities.Fares.FareDetails | string | Information about ticket validation for this fare.Information about ticket validation for this fare. |
| operatorTfl.Api.Presentation.Entities.Fares.FareDetails | string | Operator providing the fare.Operator providing the fare. |
| specialFareTfl.Api.Presentation.Entities.Fares.FareDetails | boolean | Whether this is a special fare.Whether this is a special fare. |
| throughFareTfl.Api.Presentation.Entities.Fares.FareDetails | boolean | Whether this fare covers a through-ticketed journey.Whether this fare covers a through-ticketed journey. |
| isTourTfl.Api.Presentation.Entities.Fares.FareDetails | boolean | Whether this fare relates to a tour ticket.Whether this fare relates to a tour ticket. |
| ticketsAvailableTfl.Api.Presentation.Entities.Fares.FareDetails | array<object> | List of tickets available for this fare.List of tickets available for this fare. |
| bulletOrderTfl.Api.Presentation.Entities.Message | integer (int32) | Display order of the message bullet point.Display order of the message bullet point. |
| messageTextTfl.Api.Presentation.Entities.Message | string | Text content of the message.Text content of the message. |
| linkTextTfl.Api.Presentation.Entities.Message | string | Text of a link associated with the message.Text of a link associated with the message. |
| atcoCodeTfl.Api.Presentation.Entities.Fares.FareStation | string | ATCO code identifying the fare station.ATCO code identifying the fare station. |
| fareCategoryTfl.Api.Presentation.Entities.Fares.FareStation | string | Category of the fare station.Category of the fare station. |
| isPopularFareTfl.Api.Presentation.Entities.Fares.FareBounds | boolean | Whether this fare is marked as popular.Whether this fare is marked as popular. |
| isPopularTravelCardTfl.Api.Presentation.Entities.Fares.FareBounds | boolean | Whether this fare is a popular travelcard option.Whether this fare is a popular travelcard option. |
| viewableDateTfl.Api.Presentation.Entities.Fares.FaresPeriod | string (date-time) | Date from which the fares period is viewable.Date from which the fares period is viewable. |
| isFutureTfl.Api.Presentation.Entities.Fares.FaresPeriod | boolean | Whether this fares period is in the future.Whether this fares period is in the future. |
| longitudeTfl.Api.Presentation.Entities.Coordinate | number (double) | Longitude coordinate.Longitude coordinate. |
| latitudeTfl.Api.Presentation.Entities.Coordinate | number (double) | Latitude coordinate.Latitude coordinate. |
| eastingTfl.Api.Presentation.Entities.Coordinate | number (double) | Easting value of the coordinate in the British National Grid.Easting value of the coordinate in the British National Grid. |
| northingTfl.Api.Presentation.Entities.Coordinate | number (double) | Northing value of the coordinate in the British National Grid.Northing value of the coordinate in the British National Grid. |
| xCoordTfl.Api.Presentation.Entities.Coordinate | integer (int32) | X coordinate value of the location.X coordinate value of the location. |
| yCoordTfl.Api.Presentation.Entities.Coordinate | integer (int32) | Y coordinate value of the location.Y coordinate value of the location. |
| addressTfl.Api.Presentation.Entities.GeoCodeSearchMatch | string | Formatted address text describing the place's location.A string describing the formatted address of the place. Adds additional context to the place's Name. |
Schema captured from openapi 23 days ago.
Verification Status
Using the API
Configuration
- Base URL
- https://api.tfl.gov.uk
- Version
- v1
- Format
- openapi
- Endpoints
- 84
Try the API
/AccidentStats/{year}Gets all accident details for accidents occuring in the specified year
/AirQualityGets air quality data feed
/BikePointGets 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.
/BikePoint/{id}Gets the bike point with the given id.
/BikePoint/SearchSearch 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.
Requests are proxied through our servers. Only GET endpoints are testable.
Endpoints (84)
/StopPoint23 endpoints
/StopPoint/Meta/CategoriesGets the list of available StopPoint additional information categories
/StopPoint/Meta/StopTypesGets the list of available StopPoint types
/StopPoint/Meta/ModesGets the list of available StopPoint modes
/StopPoint/{ids}Gets a list of StopPoints corresponding to the given list of stop ids.
/StopPoint/{id}/placeTypesGet a list of places corresponding to a given id and place types.
/StopPoint/{id}/Crowding/{line}Gets all the Crowding data (static) for the StopPointId, plus crowding data for a given line and optionally a particular direction.
/StopPoint/Type/{types}Gets all stop points of a given type
/StopPoint/Type/{types}/page/{page}Gets all the stop points of given type(s) with a page number
/StopPoint/ServiceTypesGets the service types for a given stoppoint
/StopPoint/{id}/ArrivalsGets the list of arrival predictions for the given stop point id
/StopPoint/{id}/ArrivalDeparturesGets the list of arrival and departure predictions for the given stop point id (overground, Elizabeth line and thameslink only)
/StopPoint/{id}/CanReachOnLine/{lineId}Gets Stopoints that are reachable from a station/line combination.
/StopPoint/{id}/RouteReturns the route sections for all the lines that service the given stop point ids
/StopPoint/Mode/{modes}/DisruptionGets a distinct list of disrupted stop points for the given modes
/StopPoint/{ids}/DisruptionGets all disruptions for the specified StopPointId, plus disruptions for any child Naptan records it may have.
/StopPoint/{id}/DirectionTo/{toStopPointId}Returns the canonical direction, "inbound" or "outbound", for a given pair of stop point Ids in the direction from -> to.
/StopPointGets a list of StopPoints within {radius} by the specified criteria
/StopPoint/Mode/{modes}Gets a list of StopPoints filtered by the modes available at that StopPoint.
/StopPoint/Search/{query}Search StopPoints by their common name, or their 5-digit Countdown Bus Stop Code.
/StopPoint/SearchSearch StopPoints by their common name, or their 5-digit Countdown Bus Stop Code.
/StopPoint/Sms/{id}Gets a StopPoint for a given sms code.
/StopPoint/{stopPointId}/TaxiRanksGets a list of taxi ranks corresponding to the given stop point id.
/StopPoint/{stopPointId}/CarParksGet car parks corresponding to the given stop point id.
/Line21 endpoints
/Line/Meta/ModesGets a list of valid modes
/Line/Meta/SeverityGets a list of valid severity codes
/Line/Meta/DisruptionCategoriesGets a list of valid disruption categories
/Line/Meta/ServiceTypesGets a list of valid ServiceTypes to filter on
/Line/{ids}Gets lines that match the specified line ids.
/Line/Mode/{modes}Gets lines that serve the given modes.
/Line/RouteGet all valid routes for all lines, including the name and id of the originating and terminating stops for each route.
/Line/{ids}/RouteGet all valid routes for given line ids, including the name and id of the originating and terminating stops for each route.
/Line/Mode/{modes}/RouteGets all lines and their valid routes for given modes, including the name and id of the originating and terminating stops for each route
/Line/{id}/Route/Sequence/{direction}Gets all valid routes for given line id, including the sequence of stops on each route.
/Line/{ids}/Status/{StartDate}/to/{EndDate}Gets the line status for given line ids during the provided dates e.g Minor Delays
/Line/{ids}/StatusGets the line status of for given line ids e.g Minor Delays
/Line/Search/{query}Search for lines or routes matching the query string
/Line/Status/{severity}Gets the line status for all lines with a given severity A list of valid severity codes can be obtained from a call to Line/Meta/Severity
/Line/Mode/{modes}/StatusGets the line status of for all lines for the given modes
/Line/{id}/StopPointsGets a list of the stations that serve the given line id
/Line/{id}/Timetable/{fromStopPointId}Gets the timetable for a specified station on the give line
/Line/{id}/Timetable/{fromStopPointId}/to/{toStopPointId}Gets the timetable for a specified station on the give line with specified destination
/Line/{ids}/DisruptionGet disruptions for the given line ids
/Line/Mode/{modes}/DisruptionGet disruptions for all lines of the given modes.
/Line/{ids}/Arrivals/{stopPointId}Get the list of arrival predictions for given line ids based at the given stop
/Place9 endpoints
/Place/Meta/CategoriesGets a list of all of the available place property categories and keys.
/Place/Meta/PlaceTypesGets a list of the available types of Place.
/Place/Address/Streets/{Postcode}Gets the set of streets associated with a post code.
/Place/Type/{types}Gets all places of a given type
/Place/{id}Gets the place with the given id.
/PlaceGets the places that lie within a geographic region. The geographic region of interest can either be specified by using a lat/lon geo-point and a radius in metres to return places within the locus defined by the lat/lon of its centre or alternatively, by the use of a 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.
/Place/{type}/At/{Lat}/{Lon}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.
/Place/{type}/overlay/{z}/{Lat}/{Lon}/{width}/{height}Gets the place overlay for a given set of co-ordinates and a given width/height.
/Place/SearchGets all places that matches the given query
/Road8 endpoints
/RoadGets all roads managed by TfL
/Road/{ids}Gets the road with the specified id (e.g. A1)
/Road/{ids}/StatusGets the specified roads with the status aggregated over the date range specified, or now until the end of today if no dates are passed.
/Road/{ids}/DisruptionGet active disruptions, filtered by road ids
/Road/all/Street/DisruptionGets a list of disrupted streets. If no date filters are provided, current disruptions are returned.
/Road/all/Disruption/{disruptionIds}Gets a list of active disruptions filtered by disruption Ids.
/Road/Meta/CategoriesGets a list of valid RoadDisruption categories
/Road/Meta/SeveritiesGets a list of valid RoadDisruption severity codes
/Occupancy5 endpoints
/Occupancy/CarPark/{id}Gets the occupancy for a car park with a given id
/Occupancy/CarParkGets the occupancy for all car parks that have occupancy data
/Occupancy/ChargeConnector/{ids}Gets the occupancy for a charge connectors with a given id (sourceSystemPlaceId)
/Occupancy/ChargeConnectorGets the occupancy for all charge connectors
/Occupancy/BikePoints/{ids}Get the occupancy for bike points.
/Search5 endpoints
/SearchSearch 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.
/Search/BusSchedulesSearches the bus schedules folder on S3 for a given bus number.
/Search/Meta/SearchProvidersGets the available searchProvider names.
/Search/Meta/CategoriesGets the available search categories.
/Search/Meta/SortsGets the available sorting options.
/BikePoint3 endpoints
/BikePointGets 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.
/BikePoint/{id}Gets the bike point with the given id.
/BikePoint/SearchSearch 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.
/Journey2 endpoints
/Journey/Meta/ModesGets a list of all of the available journey planner modes
/Journey/JourneyResults/{from}/to/{to}Perform a Journey Planner search from the parameters specified in simple types
/Mode2 endpoints
/Mode/ActiveServiceTypesReturns the service type active for a mode. Currently only supports tube
/Mode/{mode}/ArrivalsGets the next arrival predictions for all stops of a given mode
/TravelTimes2 endpoints
/TravelTimes/overlay/{z}/mapcenter/{mapCenterLat}/{mapCenterLon}/pinlocation/{pinLat}/{pinLon}/dimensions/{width}/{height}Gets the TravelTime overlay.
/TravelTimes/compareOverlay/{z}/mapcenter/{mapCenterLat}/{mapCenterLon}/pinlocation/{pinLat}/{pinLon}/dimensions/{width}/{height}Gets the TravelTime overlay.
/AccidentStats1 endpoint
/AccidentStats/{year}Gets all accident details for accidents occuring in the specified year
/AirQuality1 endpoint
/AirQualityGets air quality data feed
/Cabwise1 endpoint
/Cabwise/searchGets taxis and minicabs contact information
/Vehicle1 endpoint
/Vehicle/{ids}/ArrivalsGets the predictions for a given list of vehicle Id's.
Query examples
curl -s 'https://api.tfl.gov.uk/swagger/docs/v1' -H 'Accept: application/json'Machine-readable API description (use it to generate clients).
Machine-readable & source
Embed this badge in a README or wiki — it always shows the latest verification state and quality tier.