Search API Parameters

List of all search API parameters.

The parameters listed on this page can be used as API parameters with these API operations:

• Search single index
• Search multiple indices
• Search for facet values
• Browse (some parameters are ignored)
• Add API key (as API key restriction)
• Update API key

Some parameters can also be set as index setting (marked with ) For more information, see Index settings and API parameters.

• advancedSyntaxFeatures
• advancedSyntax
• allowTyposOnNumericTokens
• alternativesAsExact
• analyticsTags
• analytics
• aroundLatLngViaIP
• aroundLatLng
• aroundPrecision
• aroundRadius
• attributeCriteriaComputedByMinProximity
• attributesToHighlight
• attributesToRetrieve
• attributesToSnippet
• clickAnalytics
• decompoundQuery
• disableExactOnAttributes
• disableTypoToleranceOnAttributes
• distinct
• enableABTest
• enablePersonalization
• enableReRanking
• enableRules
• exactOnSingleWordQuery
• facetFilters
• facetingAfterDistinct
• facets
• filters
• getRankingInfo
• highlightPostTag
• highlightPreTag
• hitsPerPage
• ignorePlurals
• insideBoundingBox
• insidePolygon
• length
• maxFacetHits
• maxValuesPerFacet
• minProximity
• minWordSizefor1Typo
• minWordSizefor2Typos
• minimumAroundRadius
• naturalLanguages
• numericFilters
• offset
• optionalFilters
• optionalWords
• page
• percentileComputation
• personalizationImpact
• queryLanguages
• queryType
• query
• relevancyStrictness
• removeStopWords
• removeWordsIfNoResults
• replaceSynonymsInHighlight
• responseFields
• restrictHighlightAndSnippetArrays
• restrictSearchableAttributes
• ruleContexts
• similarQuery
• snippetEllipsisText
• sortFacetValuesBy
• sumOrFiltersScores
• synonyms
• tagFilters
• typoTolerance
• userToken