Type Alias CommonSearchParams<ApiRequest, ApiResponse>

Type Declaration

• Optionalfilters?: PlaceFilters

  The kinds of places that may come back, as PlaceFilters.

• OptionalopeningHours?: OpeningHoursMode

  The format and detail level of the POI opening hours data that the response includes.

  Remarks

  Each mode gives a different level of detail about when a POI is open for business.

  Use it to:

  • 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

  The text to search for.

  It can be a place name, POI, address, or any free-form location query. If you leave it out, filters alone drive the results (a category, a brand, a fuel type), or geometries do on geometry search.

  Remarks

  For example:

  • 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

  Which related POIs the response includes.

  Some POIs have hierarchical relationships (e.g., terminal inside airport).

  Remarks

  The relationship types are:

  • 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 it to:

  • 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

  The timezone information to include for POI locations, for scheduling and time-aware applications.

  Remarks

  With iana, the response carries the IANA timezone identifier (e.g., "Europe/Amsterdam").

  Use it to:

  • 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