Get route stations with amenities

Arguments

route_id· ID· required
ID of the route request.
route_details_id· ID· required
ID of the route.
time_window· RouteTimeWindow· required
Time window along the route to search for stations with amenities.
amenity_types· AmenityType· required
Type of amenity to search along the route. Behaves as logical OR when multiple values are provided.
park

restaurant

museum

coffee

hotel

shopping

bathroom

supermarket

playground

pharmacy

bakery

convenience_store

filter· RouteStationsWithAmenityFilter
Filter results by station or amenity properties.
first· Int
Maximum number of items to return per page, a value between 1 and 10.
after· String
Returns the items in the list that come after the specified cursor. For the first page, this field should not be specified.

Fields

total_count· Int
Total number of stations with amenities of the specified type.
page_info· PageInfo
Information about the current page.
nodes· RouteStationWithAmenities
List of stations with amenities of the specified type.

Exceptions

Codes

maximum_distance_from_path_above_allowed
Provided maximum distance from path is not valid. The value must be less than or equal to 10 000 meters or an equivalent unit.
maximum_distance_from_station_above_allowed
Provided maximum distance from station is not valid. The value must be less than or equal to 1000 meters or an equivalent unit.
pagination_invalid_after
The cursor provided in $LOCATION is invalid.
pagination_invalid_first
The page size indicated in $LOCATION must value between 1 and $SIZE.
route_amenities_expired
This route has expired for this type of search. To ensure data accuracy, routes older than 24 hours cannot be used. Please create a new route and try again.
route_amenities_invalid_status
Cannot search stations and amenities in a route with status [object Object].
route_not_found
No route was found with the provided ID.
time_window_exceeds_route_duration
The specified time window center takes place after the estimated arrival time. All center times must take place between the estimated departure and arrival time.
time_window_margin_above_allowed
Provided time window margin is not valid. The value must be less than or equal to 45 minutes or an equivalent unit.
zero_or_negative_value_not_allowed
Zero or negative value for $LOCATION is not allowed.
  • Getting started

    Get started with the Chargetrip API.

  • API reference

    Browse our api and endpoints.

  • Examples

    Explore examples and start building.

How filter works

The filter argument lets you narrow down results by passing an input object with specific criteria. Each field within the filter is optional — only include the ones relevant to your query.