Home > widget-integration > InstantSearchAPI > getSuggestions
InstantSearchAPI.getSuggestions() method
Fetch search suggestions.
**Legacy**: getSuggestionSearch(context, query, customizeSearchParams) **New**: getSuggestions(params, searchSettings?, customParams?) with typed response
Features migrated from legacy: - Timestamp cache busting (t param) - Did-you-mean suggestions (re_run_if_typo) - Suggestion blocks with limits - Recent search integration - Fuzzy search options - Product availability filtering - B2B support - Locale/currency params
Signature:
getSuggestions(params: SuggestionRequestParams, searchSettings?: Partial<SearchSettings$1>, customParams?: Record<string, unknown>, signal?: AbortSignal): Promise<SuggestionResponse>;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
params |
Suggestion request parameters | |
|
searchSettings |
Partial<SearchSettings$1> |
(Optional) Optional search settings override |
|
customParams |
Record<string, unknown> |
(Optional) Optional custom parameters to merge |
|
signal |
AbortSignal |
(Optional) |
Returns:
Promise<SuggestionResponse>
Suggestion response