SISTRIX API Documentation

The SISTRIX API provides easy access to a wide range of data, including visibility index, keyword performance and competitive analysis. With flexible endpoints, you can retrieve both current and historical data, customise queries and create custom dashboards, tables and tools.

To get started, generate your authentication key and follow this guide to set up, authenticate and run queries. Each endpoint includes examples and detailed explanations to help you get the most out of the API.

For a more hands-on approach, use our Sandbox to easily build, test and fine-tune your API requests.

To fully utilize the SISTRIX API, you’ll need a SISTRIX Professional or Premium account. However, with the Plus package, you can already access some basic functions, including the visibility index

How to use the SISTRIX-API

If you’re already familiar with web APIs, you can skip ahead and follow our Quick-Start Guide, which outlines all the essential steps for using the API efficiently.

Sending Requests

The API is accessed through simple HTTP requests, which include the domain—api.sistrix.com—the specific directory that determines the selected API function, and the query string containing parameters along with your API key. Alternatively, parameters can also be sent easily via a POST request.

https://api.sistrix.com/credits?api_key=Hb...MJ&format=json

Response Handling

The SISTRIX API offers two response modes, selectable via the format parameter. You can receive the response as a JSON array, or alternatively, choose an XML format.

Authentication

Authentication is done using a unique key, which you can obtain through the SEO tool. This key identifies your account and manages credit usage, so it must not be shared. To authenticate with the SISTRIX-API, simply include your personal key as a standard parameter using the identifier api_key.

Credits

Every account from the Plus package onwards receives a weekly allocation of credits, which can be used to download reports or retrieve data via the API.

The cost of calling an API function is listed in the documentation next to the function name. If no price is shown, the function is free to use.

Typically, the cost is based on the number of data points retrieved. To check your current credit balance, you can use the “credits” function or view it in the SEO tool under the “API Access” tab.

https://api.sistrix.com/credits?api_key=Hb...MJ&format=json

At the end of each API response you can find the amount of credits used.

Parameter

Parameters control which data the API retrieves. Each function’s specific parameters are explained in the corresponding section of the API documentation.

The documentation distinguishes between two types of parameters you can include in an API request:

  • Mandatory Parameters: These must be included, as the request cannot be processed without them.
  • Optional Parameters: These allow you to customize the response to fit your needs and can also be used to access historical data when available.

Whether the parameters are included in the body of a POST request or simply in the URL of a GET request makes no difference to the API. Both methods are equally valid for sending parameters.

Sandbox

The Sandbox is a specialized tool we’ve designed for easy use and request building. Each function in the API documentation allows you to construct requests in various programming languages, tailored to your needs, with just a few clicks.

Available languages include:

  • PHP
  • Python
  • NodeJS
  • cURL

Additionally, the tool offers helpful features like automatically detecting possible parameter values, such as a project’s HASH. Finally, you can test the API functions directly within the documentation to verify if the response matches your expectations.

Please note: Live tests will consume credits.

Quick-Start Guide

  1. Create a SISTRIX-Professional Account.
    You can find a list of all packages and the associated usage rights here.
  2. Generate Your Personal API Key.
    You can find the API key overview and your credit status in the SEO-Tool under the menu option “API access“.
  3. Familiarize Yourself with Our Limitations.
    In order to provide the best user experience for all users, we have created a fair-use policy. You can find this in the API documentation under “Limitations“.
  4. Get Started
    Here, you’ll find a comprehensive overview of all available API functions.