Skip to main content
POST
/
1
/
dictionaries
/
{dictionaryName}
/
search
curl
curl --request POST \
  --url https://algolia_application_id.algolia.net/1/dictionaries/plurals/search \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"query":"","page":0,"hitsPerPage":20,"language":"af"}'
{
  "hits": [
    {
      "objectID": "828afd405e1f4fe950b6b98c2c43c032",
      "language": "af",
      "word": "the",
      "words": [
        "cheval",
        "cheveaux"
      ],
      "decomposition": [
        "kopf",
        "schmerz",
        "tablette"
      ],
      "state": "enabled",
      "type": "custom"
    }
  ],
  "page": 1,
  "nbHits": 20,
  "nbPages": 1
}
Required ACL: settings

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
dictionaryName
enum<string>
required

Dictionary type in which to search.

Available options:
plurals,
stopwords,
compounds

Body

application/json

Search parameter.

​
query
string
default:""
required

Search query.

​
page
integer
default:0

Page of search results to retrieve.

Required range: x >= 0
​
hitsPerPage
integer
default:20

Number of hits per page.

Required range: 1 <= x <= 1000
​
language
enum<string>

ISO code for a supported language.

Available options:
af,
ar,
az,
bg,
bn,
ca,
cs,
cy,
da,
de,
el,
en,
eo,
es,
et,
eu,
fa,
fi,
fo,
fr,
ga,
gl,
he,
hi,
hu,
hy,
id,
is,
it,
ja,
ka,
kk,
ko,
ku,
ky,
lt,
lv,
mi,
mn,
mr,
ms,
mt,
nb,
nl,
no,
ns,
pl,
ps,
pt,
pt-br,
qu,
ro,
ru,
sk,
sq,
sv,
sw,
ta,
te,
th,
tl,
tn,
tr,
tt,
uk,
ur,
uz,
zh

Response

OK

​
hits
object[]
required

Dictionary entries matching the search criteria.

​
page
integer
required

Requested page of the API response.

Algolia uses page and hitsPerPage to control how search results are displayed (paginated).

  • hitsPerPage: sets the number of search results (hits) displayed per page.
  • page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on.

For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.

Required range: x >= 0
​
nbHits
integer
required

Number of results (hits).

Example:

20

​
nbPages
integer
required

Number of pages of results.

Example:

1

⌘I