Type Alias CommonSearchParams<ApiRequest, ApiResponse>

Type Declaration

• Optionalfilters?: PlaceFilters

  What kind of places may come back: see PlaceFilters.

• OptionalopeningHours?: OpeningHoursMode

  Request opening hours information for POIs.

  Specifies the format and detail level of opening hours data included in the response.

  Remarks

  Opening Hours Modes: Different modes provide varying levels of detail about when a POI is open for business.

  Use Cases:

  • Display "Open Now" status
  • Show full weekly schedule
  • Plan visits during open hours
  • Filter to currently open locations

  Example

  // Request opening hours
  openingHours: 'nextSevenDays'
  Copy

• Optionalquery?: string

  Search query string.

  The text to search for — can be a place name, POI, address, or any free-form location query. When omitted, results are driven entirely by filters — a category, a brand, a fuel type — or by geometries on geometry search.

  Remarks

  Query Examples:

  • Place/POI names: "Eiffel Tower", "Starbucks"
  • General queries: "pizza near me", "gas station"
  • Partial inputs: "Amst" (for autocomplete / typeahead)

  The query is processed with fuzzy matching to handle typos and variations.

  Example

  // Text-driven search
  query: 'coffee shop'
  
  // Omit query to search purely by category
  filters: { poiCategories: ['CHARGING_LOCATION'] }
  Copy

• OptionalrelatedPois?: RelatedPoisRequest

  Include related POIs in the response.

  Some POIs have hierarchical relationships (e.g., terminal inside airport). This parameter controls which related POIs are included.

  Remarks

  Relationship Types:

  • off: No related POIs (default)
  • child: Include child POIs (e.g., terminals of an airport)
  • parent: Include parent POIs (e.g., airport of a terminal)
  • all: Include both parent and child relationships

  Use Cases:

  • Show all terminals when user searches for airport
  • Navigate from specific location to broader facility
  • Display hierarchical location structure
  • Provide alternative entry points

  Default

  'off'
  Copy

  Example

  // Include child POIs
  relatedPois: 'child'  // Airport → show terminals
  
  // Include parent POIs
  relatedPois: 'parent'  // Terminal → show airport
  
  // Include all related POIs
  relatedPois: 'all'
  Copy

• OptionaltimeZone?: TimeZoneRequest

  Request timezone information for POI locations.

  Includes timezone data in the response, useful for scheduling and time-aware applications.

  Remarks

  Timezone Format:

  • iana: Returns IANA timezone identifier (e.g., "Europe/Amsterdam")

  Use Cases:

  • Display local time for POI
  • Schedule appointments across timezones
  • Calculate opening hours in local time
  • International business coordination

  Example

  // Request IANA timezone ID
  timeZone: 'iana'
  Copy