SISTRIX API

https://www.sistrix.com/api
Admin
SISTRIX API provides access to SEO data including visibility index, keyword performance, competitive...
Tokens:133,860
Snippets:779
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### SISTRIX API - Getting Started

Source: https://www.sistrix.com/api/index

Information on how to use the SISTRIX API, including sending requests, handling responses, authentication, and managing credits.

```APIDOC
## Getting Started with the SISTRIX API

The SISTRIX API allows access to various data points through simple HTTP requests.

### Sending Requests
Requests are made to `api.sistrix.com` with a specific directory for the function and a query string containing parameters and your API key. Parameters can also be sent via a POST request.

**Example Request URL:**
```
https://api.sistrix.com/credits?api_key=YOUR_API_KEY&format=json
```

### Response Handling
Responses can be received in either JSON or XML format by specifying the `format` parameter.

### Authentication
Authentication is performed using a unique `api_key` obtained from the SISTRIX tool. This key must not be shared.

### Credits
API calls consume credits, which are allocated weekly starting from the Plus package. The cost of each function is listed in its documentation. Some functions are free.

**Checking Credit Balance:**
Use the `credits` function or check the 'API Access' tab in the SEO tool.
```
https://api.sistrix.com/credits?api_key=YOUR_API_KEY&format=json
```
Credit usage is reported at the end of each API response.

### Parameters
Parameters control the data retrieved by the API. They can be **Mandatory** or **Optional**. Whether sent in the URL of a GET request or the body of a POST request, parameters are handled the same way.
```

--------------------------------

### cURL Request for domain.visibilityindex.overview

Source: https://www.sistrix.com/api/domain/domain-visibilityindex-overview

This snippet provides a basic cURL command to make a GET request to the domain.visibilityindex.overview endpoint. It outlines the URL structure, but specific parameters like api_key and format are not included in this minimal example.

```bash
curl https://api.sistrix.com/domain.visibilityindex.overview \

```

--------------------------------

### Start On-Page Crawl with cURL

Source: https://www.sistrix.com/api/project/project-start-onpage-check

Initiates an on-page crawl using the cURL command-line tool. This example shows the basic structure for sending a request to the SISTRIX API.

```bash
curl https://api.sistrix.com/project.start.onpage.check \


```

--------------------------------

### Install Node.js on Linux (Debian/Ubuntu)

Source: https://www.sistrix.com/api/connection-to-chatbot-ai/setting-up-claude

Installs the Node.js LTS version on Debian/Ubuntu systems using a provided script. This is a prerequisite for using npx.

```bash
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - sudo apt-get install -y nodejs
```

--------------------------------

### cURL GET Request Example

Source: https://www.sistrix.com/api/keyword/keyword-domain-sem

This is a basic cURL command structure for making a request to the Sistrix API. It shows the base URL for the 'keyword.domain.sem' endpoint. To make a functional request, you would append necessary parameters like 'api_key', 'format', and any other filters directly to this URL.

```bash
curl https://api.sistrix.com/keyword.domain.sem \

```

--------------------------------

### Verify Node.js and npm Installation

Source: https://www.sistrix.com/api/connection-to-chatbot-ai/setting-up-claude

Checks if Node.js and npm are installed correctly and meet the required version criteria. Node.js v16.x or higher is expected.

```bash
node -v # expect v16.x or higher 
npm -v
```

--------------------------------

### PHP cURL Request Example for Sistrix API

Source: https://www.sistrix.com/api/keyword/keyword-domain-seo

This PHP snippet demonstrates how to make a request to the Sistrix API using cURL. It sets up the base URL, defines POST data including the API key and desired format, and initializes a cURL session. It's a foundational example for interacting with the API.

```php
$baseUrl = "https://api.sistrix.com/keyword.domain.seo";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);

```

--------------------------------

### Get Amazon Product Overview using cURL

Source: https://www.sistrix.com/api/marketplace/marketplace-product-overview

This command-line example shows how to request product overview data from the Sistrix API using `curl`. It specifies the endpoint URL and implies that authentication and other parameters would be added to complete the request.

```bash
curl https://api.sistrix.com/marketplace.product.overview \

```

--------------------------------

