Levenshtein DistanceLevenshtein Distance API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 419ms|p50: 396ms|p75: 434ms|p90: 479ms|p99: 570ms

Levenshtein Distance calculates the minimum number of single-character edits needed to transform one string into another.

The Levenshtein Distance API provides reliable and fast access to levenshtein distance data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use Levenshtein Distance, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

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

Code Examples

Here are examples of how to call the Levenshtein Distance API in different programming languages:

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/levenshteindistance" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/levenshteindistance', {
  method: 'POST',
  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.post('https://api.apiverve.com/v1/levenshteindistance', headers=headers)

data = response.json()
print(data)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const req = https.request('https://api.apiverve.com/v1/levenshteindistance', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/levenshteindistance');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"

)

func main() {
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/levenshteindistance", 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))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/levenshteindistance')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var response = await client.GetAsync("https://api.apiverve.com/v1/levenshteindistance");
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

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

Parameters

The following parameters are available for the Levenshtein Distance API:

Calculate Edit Distance

ParameterTypeRequiredDescriptionDefaultExample
string1stringrequired
First string to compare (max 10,000 characters)
-kitten
string2stringrequired
Second string to compare (max 10,000 characters)
-sitting

Response

The Levenshtein Distance API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "status": "ok",
  "error": null,
  "data": {
    "distance": 3,
    "similarity": 57.14,
    "matchLevel": "medium",
    "string1Length": 6,
    "string2Length": 7,
    "string1": "kitten",
    "string2": "sitting"
  }
}
XML Response
200 OK
Add ?format=xml to the request URL to get XML response
YAML Response
200 OK
status: ok
error: null
data:
  distance: 3
  similarity: 57.14
  matchLevel: medium
  string1Length: 6
  string2Length: 7
  string1: kitten
  string2: sitting
CSV Response
200 OK
keyvalue
distance3
similarity57.14
matchLevelmedium
string1Length6
string2Length7
string1kitten
string2sitting

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
distancenumber3The Levenshtein edit distance between the two strings
similaritynumber57.14Similarity percentage from 0 to 100
matchLevelstring"medium"Similarity level: exact, high, medium, low, or none
string1LengthPremiumnumber6Length of the first string
string2LengthPremiumnumber7Length of the second string
string1Premiumstring"kitten"The first input string
string2Premiumstring"sitting"The second input string

Headers

Required and optional headers for Levenshtein Distance API requests:

Header NameRequiredExample ValueDescription
X-API-Keyrequiredyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
Acceptoptionalapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentoptionalMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDoptionalreq_123456789Custom request identifier for tracking and debugging requests
Cache-Controloptionalno-cacheControl caching behavior for the request and response

Learn more about request headers →

GraphQL AccessALPHA

Access Levenshtein Distance through GraphQL to combine it with other API calls in a single request. Query only the levenshtein distance data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Levenshtein Distance 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 {
  levenshteindistance {
    distance
    similarity
    matchLevel
    string1Length
    string2Length
    string1
    string2
  }
}

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

CORS Support

The Levenshtein Distance API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Levenshtein Distance directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can call Levenshtein Distance directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Levenshtein Distance API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Levenshtein Distance users.

PlanRate LimitDescription
FreeLimitedHard rate limit enforced - exceeding will return 429 errors
Starter0 requests/minProduction ready - standard traffic priority
Pro0 requests/minProduction ready - preferred traffic priority
Mega0 requests/minProduction ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Levenshtein Distance response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Levenshtein Distance returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Levenshtein Distance:

  • Monitor the rate limit headers to track your Levenshtein Distance usage (Free plan only)
  • Cache levenshtein distance responses where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle Levenshtein Distance performance

Note: Levenshtein Distance rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Levenshtein Distance on Free tier.

Error Codes

The Levenshtein Distance API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Levenshtein Distance with SDKs

Get started quickly with official Levenshtein Distance SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

Integrate Levenshtein Distance with No-Code API Tools

Connect the Levenshtein Distance API to your favorite automation platform without writing code. Build workflows that leverage levenshtein distance data across thousands of apps.

All platforms use your same API key to access Levenshtein Distance. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for Levenshtein Distance?
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 Levenshtein Distance and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Levenshtein Distance cost?

Each successful Levenshtein Distance 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 levenshtein distance lookups.

Can I use Levenshtein Distance in production?

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

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