Skip to main content

addressSuggestions

Get address suggestions based on partial address input. Returns a list of matching addresses optimized for autocomplete use cases. Useful for providing real-time address suggestions as the user types.

Example: query "Hauptstr 10, Berl" might return:

  • Hauptstraße 10, 10827 Berlin, Germany
  • Hauptstraße 10, 10825 Berlin, Germany
  • etc.

Returns empty list if query is less than 3 characters or geo services are disabled.

addressSuggestions(
  limit: Int
  query: String!
): [AddressSuggestion!]!

Arguments​

addressSuggestions.limit ● Int scalar​

Maximum number of suggestions to return (default: 10, max: 20). Recommended: 5-10 for optimal UI performance.

addressSuggestions.query ● String! non-null scalar​

Partial address string to search for. Should be at least 3 characters for meaningful results.

Type​

AddressSuggestion object​

Represents a single address suggestion returned from the geocoding API. Used for autocomplete functionality to help users find and select valid addresses.