API Parameters

Search parameters

Scope

Each parameter in this page has a scope. Depending on the scope, you can use the parameter within the setSettings and/or the search method.

There are three scopes:

  • settings: The setting can only be used in the setSettings method.
  • search: The setting can only be used in the search method.
  • settings search: The setting can be used in the setSettings method and be overridden in the search method.

Parameters list

query
search

The text to search in the index.

Attributes

searchableAttributes
settings

The complete list of attributes that will be used for searching.

attributesForFaceting
settings

The complete list of attributes that will be used for faceting.

unretrievableAttributes
settings

List of attributes that cannot be retrieved at query time.

attributesToRetrieve
settings search

Gives control over which attributes to retrieve and which not to retrieve.

restrictSearchableAttributes
search

Restricts a given query to look in only a subset of your searchable attributes.

This setting overrides searchableAttributes for specific searches.

Ranking

ranking
settings

Controls the way results are sorted.

customRanking
settings

Specifies the custom ranking criterion.

replicas
settings

Creates replicas, exact copies of an index.

Filtering

filters
search

Filter the query with numeric, facet and/or tag filters.

facetFilters
search

Filter hits by facet value.

optionalFilters
search

Create filters for ranking purposes, where records that match the filter are ranked highest.

numericFilters
search

Filter on numeric attributes.

tagFilters
search

Filter hits by tags.

sumOrFiltersScores
search

Determines how to calculate the total score for filtering.

Faceting

facets
search

Facets to retrieve.

maxValuesPerFacet
settings search

Maximum number of facet values to return for each facet during a regular search.

If you want to change the number of retrieved facet hits during a search for facet values, see maxFacetHits.

facetingAfterDistinct
search

Force faceting to be applied after de-duplication (via the Distinct setting).

sortFacetValuesBy
settings search

Controls how facet values are sorted.

Highlighting / Snippeting

attributesToHighlight
settings search

List of attributes to highlight.

attributesToSnippet
settings search

List of attributes to snippet, with an optional maximum number of words to snippet.

highlightPreTag
settings search

The HTML string to insert before the highlighted parts in all highlight and snippet results.

highlightPostTag
settings search

The HTML string to insert after the highlighted parts in all highlight and snippet results.

snippetEllipsisText
settings search

String used as an ellipsis indicator when a snippet is truncated.

restrictHighlightAndSnippetArrays
settings search

Restrict highlighting and snippeting to items that matched the query.

Pagination

page
search

Specify the page to retrieve.

hitsPerPage
settings search

Set the number of hits per page.

In most cases, page/hitsPerPage is the recommended method for pagination. Check our full discussion on pagination approaches.

offset
search

Specify the offset of the first hit to return.

In most cases, page/hitsPerPage is the recommended method for pagination. This setting is part of an alternative paging approach.

length
search

Set the number of hits to retrieve (used only with offset).

In most cases, page/hitsPerPage is the recommended method for pagination. This setting is part of an alternative paging approach.

paginationLimitedTo
settings

Set the maximum number of hits accessible via pagination.

Typos

minWordSizefor1Typo
settings search

Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

minWordSizefor2Typos
settings search

Minimum number of characters a word in the query string must contain to accept matches with 2 typos.

typoTolerance
settings search

Controls whether typo tolerance is enabled and how it is applied.

allowTyposOnNumericTokens
settings search

Whether to allow typos on numbers (“numeric tokens”) in the query string.

disableTypoToleranceOnAttributes
settings search

List of attributes on which you want to disable typo tolerance.

disableTypoToleranceOnWords
settings

List of words on which you want to disable typo tolerance.

separatorsToIndex
settings

Control which separators are indexed.

aroundLatLng
search

Search for entries around a central geolocation, enabling a geo search within a circular area.

aroundLatLngViaIP
search

Search for entries around a given location automatically computed from the requester’s IP address.

aroundRadius
search

Define the maximum radius for a geo search (in meters).

aroundPrecision
search

Precision of geo search (in meters), to add grouping by geo location to the ranking formula.

minimumAroundRadius
search

Minimum radius (in meters) used for a geo search when aroundRadius is not set.

insideBoundingBox
search

Search inside a rectangular area (in geo coordinates).

insidePolygon
search

Search inside a polygon (in geo coordinates).

Languages

ignorePlurals
settings search

Treats singular, plurals, and other forms of declensions as matching terms.

removeStopWords
settings search

Removes stop (common) words from the query before executing it.

camelCaseAttributes
settings

List of attributes on which to do a decomposition of camel case words.

decompoundedAttributes
settings

Specify on which attributes in your index Algolia should apply word-splitting (“decompounding”).

keepDiacriticsOnCharacters
settings

Characters that should not be automatically normalized by the search engine.

queryLanguages
settings search

Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.

Query rules

enableRules
search settings

Whether rules should be globally enabled.

ruleContexts
search

Enables contextual rules.

Query strategy

queryType
search settings

Controls if and how query words are interpreted as prefixes.

removeWordsIfNoResults
settings search

Selects a strategy to remove words from the query when it doesn’t match any hits.

advancedSyntax
settings search

Enables the advanced query syntax.

optionalWords
settings search

A list of words that should be considered as optional when found in the query.

disablePrefixOnAttributes
settings

List of attributes on which you want to disable prefix matching.

disableExactOnAttributes
settings search

List of attributes on which you want to disable the exact ranking criterion.

exactOnSingleWordQuery
settings search

Controls how the exact ranking criterion is computed when the query contains only one word.

alternativesAsExact
settings search

List of alternatives that should be considered an exact match by the exact ranking criterion.

Performance

numericAttributesForFiltering
settings

List of numeric attributes that can be used as numerical filters.

allowCompressionOfIntegerArray
settings

Enables compression of large integer arrays.

Advanced

attributeForDistinct
settings

Name of the de-duplication attribute to be used with the distinct feature.

distinct
settings search

Enables de-duplication or grouping of results.

getRankingInfo
search

Retrieve detailed ranking information.

clickAnalytics
search

Enable the Click Analytics feature.

analytics
search

Whether the current query will be taken into account in the Analytics.

analyticsTags
search

List of tags to apply to the query in the analytics.

synonyms
search

Whether to take into account an index’s synonyms for a particular search.

replaceSynonymsInHighlight
settings search

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

minProximity
settings search

Precision of the proximity ranking criterion.

responseFields
settings search

Choose which fields the response will contain. Applies to search and browse queries.

maxFacetHits
settings search

Maximum number of facet hits to return during a search for facet values.

If you want to change the number of retrieved facet values for a regular search, see maxValuesPerFacet.

percentileComputation
search

Whether to include or exclude a query from the processing-time percentile computation.