### Retrieve Marketplace Methods (cURL)

Source: https://www.sistrix.com/api/marketplace

This is a basic cURL command to make a GET request to the Sistrix API marketplace endpoint. It is a foundational example for understanding how to interact with the API from the command line. To include parameters like api_key and format, they would typically be appended to the URL or sent as data, depending on the API's design.

```bash
curl https://api.sistrix.com/marketplace \

```

--------------------------------

### Get Domain Methods (PHP, Python, cURL, Node.js)

Source: https://www.sistrix.com/api/domain

This snippet demonstrates how to call the SISTRIX API's domain method to retrieve a list of available domain methods. It includes examples for PHP using cURL, Python using the requests library, a basic cURL command, and Node.js using the fetch API. The API requires an api_key and an address_object (domain/host/path/url). The response format can be specified as JSON or XML.

```php
$baseUrl = "https://api.sistrix.com/domain";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

```python
import requests
baseUrl = 'https://api.sistrix.com/domain'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

```curl
curl https://api.sistrix.com/domain \

```

```javascript
let baseUrl = 'https://api.sistrix.com/domain';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Example SISTRIX API URL for Domain Overview

Source: https://www.sistrix.com/api/connection-to-google-sheets

This example shows the structure of a URL to request the domain overview data from the SISTRIX API. It includes the base API endpoint, your personal API key, and the domain for which you want to retrieve information. This URL is used as the first parameter in the `importXML` function.

```url
https://api.sistrix.com/domain.overview?api_key=[API_KEY]&domain=sistrix.de
```

--------------------------------

### Send POST Request to Keyword SEO Competition API

Source: https://www.sistrix.com/api/keyword/keyword-seo-competition

This section provides examples of how to send a POST request to the SISTRIX API's keyword.seo.competition endpoint using different programming languages. It covers PHP, Python, and Node.js, showing how to set the base URL and post data. The response is typically text-based.

```php
$baseUrl = "https://api.sistrix.com/keyword.seo.competition";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

```python
import requests
baseUrl = 'https://api.sistrix.com/keyword.seo.competition'
post = {
    "api_key": "[API_KEY]",
    "format": "json"
}
response = requests.post(baseUrl, post)
data = response.text
```

```javascript
let baseUrl = 'https://api.sistrix.com/keyword.seo.competition';
let form = new FormData();
form.append("api_key", "[API_KEY]");
form.append("format", "json");

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Make domain.overview Request in JavaScript

Source: https://www.sistrix.com/api/domain/domain-overview

This JavaScript snippet demonstrates how to make a POST request to the domain.overview endpoint using the Fetch API. It sets up the base URL and uses FormData to send the request, processing the response as text.

```javascript
let baseUrl = 'https://api.sistrix.com/domain.overview';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})

```

--------------------------------

### Make GET Request to Keyword SEO Competition API

Source: https://www.sistrix.com/api/keyword/keyword-seo-competition

This snippet demonstrates how to make a GET request to the keyword.seo.competition endpoint of the SISTRIX API. It requires an API key and can optionally specify the response format (JSON or XML). The example uses cURL to send the request.

```cURL
curl https://api.sistrix.com/keyword.seo.competition \
  --data-urlencode "api_key=[API_KEY]" \
  --data-urlencode "format=json"
```

--------------------------------

### Node.js Fetch POST for Keyword Environment

Source: https://www.sistrix.com/api/marketplace/marketplace-keyword-environment

This JavaScript example shows how to make a POST request to the SISTRIX API using the Fetch API. It defines the base URL and prepares to send form data. The response is processed to return the text content, which would typically be JSON or XML.

```javascript
let baseUrl = 'https://api.sistrix.com/marketplace.keyword.environment';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})

```

--------------------------------

### Fetch Project Overview using PHP

Source: https://www.sistrix.com/api/project/project-overview

This PHP code snippet demonstrates how to fetch project overview data from the Sistrix API using cURL. It sends a POST request with the API key and desired format. Ensure you replace '[API_KEY]' with your actual API key.

```php
$baseUrl = "https://api.sistrix.com/project.overview";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

--------------------------------

### JavaScript Fetch API for domain.kwcount.seo.top10

