API Reference

The SISTRIX Toolbox API enables automated and machine suitable access to the majority of the toolbox data. This will enable you to integrate the toolbox easily into your internal processes and tools.

The API is part of your Toolbox account and you will not need a special package or extra options. The available data corresponds to the booked toolbox modules. On this page, you will find general information on our API. The Toolbox data can be accessed through the domain, keyword, link and optimizer methods. These methods are documented on separate pages. Similarly, there is a page for API return codes and error messages.

Connection to Microsoft Excel & Google Tables

Although the SISTRIX API was originally developed for the usage of scripting- and programming-languages, it can also be used in connection with Microsoft Excel and Google Tables. We will explore how to connect those two solutions in two separate articles.

API authentication

Authentication happens through the transmission of an API key. The main user account can request your API Key on the following page and it will usually be available shortly thereafter:

https://us.sistrix.com/account/api

The API key needs to be conveyed through the parameter “api_key” with every request. If this doesn’t happen or if an invalid API key is used, the API reports the error message “100”. In order to receive a new API key, please contact our support and we will promptly change your API key.

Credit system

Credits are debited from the your account depending on the requested data. Respective credit costs are listed alongside the descriptions. The credits for your account refill overnight, from Sunday to Monday. Per each toolbox module subscribed, the account will be credited with 10,000 credits. Credits do not rollover from the previous week. If all of the 5 toolbox modules are booked and further API credits are needed, individual arrangements can be organized. For this, please contact the toolbox support. The amount of remaining credits can be obtained via the API:

https://api.sistrix.com/credits?api_key=$key

Output format

All requests and answer values are UTF-8 encoded. Ordinarily, answers of the API interface occur in XML format. Alternatively, you can receive data in the JSON format. For this, the parameter “format” needs to be added to every URL, with the value “json”.

https://api.sistrix.com/...?format=json

Country selection

If no country is explicitly chosen, all return values refer to the toolbox data in Germany. Other countries can be selected via the transmission of the “country” parameters.

Possible values for the country parameter: de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr

https://api.sistrix.com/...?country=$country

Extended data basis

API requests occur, by default, on the standard database of the toolbox. These include two million keywords per country – one million for desktop results and one million for smartphone data, respectively. On top of that, we offer an extended database with millions more keywords in some countries. These Keywords are updated monthly rather than weekly, but are considerably more comprehensive. In order to reach the extended database via the API, the parameter “extended” needs to be set to the value “true”.

https://api.sistrix.com/...?extended=true

Smartphone data

In addition to the desktop search results, the toolbox also calculates results for searches made with smartphones. In order to retrieve these results via the API, the parameter “mobile” needs to be set to the value “true”. The extended database is not available for smartphone data, therefore a combination with “extended” is not possible.

https://api.sistrix.com/...?mobile=true