Overview
Internal endpoint called by address-search-api to search for addresses using the underlying provider. The connector transforms the standardised request to provider-specific format and returns standardised results.
GET (/internal/v1/address-suggestions)
Parameters
- address (query) (required): Partial address search query (minimum 3 characters recommended)
- country (query): ISO alpha-2 country code to limit search scope
- limit (query): Maximum number of suggestions to return
- language (query): ISO alpha-2 language code for address formatting and display preferences. Affects how addresses are formatted and returned by the provider (e.g., “en”, “et”, “fr”). Not all providers support all languages - unsupported languages will fallback to provider defaults.
Responses
200 OK
400 Bad Request
500 Internal Server Error
Architecture
List of address suggestions from provider
Provider-specific address identifier. This ID will be used to retrieve full address details. Must be opaque and usable in subsequent requests.
Formatted address string suitable for display
No properties match your search
Try a different search term or clear the search to see all properties
Standard error code. Connectors should translate provider errors to these codes: - INVALID_REQUEST - Bad request parameters - PROVIDER_ERROR - Provider returned an error - PROVIDER_UNAVAILABLE - Cannot reach provider - RATE_LIMIT_EXCEEDED - Provider rate limit hit - AUTHENTICATION_FAILED - Provider authentication failed - ADDRESS_NOT_FOUND - Address ID not found - INTERNAL_ERROR - Connector internal error
Human-readable error message
Unique request identifier for debugging
Original provider-specific error code (for debugging)
Original provider error message (for debugging)
No properties match your search
Try a different search term or clear the search to see all properties
Standard error code. Connectors should translate provider errors to these codes: - INVALID_REQUEST - Bad request parameters - PROVIDER_ERROR - Provider returned an error - PROVIDER_UNAVAILABLE - Cannot reach provider - RATE_LIMIT_EXCEEDED - Provider rate limit hit - AUTHENTICATION_FAILED - Provider authentication failed - ADDRESS_NOT_FOUND - Address ID not found - INTERNAL_ERROR - Connector internal error
Human-readable error message
Unique request identifier for debugging
Original provider-specific error code (for debugging)
Original provider error message (for debugging)
No properties match your search
Try a different search term or clear the search to see all properties