Home > widget-integration > InstantSearchAPI > buildQueryParams

InstantSearchAPI.buildQueryParams() method

Build query parameters for API requests.

**Legacy**: buildQueryParams() in api/search.js **New**: Method on API service with better typing

Handles: - Array values (appended as multiple params) - Custom params from window.boostSdCustomParams - Customer ID from platform

Signature:

protected buildQueryParams(params: Record<string, unknown>, options?: {
		includeCustomParams?: boolean;
	}): URLSearchParams;

Parameters

Parameter

Type

Description

params

Record<string, unknown>

Parameter object

options

{ includeCustomParams?: boolean; }

(Optional)

Returns:

URLSearchParams

URLSearchParams instance