Phonetic EncoderPhonetic Encoder API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 156ms|p50: 150ms|p75: 160ms|p90: 171ms|p99: 193ms

Overview

To use Phonetic Encoder, 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/phonetic

Example

How to call the Phonetic Encoder API in different programming languages.

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/phonetic?word=smith&algorithm=both" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/phonetic?word=smith&algorithm=both', {
  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/phonetic?word=smith&algorithm=both', 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/phonetic?word=smith&algorithm=both", 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": {
    "word": "smith",
    "soundex": "S530",
    "metaphone": "SM0"
  }
}

Authentication

The Phonetic Encoder 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 Phonetic Encoder API directly in your browser with live requests and responses.

Parameters

The Phonetic Encoder API supports multiple query options. Use one of the following:

Option 1: Encode Word

ParameterTypeRequiredDescriptionDefaultExample
wordstringrequired
The word to encode phonetically
-smith
algorithmstringoptional
Algorithm to use
Supported values: soundexmetaphoneboth
bothboth

Option 2: Compare Words

ParameterTypeRequiredDescriptionDefaultExample
wordstringrequired
The first word to compare
-smith
comparestringrequired
The second word to compare
-smythe
algorithmstringoptional
Algorithm to use
Supported values: soundexmetaphoneboth
bothboth

Response

The Phonetic Encoder 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>
    <word>smith</word>
    <soundex>S530</soundex>
    <metaphone>SM0</metaphone>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  word: smith
  soundex: S530
  metaphone: SM0
CSV Response
200 OK
keyvalue
wordsmith
soundexS530
metaphoneSM0

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:

FieldTypeSample ValueDescription
wordstring"smith"
-
soundexstring"S530"
-
metaphonestring"SM0"
-

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 Phonetic Encoder through GraphQL to combine it with other API calls in a single request. Query only the phonetic encoder data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Phonetic Encoder 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 {
  phonetic(
    input: {
      word: "smith"
      algorithm: "both"
    }
  ) {
    word
    soundex
    metaphone
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Phonetic Encoder 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

Phonetic Encoder 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 Phonetic Encoder 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 Phonetic Encoder

Official Phonetic Encoder packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Phonetic Encoder 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 Phonetic Encoder?
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 Phonetic Encoder and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Phonetic Encoder cost?

Each successful Phonetic Encoder 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 phonetic encoder lookups.

Can I use Phonetic Encoder in production?

The free plan is for testing and development only. For production use of Phonetic Encoder, 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 Phonetic Encoder from a browser?
Yes! The Phonetic Encoder 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 Phonetic Encoder credit limit?

When you reach your monthly credit limit, Phonetic Encoder 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?