Interface: StationParams

Hierarchy

• StationParams

Index

Properties

• bearerId
• country
• geo
• include
• search
• sort

Properties

Optional bearerId

• bearerId? : undefined | string

Search for a station based on a bearerId.

Optional country

• country? : undefined | string

Required if searching by geo, term or bearerId parameters. Otherwise an optional 3 digit country ISO code to limit the size and speed of requests. Recommended.

Optional geo

• geo? : number[]

Search for a station with a comma-separated array of latitude and longitude (eg [101,-97]).

Optional include

• include? : StationIncludes[]

Limit the fields that are returned in each station object. An array of possible values

Optional search

• search? : undefined | string

Search for a station with a uri-encoded search term.

Optional sort

• sort? : undefined | "alphanumericKey"

At the moment, the only supported sort order is 'alphanumericKey'