Did You Mean API Reference

Did You Mean is a simple tool for correcting spelling mistakes. It returns the corrected text. To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.

Important: Ensure that this API is enabled from within your dashboard to use it in your application. If not, you may receive a 403 error

To get started with minimal code, most of our APIs are available through client libraries:

	
#GET Request
https://api.apiverve.com/v1/didyoumean?query=what weather today is	

	
					

Sample Request

• Python
• C#
• Javascript
• NodeJS
• Java
• Swift
• cURL

	
import requests

url = "https://api.apiverve.com/v1/didyoumean"

querystring = {'query': 'what weather today is'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
	
							

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/didyoumean?query=what weather today is"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}
	
							

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/didyoumean?query=what weather today is');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);
	
							

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/didyoumean?query=what weather today is',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});
	
							

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/didyoumean?query=what weather today is"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
	
							

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/didyoumean?query=what weather today is")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()
	
							

	
curl --request GET \
	--url 'https://api.apiverve.com/v1/didyoumean?query=what weather today is' \
	--header 'x-api-key: YOUR_API_KEY'
	
							

Sample Response

• JSON
• XML
• YAML

	
{
  "status": "ok",
  "error": null,
  "data": {
    "query": "what weather today is",
    "didYouMean": [
      "what is the weather today",
      "what's the weather today",
      "what will the weather be today"
    ]
  },
  "code": 200
}
	
							

	
<Root>
  <status>ok</status>
  <error />
  <data>
    <query>what weather today is</query>
    <didYouMean>what is the weather today</didYouMean>
    <didYouMean>what's the weather today</didYouMean>
    <didYouMean>what will the weather be today</didYouMean>
  </data>
  <code>200</code>
</Root>
	
							

	
status: ok
error: 
data:
  query: what weather today is
  didYouMean:
  - what is the weather today
  - what's the weather today
  - what will the weather be today
code: 200

	
							

The Did You Mean API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

The Did You Mean API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

To use any API, you must have it enabled from within your dashboard. Disabled APIs will fail to respond to your requests.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

	
{
    "status": "error",
    "data": null,
    "error": "tokens have been depleted",
    "code": 429
}
	
							

Each subscription has its own monthly token limit. Your token count is based on your subscription plan. If you reach your limits, don't worry. You can always upgrade or downgrade at any time.

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a detailed JSON.

The Did You Mean API uses the following error code:

For reference, the Did You Mean API uses the following error codes: