https://github.com/malted/wordle-list
An API for getting and validating words for Wordle clones
https://github.com/malted/wordle-list
wordle
Last synced: 2 months ago
JSON representation
An API for getting and validating words for Wordle clones
- Host: GitHub
- URL: https://github.com/malted/wordle-list
- Owner: malted
- Created: 2022-02-13T22:51:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-23T00:39:38.000Z (over 4 years ago)
- Last Synced: 2025-01-16T22:48:18.982Z (over 1 year ago)
- Topics: wordle
- Language: TypeScript
- Homepage:
- Size: 50.8 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wordle-list
## Overview
Internally, the Wordle game has two lists of words.
- One very long list (10638 words) containing all the words that are allowed to
be guessed. This is to stop players eliminating letters by guessing things
like _aeiou_.
- One shorter list (2309 words) containing all the words that have been, are, or
will be a day's answer, or _Wordle_.
This API makes it simple to get new words from the short list or to validate a
player's input word against both lists.
I am hosting this myself, and while there is a rate limit in place, it is
generous enough that you will not hit it if you are using the API in a
legitimate manner. Don't spoil a nice thing.
## API Reference
### Base URL
```
https://wordle-list.malted.dev/
```
---
### Validate a word
```
GET /valid
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------------------------ |
| `word` | `string` | **Required**. The word you wish to validate |
#### Example
`https://wordle-list.malted.dev/valid?word=acorn`
#### Response
| Parameter | Type | Description |
| :-------- | :-------- | :------------------------------------------------------- |
| `valid` | `boolean` | Whether the supplied word was in the list of valid words |
---
### Get a new word
```
GET /choice
```
#### Example
`https://wordle-list.malted.dev/choice`
#### Response
| Parameter | Type | Description |
| :-------- | :------- | :------------------------------------------ |
| `word` | `string` | A random word from the list of choice words |