Wordle Helper API
Overview
To use Wordle Helper, you need an API key. You can get one by creating a free account and visiting your dashboard.
GET Endpoint
https://api.apiverve.com/v1/wordlehelperExample
How to call the Wordle Helper API in different programming languages.
curl -X GET \
"https://api.apiverve.com/v1/wordlehelper?green=A1%2CE5&yellow=R2%2CO3&gray=STLN&pattern=A___E&limit=25" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/wordlehelper?green=A1%2CE5&yellow=R2%2CO3&gray=STLN&pattern=A___E&limit=25', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/wordlehelper?green=A1%2CE5&yellow=R2%2CO3&gray=STLN&pattern=A___E&limit=25', headers=headers)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/wordlehelper?green=A1%2CE5&yellow=R2%2CO3&gray=STLN&pattern=A___E&limit=25", nil)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}{
"status": "ok",
"error": null,
"data": {
"matchCount": 11,
"suggestions": [
"adore",
"afore",
"afire",
"argue",
"aerie",
"azure",
"aurae",
"arame",
"agree",
"aware",
"areae"
],
"filters": {
"green": {
"0": "a",
"4": "e"
},
"yellow": [
"r"
],
"gray": [
"s",
"t",
"l",
"n"
]
},
"pattern": "A___E"
}
}Authentication
The Wordle Helper API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Wordle Helper API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Wordle Helper API:
Find Wordle Words
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
green | string | optional | Correct letters with positions (e.g., A1 means A at position 1) | - | |
yellow | string | optional | Letters in word but wrong position (e.g., R2 means R not at position 2) | - | |
gray | string | optional | Letters not in the word | - | |
pattern | string | optional | Pattern with known letters (use _ for unknown) Length: 5 - 5 chars | - | |
limit | integer | optional | Maximum number of suggestions Range: 1 - 100 |
Response
The Wordle Helper API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<matchCount>11</matchCount>
<suggestions>
<suggestion>adore</suggestion>
<suggestion>afore</suggestion>
<suggestion>afire</suggestion>
<suggestion>argue</suggestion>
<suggestion>aerie</suggestion>
<suggestion>azure</suggestion>
<suggestion>aurae</suggestion>
<suggestion>arame</suggestion>
<suggestion>agree</suggestion>
<suggestion>aware</suggestion>
<suggestion>areae</suggestion>
</suggestions>
<filters>
<green>
<0>a</0>
<4>e</4>
</green>
<yellow>
<item>r</item>
</yellow>
<gray>
<item>s</item>
<item>t</item>
<item>l</item>
<item>n</item>
</gray>
</filters>
<pattern>A___E</pattern>
</data>
</response>
status: ok
error: null
data:
matchCount: 11
suggestions:
- adore
- afore
- afire
- argue
- aerie
- azure
- aurae
- arame
- agree
- aware
- areae
filters:
green:
'0': a
'4': e
yellow:
- r
gray:
- s
- t
- l
- 'n'
pattern: A___E
| key | value |
|---|---|
| matchCount | 11 |
| suggestions | [adore,afore,afire,argue,aerie,azure,aurae,arame,agree,aware,areae] |
| filters | {green:{0:a,4:e},yellow:[r],gray:[s,t,l,n]} |
| pattern | A___E |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
matchCount | number | Total number of matching words found | |
suggestions | array | Array of matching 5-letter word suggestions | |
filters | object | - | |
â”” greenPremium | object | Object mapping positions to correct letters | |
â”” 0 | string | - | |
â”” 4 | string | - | |
â”” yellowPremium | array | Array of letters in word but wrong position | |
â”” grayPremium | array | Array of eliminated letters not in word | |
pattern | string | Pattern with known letters and underscores |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access Wordle Helper through GraphQL to combine it with other API calls in a single request. Query only the wordle helper data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
wordlehelper(
input: {
green: "A1,E5"
yellow: "R2,O3"
gray: "STLN"
pattern: "A___E"
limit: 25
}
) {
matchCount
suggestions
filters {
green {
0
4
}
yellow
gray
}
pattern
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Wordle Helper API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Wordle Helper requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Wordle Helper API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Wordle Helper
Official Wordle Helper packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Wordle Helper works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Wordle Helper?
How many credits does Wordle Helper cost?
Each successful Wordle Helper API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful wordle helper lookups.
Can I use Wordle Helper in production?
The free plan is for testing and development only. For production use of Wordle Helper, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use Wordle Helper from a browser?
What happens if I exceed my Wordle Helper credit limit?
When you reach your monthly credit limit, Wordle Helper API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