Source: https://www.sistrix.com/api/domain/domain-kwcount-seo-top10

This JavaScript example utilizes the Fetch API to send a POST request to the domain.kwcount.seo.top10 endpoint. It demonstrates basic request setup and handling the response as text.

```javascript
let baseUrl = 'https://api.sistrix.com/domain.kwcount.seo.top10';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### cURL Command for Entity Overview

Source: https://www.sistrix.com/api/ai/ai-entity-overview

Provides a basic cURL command structure to interact with the ai.entity.overview API endpoint. This example is a starting point and would typically include API key and other parameters.

```bash
curl https://api.sistrix.com/ai.entity.overview \

```

--------------------------------

### Making POST Requests for Domain Ideas (PHP, Python, Curl, Node.js)

Source: https://www.sistrix.com/api/domain/domain-ideas

Demonstrates how to make POST requests to the domain.ideas endpoint using various programming languages and tools. These examples show how to construct the request, set parameters, and retrieve the response, which is useful for integrating the API into different applications.

```php
$baseUrl = "https://api.sistrix.com/domain.ideas";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);

```

```python
import requests
baseUrl = 'https://api.sistrix.com/domain.ideas'
post = {

}
response = requests.post(baseUrl, post)
data = response.text

```

```curl
curl https://api.sistrix.com/domain.ideas \

```

```javascript
let baseUrl = 'https://api.sistrix.com/domain.ideas';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})

```

--------------------------------

### List Project Methods using Node.js

Source: https://www.sistrix.com/api/project

This Node.js code snippet illustrates how to use the Fetch API to call the Sistrix API for project methods. It sets up a POST request and processes the response as text.

```javascript
let baseUrl = 'https://api.sistrix.com/project';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Fetch Project Overview using Python

Source: https://www.sistrix.com/api/project/project-overview

This Python code snippet shows how to retrieve project overview data from the Sistrix API using the requests library. It makes a POST request to the specified URL. Note that the 'post' dictionary is currently empty and should be populated with parameters like 'api_key' and 'format'.

```python
import requests
baseUrl = 'https://api.sistrix.com/project.overview'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

--------------------------------

### Fetch Project Keyword SERPs using cURL Command Line

Source: https://www.sistrix.com/api/project/project-keyword-serps

This is a command-line example using cURL to request SERP data from the SISTRIX API for a project keyword. It illustrates a basic GET request structure.

```bash
curl https://api.sistrix.com/project.keyword.serps \

```

--------------------------------

### Make domain.overview Request in PHP

Source: https://www.sistrix.com/api/domain/domain-overview

This PHP snippet demonstrates how to make a POST request to the domain.overview endpoint of the SISTRIX API using cURL. It sends the API key and desired format, then retrieves and closes the response.

```php
$baseUrl = "https://api.sistrix.com/domain.overview";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);

```

--------------------------------

### Fetch Product Reviews using cURL command line

Source: https://www.sistrix.com/api/marketplace/marketplace-product-reviews

An example of how to fetch product reviews using the cURL command-line tool. This is a basic representation and may require additional parameters for actual use.

```bash
curl https://api.sistrix.com/marketplace.product.reviews \


```

--------------------------------

### Fetch Project Keyword SERPs using Python Requests

Source: https://www.sistrix.com/api/project/project-keyword-serps

This Python example shows how to call the SISTRIX API to get SERP data for a project keyword. It utilizes the `requests` library to send a POST request, handling the response as text.

```python
import requests
baseUrl = 'https://api.sistrix.com/project.keyword.serps'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

--------------------------------

### Fetch Project Overview using Node.js

Source: https://www.sistrix.com/api/project/project-overview

This Node.js code snippet demonstrates how to fetch project overview data from the Sistrix API using the Fetch API. It sends a POST request to the API endpoint. The 'form' object should be populated with necessary parameters such as 'api_key' and 'format' before sending the request.

```javascript
let baseUrl = 'https://api.sistrix.com/project.overview';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Make domain.overview Request with cURL

Source: https://www.sistrix.com/api/domain/domain-overview

This command-line snippet illustrates how to make a request to the domain.overview endpoint using cURL. It specifies the URL for the request.

```bash
curl https://api.sistrix.com/domain.overview \


