We serve our data in JSON format via a simple URL-based interface over HTTPS using either GET or POST, which enables you to use the data in whichever way you require.

This is the high-level introduction – for more in-depth guides, please see the relevant Documentation sections.

Connection Types

Any language or software that can make HTTP requests or fetch web addresses can access our API (for example, you can visit any of the GET API routes in your browser to verify they’re working as expected).

For your integration, you can use whichever library you require. This will vary depending on your development environment. 

URLs (routes) are requested once over HTTPS, and deliver all their data in one go, just like a normal web request.

We do not currently support websockets, webhooks or any other keep-alive or push-notification style connections – in other words, when you want fresh data, you simply request it from our server. We're considering these methods for a future version of our API, so please email us if interested.

URL Format

The API base path is https://api.tilerank.com/api/tilerankapi/v1/request/clients

API routes/endpoints are then appended to this base path, like so:

Query parameters (such as your API Key) are appended as GET request parameters, for example:

If your request is valid and permitted, you will receive a JSON-formatted response to work with. If something is wrong with the request, you will receive an error message.

Responses are delivered over HTTPS as plain-text JSON (JavaScript Object Notation) format, ready to be used however your integration requires.

This format doesn't limit how and where you can use the data in any way: JSON is simply a fast, simple and lightweight delivery mechanism, which is supported in every major language and framework.

We designed these responses to be simple to integrate into a variety of apps and software. If needed, you can also programmatically convert JSON data to CSV/spreadsheet format, or any other format.