---
title: "Seobility API Documentation"
url: "https://help.seobility.net/en/article/seobility-api-documentation"
language: "en"
last_updated: "2026-09-30T14:09:27.705Z"
---

# Seobility API Documentation

The Seobility SEO API gives you programmatic access to our crawling and SEO analysis technology via a simple RESTful JSON service.

## 1\. Introduction

### 1.1 Overview

The Seobility SEO API provides access to the Seobility SEO software technology for crawling and SEO analysis of websites. It gives valuable insight into site health and search engine optimization, as well as easy troubleshooting for an entire website.

For easy integration of the technology into your individual environment, the API is built as RESTful service and provides JSON-format data.

### 1.2 Single Page Check API

The Single Page Check is another part of the SEO API. It provides the SEO Check and the Keyword Check as both consider only one specific URL for the performed analysis. Use this part of the API either to complement the Site Audit API, or to perform (isolated) single page analyses.

### 1.3 API credit system

The cost is documented accordingly for each method.

Credit packages are available on a monthly basis. For more information and a price quote based on your individual needs, [please contact us here](https://www.seobility.net/en/seo-api/#contact).

### 1.4 Support

The support for the API is available in English and German.

For questions about the Seobility SEO API or if you would like to receive a price quote based on your individual needs, [please contact us here](https://www.seobility.net/en/seo-api/#contact).

## 2\. Site Audit API

*Replaced by new API, please contact our support team.*

## 3\. Single Page Check API

### 3.1 SEO Check

**seocheck** - *Crawls an URL and returns a broad set of information about the SEO optimization of this page. Please note that the URL is being crawled live, so the response time will vary.*

Credits: 100  

**Example Call:**

**`GET`** `https://api.seobility.net/en/resellerapi/seocheck?apikey={yourapikey}&url=https://www.wikipedia.org/`

  

**Request Parameters:**

| Field | Type | Mandatory | Explanation |
| --- | --- | --- | --- |
| url | string | yes | Target URL |

**Response Parameters (JSON):**

<table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Field</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Explanation</span></p></th></tr><tr><td style="width: 165px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">-</span></p></td><td style="width: 82.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="width: 577.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">All onsite information:</span></p><table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Parameter</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Description</span></p></th></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">score</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The SEO score i.e. the overall optimization percentage of the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">analysedurl</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The URL that has been analyzed during the SEO check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">thumbnailurl</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The URL to a thumbnail of the analyzed URL's domain (homepage)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">quickfacts</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">General information about the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">loadtime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">float</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The load time in seconds</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">filesize</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">float</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The page size in kB</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">words</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The word count</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">mediafiles</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The number of media files on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">internallinks</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The number of internal links on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">externallinks</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The number of external links on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">medialist</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of the media elements found on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">images</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">An array of the images</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">src</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The image's path</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">alt</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The alt value of the image</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">title</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The title of the image</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">videos</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">An array of the videos</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">src</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The video's path</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">width</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The width of the video</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">height</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The height of the video</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">alt</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The alt value of the video</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">audio</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">An array of the audio files</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">src</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The audio file's path</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">alt</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The alt value of the audio file</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">linklist</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of the page's links</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">link</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The link's URL</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">target_blank</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether it's a link with the target blank</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">nofollow</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether it's a nofollow link</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">internal</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether it's an internal link</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">subdomain</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the link leads to a subdomain of the website</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">anchor</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The link's anchor text</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">anchortype</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The link's anchor type</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">isanchorlink</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the link is an anchor link or not</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">groupresults</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A result list of the analysis categories</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">meta</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The results for the analysis category "meta"</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">score</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The score (percentage) achieved in this category</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">points</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The amount of points that has been achieved in this category</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">maxpoints</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The maximum amount of points that can be achieved in this category</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">hints</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of hints for improving the page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The hint text</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">priority</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The priority i.e. the importance of the hint</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keywords</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of keywords found on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keyword</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The keyword</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">score</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Optimization score for the keyword on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">robots</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The website's full robots.txt file</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">httptags</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of the HTTP response headers received from the server</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">type</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The name of the HTTP header</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">value</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The value of the HTTP header</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">metatags</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of all meta tags defined on the analyzed page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">name</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The name of the meta tag</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">value</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The value of the meta tag</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">headingstructure</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of the headers on the analyzed page (h1, h2, ...)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">headinglevel</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The level of the header (h1, h2, h3)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">content</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The content of the header</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">duplicate</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the header is a duplicate</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">empty</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the header is empty</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">factors</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list that contains all factors analyzed</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">meta</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A factor category that contains all factors belonging to this category</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">title_content</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The technical name of the factor</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">factorname</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The localized factor name</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">score</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The score achieved in this factor (percentage)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">impact</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The impact this factor has i.e. its importance</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">messages</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">A list of messages regarding this factor</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The localized message</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text_label</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The label of the message</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">priority</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The priority of the message (0-3)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr></tbody></table></td></tr></tbody></table>

  

### 3.2 Keyword Check

**keywordcheck** - *Crawls an URL and returns information about how well the site is optimized for the specified keyword. Please note that the URL is being crawled live, so the response time will vary.*

Credits: 20

  

**Example Call:**

**`GET`** `https://api.seobility.net/en/resellerapi/keywordcheck?apikey={yourapikey}&url=https://www.wikipedia.org/&keyword=wiki`

  

**Request Parameters:**

| Field | Type | Mandatory | Explanation |
| --- | --- | --- | --- |
| url | string | yes | Target URL |
| keyword | string | yes | Keyword that should be checked |

**Response Parameters (JSON):**

| Field | Type | Explanation |
| --- | --- | --- |
| \- | array | All information on the keyword optimization of the page |

  

## 4\. TF\*IDF Check API

### 4.1 TF\*IDF Check

**tfidfcheck** - *Performs a TF\*IDF check for a given keyword. Several parameters allow individual and localized analysis settings. Returns the complete TF\*IDF analysis data and an initial set of term suggestions. Please note that an initial tfidfcheck request will take a moment, as the analysis requires live data from several sources. Consecutive refreshes of an analysis with unchanged parameters will be without delay.*

Credits: 175  

**Example Call:**

**`GET`** `https://api.seobility.net/en/resellerapi/tfidfcheck?apikey={yourapikey}&keyword=example&searchengine=google.com`

  

**Request Parameters:**

| Field | Type | Mandatory | Explanation |
| --- | --- | --- | --- |
| keyword | string | yes | The target keyword |
| searchengine | string | yes | The target searchengine (e.g. Google.com, Google.de, Google.com.pk etc.) |
| platform | int | no | The target platform (1=desktop, 2=mobile; default=1) |
| city | string | no | The name of the location for the query (requires lat and lon) |
| lat | float | no | The latitude of the location for the query (requires city and lon) |
| lon | float | no | The longitude of the location for the query (requires city and lat) |
| logbase | float | no | The logarithmic base for the calculation of the TF\*IDF scoring (default = 1.05185); only change if you know what you are doing |
| resultamount | int | no | The amount of top SERP results parsed to the TF\*IDF check (default=10, Possible: 3, 7, 10, 15 or 20) |
| url | string | no | The URL with the text to be optimized (use either url, text or textlength) |
| text | string | no | Text to be optimized (use either url, text or textlength) |
| textlength | int | no | Number of words of the target text (use either url, text or textlength) |
| textmode | string | no | Textparsingmode. Use "singleword" for only single-word keywords (default) or "multiword" for multi-word keyword support. |

**Response Parameters (JSON):**

<table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Field</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Explanation</span></p></th></tr><tr><td style="width: 165px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">-</span></p></td><td style="width: 82.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="width: 577.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Response Array</span></p><table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Parameter</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Description</span></p></th></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">success</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the request was successful</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">request</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The provided request information</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keyword</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The keyword provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">searchengine</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The searchengine provided in the request (e.g. Google.com, Google.de, Google.com.pk etc.)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">platform</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The target platform provided in the request (1=desktop, 2=mobile)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">lat</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The latitude of the location provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">lon</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The longitude of the location provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">city</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The name of the location provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">logbase</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The logarithmic base used for this calculation of the TF*IDF scoring</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">resultamount</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The amount of top SERP results parsed for this TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">url</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The given URL used as comparison basis for TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The text given for calculation basis for this TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">textlength</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The textlength given for calculation basis for this TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">calltime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">datetime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Time of this request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">stats</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Relevant Keywords and their statistical data</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Index</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Index of the stat</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keyword</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Keyword for the corresponding values attached</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">avgtfidfused</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Average TF*IDF value for all results containing this term</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">avgtfidftotal</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Average TF*IDF value for all results</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">occurrence</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The number of occurrences</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">maxtfidf</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Max TF*IDF value for this term</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">maxtf</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Max TF value for this term</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">results</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The results for the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Index</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Index of the result</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">link</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Result URL as given by Google SERP</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">title</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">SERP title</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">description</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">SERP title description</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">rank</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Rank in the SERP (1-100)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">domain</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Result Domain</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">tfidf</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">List of keywords with corresponding TF*IDF of this result</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keyword</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The keyword and its corresponding TF*IDF value</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">loadtime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The time it took to load the result</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">wordcount</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The amount of words in the results HTML</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">crawlerror</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Errors occurred while crawling</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">termsuggestions</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Term suggestions</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">more</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Words that should be used more</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">less</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Words that should be used less</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">suggestedamount</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Suggested optimal frequency/range of this keyword in the text, given the current text length.</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">ok</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Perfectly optimized words</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The text on the page. (only relevant if URL was a part of the request)</span></p></td></tr></tbody></table></td></tr></tbody></table>

  

## 5\. Term Suggestion API

### 5.1 TF\*IDF Term Suggestion

**termsuggestion** - *Provides term suggestions to optimize a text for a given keyword, e.g. in a text editor. The underlying analysis is based on TF\*IDF. Several parameters allow individual and localized analysis settings. Please note that an initial termsuggestion request might take a moment, as the analysis requires live data from several sources. Consecutive refreshes of an analysis with unchanged parameters will be without delay.*

Credits: 20  

**Example Call:**

**`GET`** `https://api.seobility.net/en/resellerapi/termsuggestion?apikey={yourapikey}&keyword=example&url=https://example.com&searchengine=google.com`

  

**Request Parameters:**

| Field | Type | Mandatory | Explanation |
| --- | --- | --- | --- |
| keyword | string | yes | The target keyword |
| searchengine | string | yes | The target searchengine (e.g. Google.com, Google.de, Google.com.pk etc.) |
| platform | int | no | The target platform (1=desktop, 2=mobile; default=1) |
| city | string | no | The name of the location for the query (requires lat and lon) |
| lat | float | no | The latitude of the location for the query (requires city and lon) |
| lon | float | no | The longitude of the location for the query (requires city and lat) |
| logbase | float | no | The logarithmic base for the calculation of the TF\*IDF scoring (default = 1.05185); only change if you know what you are doing |
| resultamount | int | no | The amount of top SERP results parsed to the TF\*IDF check (default=10, Possible: 3, 7, 10, 15 or 20) |
| url | string | yes | The URL with the text to be optimized (use either url or text) |
| text | string | yes | Text to be optimized (use either url or text) |

**Response Parameters (JSON):**

<table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Field</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Explanation</span></p></th></tr><tr><td style="width: 165px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">-</span></p></td><td style="width: 82.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="width: 577.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Response Array</span></p><table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Parameter</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Description</span></p></th></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">success</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the request was successful</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">request</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The provided request information</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keyword</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The keyword provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">searchengine</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The searchengine provided in the request (e.g. Google.com, Google.de, Google.com.pk etc.)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">platform</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The target platform provided in the request (1=desktop, 2=mobile)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">lat</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The latitude of the location provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">lon</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The longitude of the location provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">city</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The name of the location provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">logbase</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The logarithmic base used for this calculation of the TF*IDF scoring</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">resultamount</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The amount of top SERP results parsed for this TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">url</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The given URL used as comparison basis for TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The text given for calculation basis for this TF*IDF check</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">calltime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">datetime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Time of this request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">termsuggestions</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Term suggestions</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">more</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Words that should be used more</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">less</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Words that should be used less</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">ok</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Perfectly optimized words</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">text</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The text on the page. (only relevant if URL was a part of the request)</span></p></td></tr></tbody></table></td></tr></tbody></table>

  

## 6\. Ranking API

### 6.1 Ranking (Real Time)

**ranking** - *Returns the SERP Rankings (SERP = Search Engine Result Pages) for a given search term or keyword.*  
  
*This is a synchronous (direct) API. The average response time is 30 seconds.*

Credits: 3  

**Example Call:**

**`GET`** `https://api.seobility.net/en/resellerapi/ranking?apikey={yourapikey}&keyword=example&searchengine=google.com`

  

**Request Parameters:**

| Field | Type | Mandatory | Explanation |
| --- | --- | --- | --- |
| keyword | string | yes | The target keyword |
| searchengine | string | yes | The target searchengine domain (i.e. Google.com or Google.co.uk) |
| platform | int | no | Target Platform (1=Desktop, 2=Mobile) (Default Desktop) |
| city | string | no | Name of the location for query (requires city, lat and lon) |
| lat | float | no | Latitude of the query (requires city, lat and lon) |
| lon | float | no | Longitude of the query (requires city, lat and lon) |
| url | string | no | URL which position is to be determined |

**Response Parameters (JSON):**

<table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Field</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="vertical-align: bottom; width: 75px; text-align: start; background-color: rgb(242, 243, 245);" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Explanation</span></p></th></tr><tr><td style="width: 165px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">-</span></p></td><td style="width: 82.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="width: 577.5px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Response Array</span></p><table class="LexTKB__table"><colgroup><col><col><col></colgroup><tbody><tr><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Parameter</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Type</span></p></th><th style="background-color: rgb(240, 240, 240); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell LexTKB__tableCellHeader"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Description</span></p></th></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">success</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">boolean</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Whether the request was successful</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">request</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">object</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The provided request information</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">keyword</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The keyword provided in the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">searchengine</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The searchengine provided in the request (e.g. Google.com, Google.de, Google.com.pk etc.)</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">platform</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The type of device i.e. MOBILE</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">lat</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Latitude for Google Maps</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">lon</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Longitude for Google Maps</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">city</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">City for Google Maps localisation</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">targeturl</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">URL given as target for the results</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">calltime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">datetime</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Time of TF*IDF analysis</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">targeturlresult</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">results of the target URL; only provided if target URL is within the top SERPS</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">rank</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The ranking of the target url</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">link</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Link to the target url</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">description</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The meta description of the target url</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">title</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The title of the target url</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">results</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">array</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The results for the request</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">rank</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">int</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The ranking of the page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">link</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">Link to the page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">description</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The meta description of the page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">title</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The title of the page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">domain</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">string</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph" dir="ltr"><span style="white-space: pre-wrap;">The domain of the page</span></p></td></tr><tr><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"><p class="LexTKB__paragraph"><span style="white-space: pre-wrap;">(...)</span></p></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td><td style="background-color: rgb(255, 255, 255); width: 75px; vertical-align: top; text-align: start;" class="LexTKB__tableCell"></td></tr></tbody></table></td></tr></tbody></table>

  

## 7\. Error handling

If an error occurred, or if you made an invalid request, the API will return an error message.  
  
The returned JSON will be structured like this:

```
{
	"error" : "{errormessage}"
}
```