```

--------------------------------

### Make domain.overview Request in Python

Source: https://www.sistrix.com/api/domain/domain-overview

This Python snippet shows how to make a POST request to the domain.overview endpoint using the requests library. It sends the API key and other parameters in the request body and retrieves the response text.

```python
import requests
baseUrl = 'https://api.sistrix.com/domain.overview'
post = {

}
response = requests.post(baseUrl, post)
data = response.text

```

--------------------------------

### Retrieve Project On-Page Crawl Data (cURL)

Source: https://www.sistrix.com/api/project/project-onpage-crawl

This example shows how to retrieve project on-page crawl data using the cURL command-line tool. It makes a GET request to the API endpoint. You would typically append parameters like '?api_key=[API_KEY]&project=[PROJECT_HASH]' to the URL.

```bash
curl https://api.sistrix.com/project.onpage.crawl \

```

--------------------------------

### Fetch SERP Features using cURL command line

Source: https://www.sistrix.com/api/keyword/keyword-seo-serpfeatures

This example provides the basic cURL command to query the SISTRIX API for SERP features. It targets the specified URL and is intended to be extended with necessary parameters.

```bash
curl https://api.sistrix.com/keyword.seo.serpfeatures \

```

--------------------------------

### Get Domain Competitors SEM (Python Requests)

Source: https://www.sistrix.com/api/domain/domain-competitors-sem

This Python example uses the 'requests' library to query the SEM competitors API. It sends a POST request to the specified URL with an empty dictionary for parameters, implying default or pre-configured parameters. The response text is stored in the 'data' variable.

```python
import requests
baseUrl = 'https://api.sistrix.com/domain.competitors.sem'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

--------------------------------

### Fetch Project Resources (Node.js Fetch API)

Source: https://www.sistrix.com/api/project/project-onpage-resources

This Node.js example utilizes the Fetch API to get project resources. It sends a POST request to the API endpoint. The 'FormData' object is used, suggesting that parameters are intended to be sent in the request body, though it's currently empty. The response is processed as text.

```javascript
let baseUrl = 'https://api.sistrix.com/project.onpage.resources';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Fetch Project Overview using cURL

Source: https://www.sistrix.com/api/project/project-overview

This cURL command is used to make a request to the Sistrix API for project overview data. It hits the 'project.overview' endpoint. Additional parameters like API key and format can be appended to the URL or sent as data.

```bash
curl https://api.sistrix.com/project.overview \

```

--------------------------------

### Make POST Request to Project On-page Overview (Node.js)

Source: https://www.sistrix.com/api/project/project-onpage-overview

This Node.js example illustrates how to send a POST request to the project.onpage.overview endpoint using the Fetch API. It sets the base URL and uses FormData for the request body, then processes the response as text.

```javascript
let baseUrl = 'https://api.sistrix.com/project.onpage.overview';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Fetch Marketplace Visibility List (cURL)

Source: https://www.sistrix.com/api/marketplace/marketplace-visibility-list

This example provides the cURL command to interact with the `marketplace.visibility.list` API endpoint. It demonstrates how to specify the URL for the API request.

```bash
curl https://api.sistrix.com/marketplace.visibility.list \

```

--------------------------------

### Fetch Keyword SEO Metrics (Python)

Source: https://www.sistrix.com/api/keyword/keyword-seo-metrics

This example shows how to fetch keyword SEO metrics using Python's requests library. It outlines the base URL and the structure for sending POST data, allowing for the retrieval of keyword performance data.

```python
import requests
baseUrl = 'https://api.sistrix.com/keyword.seo.metrics'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

--------------------------------

### List Project Methods using PHP

Source: https://www.sistrix.com/api/project

This PHP code snippet demonstrates how to call the Sistrix API to retrieve a list of available project methods. It uses cURL to send a POST request with the necessary API key and format parameters.

```php
$baseUrl = "https://api.sistrix.com/project";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

--------------------------------

### Node.js Example for Domain Ranking Distribution API

Source: https://www.sistrix.com/api/domain/domain-ranking-distribution

This Node.js example utilizes the Fetch API to send a POST request to the domain.ranking.distribution API. It creates a FormData object (though not explicitly populated in this snippet) and handles the response as text.

