Wordle HelperWordle Helper API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 312ms|p50: 295ms|p75: 323ms|p90: 357ms|p99: 424ms

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

URL
https://api.apiverve.com/v1/wordlehelper

Example

How to call the Wordle Helper API in different programming languages.

cURL Request
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"
JavaScript (Fetch API)
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);
Python (Requests)
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)
Go (net/http)
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))
}
Example 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"
  }
}

Authentication

The Wordle Helper API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive 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

ParameterTypeRequiredDescriptionDefaultExample
greenstringoptional
Correct letters with positions (e.g., A1 means A at position 1)
-A1,E5
yellowstringoptional
Letters in word but wrong position (e.g., R2 means R not at position 2)
-R2,O3
graystringoptional
Letters not in the word
-STLN
patternstringoptional
Pattern with known letters (use _ for unknown)
Length: 5 - 5 chars
-A___E
limitintegeroptional
Maximum number of suggestions
Range: 1 - 100
2525

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 Response
200 OK
<?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>
YAML Response
200 OK
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
CSV Response
200 OK
keyvalue
matchCount11
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]}
patternA___E

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains 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:

Response fields marked with Premium are available exclusively on paid plans.View pricing
FieldTypeSample ValueDescription
matchCountnumber11
Total number of matching words found
suggestionsarray["adore", ...]
Array of matching 5-letter word suggestions
filtersobject{...}
-
â”” greenPremiumobject{...}
Object mapping positions to correct letters
â”” 0string"a"
-
â”” 4string"e"
-
â”” yellowPremiumarray["r"]
Array of letters in word but wrong position
â”” grayPremiumarray["s", ...]
Array of eliminated letters not in word
patternstring"A___E"
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.

Test Wordle Helper in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  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?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Wordle Helper and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
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?
Yes! The Wordle Helper API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
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.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?