It's alive at https://random-word-api.herokuapp.com/
Return all stored words. This will be a huge data dump and will take a long time to fetch and will probably slow down your application.
Example:
https://random-word-api.herokuapp.com/all
Return one stored word randomly. Options can be further specified, see the parameters menu.
Example:
https://random-word-api.herokuapp.com/word
Return a list of stored language codes. Useful if you want a multilanguage app. See Github to find out how to add your own.
Example:
https://random-word-api.herokuapp.com/languages
Set number of requested words. If it exceeds the maximum stored amount, it will just return all of them.
Example:
https://random-word-api.herokuapp.com/word?number=10
Set length of requested words. This will only return words that contain x amount of letters.
Example:
https://random-word-api.herokuapp.com/word?length=5
Set language of requested words. Go to Github to get more info on how to add your own language.
Currently supported languages:
https://random-word-api.herokuapp.com/languages
Example:
https://random-word-api.herokuapp.com/word?lang=es
Filter words by difficulty/commonality.
Note: Only works when requesting 5 or fewer words (number ≤ 5).
Note: Difficulty is a best-case guarantee, the app might run out of requests and have to fall back to completely random words.
| Value | Difficulty | Description |
|---|---|---|
| 1 | Easy | Very common words (e.g., "water", "house") |
| 2 | Medium-Easy | Common words |
| 3 | Medium | Moderately common words |
| 4 | Medium-Hard | Uncommon words |
| 5 | Hard | Rare words (e.g., "defenestration") |
Example:
https://random-word-api.herokuapp.com/word?number=3&diff=1
docker compose --profile dev up redis app-devYou will need Scala and sbt:
pacman -S scala sbt
sbt runsbt test