```javascript
let baseUrl = 'https://api.sistrix.com/domain.ranking.distribution';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Make API Request using Node.js

Source: https://www.sistrix.com/api/ai

This Node.js example demonstrates how to make a POST request to the Sistrix AI API using the Fetch API. It sets the base URL, initializes a FormData object for the body, and processes the text response.

```javascript
let baseUrl = 'https://api.sistrix.com/ai';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Start On-Page Crawl with Node.js

Source: https://www.sistrix.com/api/project/project-start-onpage-check

Initiates an on-page crawl using Node.js and the Fetch API. Sends a POST request to the SISTRIX API endpoint. The response data is processed as text.

```javascript
let baseUrl = 'https://api.sistrix.com/project.start.onpage.check';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})

```

--------------------------------

### Start On-Page Crawl with Python

Source: https://www.sistrix.com/api/project/project-start-onpage-check

Initiates an on-page crawl using Python's requests library. Sends a POST request to the SISTRIX API endpoint. The response data is retrieved as text.

```python
import requests
baseUrl = 'https://api.sistrix.com/project.start.onpage.check'
post = {

}
response = requests.post(baseUrl, post)
data = response.text

```

--------------------------------

### Get AI Competitors List (cURL)

Source: https://www.sistrix.com/api/ai/ai-entity-competition

This is a basic cURL command to interact with the SISTRIX API for AI competitor data. It makes a GET request to the specified URL. You will need to append your 'api_key' and other required parameters to the URL.

```bash
curl https://api.sistrix.com/ai.entity.competition \

```

--------------------------------

### Make POST Request to Project On-page Overview (PHP)

Source: https://www.sistrix.com/api/project/project-onpage-overview

This snippet demonstrates how to make a POST request to the project.onpage.overview endpoint using PHP and cURL. It sets up the base URL and POST data, executes the request, and retrieves the response.

```php
$baseUrl = "https://api.sistrix.com/project.onpage.overview";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

--------------------------------

### Start On-Page Crawl with PHP

Source: https://www.sistrix.com/api/project/project-start-onpage-check

Initiates an on-page crawl using PHP and cURL. Sends a POST request to the SISTRIX API endpoint with the API key and desired format. The response is captured as text.

```php
$baseUrl = "https://api.sistrix.com/project.start.onpage.check";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);

```

--------------------------------

### Get Marketplace Keyword Traffic (JavaScript)

Source: https://www.sistrix.com/api/marketplace/marketplace-keyword-traffic

Shows how to get marketplace keyword traffic data using JavaScript's Fetch API. This method is suitable for front-end or Node.js applications. It requires an API key and can be extended with optional parameters.

```javascript
let baseUrl = 'https://api.sistrix.com/marketplace.keyword.traffic';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Fetch AI Prompt Answers using Python

Source: https://www.sistrix.com/api/ai/ai-prompt-answers

Shows how to request AI-generated answers from the Sistrix API using Python's requests library. This example initializes an empty POST body, which would typically include parameters like api_key and prompt.

```python
import requests
baseUrl = 'https://api.sistrix.com/ai.prompt.answers'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

--------------------------------

### Making a POST Request to Serpfeatures API

Source: https://www.sistrix.com/api/basic-functions/serpfeatures

This snippet shows how to make a POST request to the SISTRIX API's serpfeatures endpoint. It demonstrates how to set up the base URL and request body. Note: The provided Python example has an empty 'post' dictionary, which may lead to unexpected results; it should include parameters like 'api_key'.

```php
$baseUrl = "https://api.sistrix.com/serpfeatures";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

```python
import requests
baseUrl = 'https://api.sistrix.com/serpfeatures'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```

```curl
curl https://api.sistrix.com/serpfeatures \

```

```javascript
let baseUrl = 'https://api.sistrix.com/serpfeatures';
let form = new FormData();

fetch(baseUrl, {
    method: 'POST',
    body: form
}).then(function(response){
    return response.text();
}).then(function(data){
    //data contains the results of the request
})
```

--------------------------------

### Making a GET Request to Sistrix API (PHP)

Source: https://www.sistrix.com/api/links

