- Type:
string
- Default:
""
- Scope:
search
Usage
Thequery
parameter represents the query string Algolia matches against your index.
For an overview of how Algolia interprets and ranks queries,
see Relevance overview.
Formatting rules
- An empty string (
""
) returns all records, sorted bycustomRanking
. - Query strings can be up to 512 bytes long.
- Boolean operators (
AND
,OR
,NOT
) aren’t supported in the query string. - Multi-word queries require all words to match.
For example,
hot dog
only returns records containing bothhot
anddog
.
Related features and parameters
- Boolean logic: use filters or
optionalWords
. - Broader matching when no results are found: use
removeWordsIfNoResults
. - Phrase exclusion or exact matching: use
advancedSyntax
.
Example
Current API clients
Current API clients
Legacy API clients
Legacy API clients