API Reference

The search API provides a single endpoint, available with both GET and POST methods.

Although the SDK is the recommended way of using XO Search, a REST API is provided for convenience. This API provides a single endpoint, available with both GET and POST methods.

Method

XO Search API supports both GET and POST methods:

  • GET requests: parameters must be passed in the URL's query string. Parameters must be URL-encoded.

  • POST requests: parameters must be passed in the request body, as JSON

Both will work the same as long as you follow the right format, which is described below.

Format

The API uses JSON encoded as UTF-8.

The body of POST requests must be a JSON object and the Content-Type header should be set to application/json; charset=UTF-8.

The body of responses is always a JSON object, and the Content-Type is always application/json; charset=UTF-8.

APIs

Go further

For more detailed information about the parameters and usage, check the following pages.

PreviousGetting startedNextSearch API

Last updated