Skip to main content
This page documents an earlier version of the API client. For the latest version, see Search dictionary entries.
Required ACL: settings

​
Examples

Query query = new Query("und") { QueryLanguages = new List<String>() { "de"} };

AlgoliaDictionary algoliaDictionary = new AlgoliaDictionary
{
  Name = AlgoliaDictionaryType.Stopwords
};

// Synchronous
DictionaryClient.SearchDictionaryEntries<String>(algoliaDictionary, query);

// Asynchronous
var SearchDictionaryResponse = await DictionaryClient.SearchDictionaryEntriesAsync<string>(algoliaDictionary, query);

​
Parameters

​
dictionary
enum<string>
required
Dictionary type. One of: stopwords, plural, compounds.
​
query
string
required
The term to search for in the dictionary.
​
params
object
Additional parameters for searching.
​
requestOptions
object
A mapping of request options to send along with the request.

​
Response

​
hits
object
Dictionary entries that match the query. For details, see the dictionaryEntries parameter.
​
nbHits
integer
Number of dictionary entries that matched the query.
​
nbPages
integer
Number of pages in the paginated response.
​
page
integer
Page number of the paginated response.

​
Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
{
  "hits": [
    {
      "objectID": "under",
      "language": "en",
      "word": "under",
      "type": "custom"
    },
    {
      // ...
    }
  ],
  "nbHits": 2,
  "page": 0
  "nbPages": 1
}
⌘I