search
githubEdit

📪API

Remède provides an API that let you browse the dictionaries databases !

The public API documentation is available at https://api-remede.camarm.fr/docsarrow-up-right. You can also browse the OpenAPI specifications below.

hashtag
Root

get

Returns useful information about API and datasets

  • Its version
  • The available dictionaries
    • Their name (name)
    • Their unique identifier (hash) (hash)
    • Their slug; used to download or search in specific database (slug)
    • The number of words in the database (total)
    • Does the database respect the Remède JSON Schema (valid)
    • Which schema does it follow (schema)
    • Database readable size (size)
Responses
get
/
200

Successful Response

No content

hashtag
Get Validity

get

Returns the dictionary slug validity (true/false). It's a check to know if it follows his JSON Schema. If state is unknown returns null.

Path parameters
slugstringRequired
Responses
get
/validity/{slug}
No content

hashtag
Get Words By Phoneme

get

Get th list of words with phoneme phoneme. It returns a list of tuples containing the word as the first element, and its document as the second element.

Path parameters
phonemestringRequired
Query parameters
databasestringOptionalDefault: remede
Responses
get
/phoneme/{phoneme}
No content

hashtag
Get Word Document

get

Returns the Remède document of word.

Path parameters
wordstringRequired
Query parameters
databasestringOptionalDefault: remede
Responses
get
/word/{word}
No content

hashtag
Get Random Word Document

get

Returns a random word.

Query parameters
databasestringOptionalDefault: remede
Responses
get
/random
No content

hashtag
Get Word Of Day

get

Returns the word of day.

Query parameters
databasestringOptionalDefault: remede
Responses
get
/word-of-day
No content

hashtag
Get Autocomplete

get

Returns the 6 first word starting by query. Not case and accent sensible !

Path parameters
querystringRequired
Query parameters
databasestringOptionalDefault: remede
Responses
get
/autocomplete/{query}
No content

hashtag
Get Search Results

get

Returns the word starting with query. Not case and accent sensible !

Path parameters
querystringRequired
Query parameters
pageintegerOptionalDefault: 0
databasestringOptionalDefault: remede
Responses
get
/search/{query}
No content

hashtag
Send New Word

get

Save the word query as a word to add to the dictionary.

Path parameters
querystringRequired
Responses
get
/ask-new-word/{query}
No content

hashtag
Get Cheatsheets

get

Returns all grammar & orthography sheets.

Responses
get
/sheets
200

Successful Response

No content

hashtag
Get Cheatsheet By Slug

get

Returns the grammar sheet / orthography with slug slug.

Path parameters
slugstringRequired
Responses
get
/sheets/{slug}
No content

hashtag
Download Cheatsheet By Slug

get

Returns the markdown file corresponding to sheet with slug slug.

Path parameters
slugstringRequired
Responses
get
/sheets/download/{slug}
No content

hashtag
Download Database

get

Download the Sqlite database as a file.

Query parameters
variantstringOptionalDefault: remede
Responses
get
/download
No content

hashtag
Download Binary

get

Download the latest builds.

Path parameters
variantstring · enumRequiredPossible values:
Responses
get
/release/{variant}
No content
PreviousAndroid developmentNextDatabase

Last updated

Was this helpful?