API

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

PreviousAndroid development NextDatabase

Last updated 2 months ago

Was this helpful?

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

Responseany

get

GET / HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

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

Responseany

get

GET /validity/{slug} HTTP/1.1
Host: 
Accept: */*

No content

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

Responseany

get

GET /phoneme/{phoneme} HTTP/1.1
Host: 
Accept: */*

No content

Get Word Document

get

Returns the Remède document of word.

Path parameters

wordstringRequired

Query parameters

databasestringOptionalDefault: remede

Responses

Responseany

get

GET /word/{word} HTTP/1.1
Host: 
Accept: */*

No content

Get Random Word Document

get

Returns a random word.

Query parameters

databasestringOptionalDefault: remede

Responses

Responseany

get

GET /random HTTP/1.1
Host: 
Accept: */*

No content

Get Word Of Day

get

Returns the word of day.

Query parameters

databasestringOptionalDefault: remede

Responses

Responseany

get

GET /word-of-day HTTP/1.1
Host: 
Accept: */*

No content

Get Autocomplete

get

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

Path parameters

querystringRequired

Query parameters

databasestringOptionalDefault: remede

Responses

Responseany

get

GET /autocomplete/{query} HTTP/1.1
Host: 
Accept: */*

No content

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

Responseany

get

GET /search/{query} HTTP/1.1
Host: 
Accept: */*

No content

Send New Word

get

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

Path parameters

querystringRequired

Responses

Responseany

get

GET /ask-new-word/{query} HTTP/1.1
Host: 
Accept: */*

No content

Get Cheatsheets

get

Returns all grammar & orthography sheets.

Responses

Responseany

get

GET /sheets HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

Get Cheatsheet By Slug

get

Returns the grammar sheet / orthography with slug slug.

Path parameters

slugstringRequired

Responses

Responseany

get

GET /sheets/{slug} HTTP/1.1
Host: 
Accept: */*

No content

Download Cheatsheet By Slug

get

Returns the markdown file corresponding to sheet with slug slug.

Path parameters

slugstringRequired

Responses

Responseany

get

GET /sheets/download/{slug} HTTP/1.1
Host: 
Accept: */*

No content

Download Database

get

Download the Sqlite database as a file.

Query parameters

variantstringOptionalDefault: remede

Responses

Responseany

get

GET /download HTTP/1.1
Host: 
Accept: */*

No content

Download Binary

get

Download the latest builds.

Path parameters

variantstring · enumRequiredPossible values:

Responses

Responseany

get

GET /release/{variant} HTTP/1.1
Host: 
Accept: */*

No content