This PHP code snippet demonstrates how to construct and execute a GET request to the Sistrix API using cURL. It includes setting the base URL and POST fields for authentication and format specification. Ensure you replace '[API_KEY]' with your actual API key.

```php
$baseUrl = "https://api.sistrix.com/links";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json"
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);
```

--------------------------------

### Project Start On-Page Check API

Source: https://www.sistrix.com/api/project

Initiates an on-page check for a project.

```APIDOC
## POST /api/v1/project/start.onpage.check

### Description
Triggers a new on-page analysis for the specified project. This action will start a crawl and analysis process.

### Method
POST

### Endpoint
/api/v1/project/start.onpage.check

### Parameters
#### Request Body
- **project_id** (string) - Required - The unique identifier for the project to perform the on-page check on.

### Request Example
```json
{
  "project_id": "your_project_id"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the on-page check has been initiated.

#### Response Example
```json
{
  "message": "On-page check initiated successfully for project your_project_id."
}
```
```

--------------------------------

### Fetch Link Targets via PHP

Source: https://www.sistrix.com/api/links/links-linktargets

This PHP code example shows how to fetch link target data from the SISTRIX API using cURL. It sets up the base URL and POST data, then executes the request and retrieves the response.

```php
$baseUrl = "https://api.sistrix.com/links.linktargets";
$post = [
    "api_key" => "[API_KEY]",
    "format" => "json",
    "address_object" => "example.com",
    "limit" => 10
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $baseUrl);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($curl);
curl_close($curl);

// Decode JSON response
$data = json_decode($response, true);
print_r($data);
```

--------------------------------

### GET /ai.top.sources

Source: https://www.sistrix.com/api/ai/ai-top-sources

Fetches the top AI-identified sources with various filtering and pagination options.

```APIDOC
## GET /ai.top.sources

### Description
Retrieves a list of top websites identified by AI analysis. The results include the website host, its ranking, the number of associated occurrences, and the visibility index, which indicates the source's relevance and prominence in AI-recognized content.

### Method
GET

### Endpoint
https://api.sistrix.com/ai.top.sources

### Parameters
#### Query Parameters
- **api_key** (STRING) - Required - Your personal API key for authentication.
- **model** (STRING) - Optional - Defines the AI model for which to execute the method. Defaults to all models if not specified.
- **lang** (STRING) - Optional - Defines the language for the results (e.g., 'de' for German). Defaults to the toolbox language if not specified.
- **limit** (INTEGER) - Optional - Specifies the number of results per page. Defaults to 100.
- **page** (INTEGER) - Optional - Specifies which page of results to return. Defaults to the first page.
- **format** (STRING) - Optional - Specifies the response format (JSON or XML). Defaults to XML.

### Request Example
```json
{
  "api_key": "[API_KEY]",
  "format": "json"
}
```

### Response
#### Success Response (200)
- **host** (STRING) - The hostname of the website.
- **ranking** (INTEGER) - The ranking of the website.
- **occurrences** (INTEGER) - The number of associated occurrences.
- **visibility_index** (FLOAT) - The visibility index reflecting relevance and prominence.

#### Response Example
```json
{
  "result": [
    {
      "host": "example.com",
      "ranking": 1,
      "occurrences": 1500,
      "visibility_index": 95.5
    },
    {
      "host": "anotherexample.net",
      "ranking": 2,
      "occurrences": 1200,
      "visibility_index": 92.1
    }
  ]
}
```
```

--------------------------------

### List Project Methods using cURL

Source: https://www.sistrix.com/api/project

This cURL command demonstrates how to directly interact with the Sistrix API to list project methods. It's a command-line approach suitable for scripting or quick testing.

```bash
curl https://api.sistrix.com/project \

```

--------------------------------

### Making a GET Request to Sistrix API (Python)

Source: https://www.sistrix.com/api/links

This Python code snippet shows how to make a GET request to the Sistrix API using the 'requests' library. It defines the base URL and an empty dictionary for POST data. The response is then captured as text. Remember to populate the 'post' dictionary with your API key and desired format.

```python
import requests
baseUrl = 'https://api.sistrix.com/links'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
```
Tokens:
Raw