Skip to content

TripsAPI

Method HTTP request
getCoverageLonLatTrips GET /coverage/{lon};{lat}/trips
getCoverageLonLatTripsId GET /coverage/{lon};{lat}/trips/{id}
getCoverageLonLatUriTrips GET /coverage/{lon};{lat}/{uri}/trips
getCoverageLonLatUriTripsId GET /coverage/{lon};{lat}/{uri}/trips/{id}
getCoverageRegionTrips GET /coverage/{region}/trips
getCoverageRegionTripsId GET /coverage/{region}/trips/{id}
getCoverageRegionUriTrips GET /coverage/{region}/{uri}/trips
getCoverageRegionUriTripsId GET /coverage/{region}/{uri}/trips/{id}

getCoverageLonLatTrips

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageLonLatTrips(
    lat: 3.4, 
    lon: 3.4, 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatTripsId

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
id String Id of the object you want to query
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageLonLatTripsId(
    lat: 3.4, 
    lon: 3.4, 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatUriTrips

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
uri String First part of the uri
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageLonLatUriTrips(
    lat: 3.4, 
    lon: 3.4, 
    uri: "uri_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatUriTripsId

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
uri String First part of the uri
id String Id of the object you want to query
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageLonLatUriTripsId(
    lat: 3.4, 
    lon: 3.4, 
    uri: "uri_example", 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionTrips

Parameters

Name Type Note
region String The region you want to query
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageRegionTrips(
    region: "region_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionTripsId

Parameters

Name Type Note
region String The region you want to query
id String Id of the object you want to query
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageRegionTripsId(
    region: "region_example", 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionUriTrips

Parameters

Name Type Note
region String The region you want to query
uri String First part of the uri
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageRegionUriTrips(
    region: "region_example", 
    uri: "uri_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionUriTripsId

Parameters

Name Type Note
region String The region you want to query
uri String First part of the uri
id String Id of the object you want to query
startPage Int The page where you want to start [optional]
count Int Number of objects you want on a page [optional] [default to 25]
depth Int The depth of your object [optional] [default to 1]
forbiddenId [String] DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris [String] forbidden uris [optional]
externalCode String An external code to query [optional]
headsign String filter vehicle journeys on headsign [optional]
odtLevel String odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness String Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance Int Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since Date filters objects not valid before this date [optional]
until Date filters objects not valid after this date [optional]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
tags [String] If filled, will restrain the search within the given disruption tags [optional]

Return

Trips

Example

Expert.shared.tripsApi.getCoverageRegionUriTripsId(
    region: "region_example", 
    uri: "uri_example", 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"]
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }