Spec

Code snippets

curl "https://api.oanor.com/soundex-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/soundex-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/soundex-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/soundex-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "notes": "Soundex ignores case and non-letters. Levenshtein is case-insensitive unless case_sensitive=true. Useful for deduplication, fuzzy search, name matching and genealogy.",
        "service": "soundex-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/compare": "Soundex + Levenshtein comparison with a likely-match flag.",
            "GET /v1/soundex": "American Soundex code of a word.",
            "GET /v1/levenshtein": "Edit distance and similarity between two strings."
        },
        "description": "Phonetic and fuzzy string matching: Soundex code, Levenshtein edit distance, and a combined comparison."
    },
    "meta": {
        "timestamp": "2026-06-05T19:50:12.764Z",
        "request_id": "1a8cf773-123c-4cd6-bd0c-f2dcb74f0fd6"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}