Amenity list

Arguments

stationId· ID· required
ID of the station.
filter· AmenityListFilter
Criteria to filter amenities.
size· Int
Number of elements (count) to return.
page· Int
Page number to return.

Fields

id· ID
Unique amenity ID.
externalId· String· deprecated
ID provided by an amenity data source as the row ID.
external_id· String
ID provided by an amenity data source as the row ID.
name· String
Name of the amenity.
location· Point
Geo location coordinates. This is a GeoJSON Point.
address· Address
Address of the amenity.
type· String
Type of amenity. An amenity can belong to multiple categories.
distance· Int· deprecated
Computed distance between station and amenity.
station_distance· Float
Computed distance between station and amenity.
foursquareUrl· String· deprecated
Full path URL to amenity foursquare page.
opening_hours· AmenityOpeningHours
Opening hours of the amenity.
pets_allowed· Boolean
Indicates whether pets are allowed. This does not apply to assistance dogs, which may have legal access.
accessibility· AmenityAccessibility
Accessibility options at the amenity.
contact· AmenityContact
Contact information for the amenity.
rating· Float
Rating of an amenity, the value will be between 0.0 and 10.0. If no rating has been given, the value will be set to null.
createdAt· String· deprecated
Date and time when an amenity was created.
updatedAt· String· deprecated
Date and time when an amenity was last updated.
last_updated· DateTime
Date and time when an amenity was last updated.

Exceptions

Codes

error_forbidden_message
You are forbidden to execute this operation.
operation_not_allowed
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
rate_limit_exceeded
Rate limit exceeded.
station_not_found
No station was found with the provided parameters.
  • 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.