Arsenkin Tools API

https://help.arsenkin.ru/api/
Admin
API documentation for Arsenkin Tools, a Russian SEO toolset offering endpoints for search ranking...
Tokens:26,761
Snippets:135
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Phrase Parsing API

Source: https://help.arsenkin.ru/api/api-wordstat/phrase-parsing

This section describes the parameters and provides an example for using the Phrase Parsing API.

```APIDOC
## POST /phrase-parsing

### Description
Parses phrases from Yandex Wordstat based on provided parameters.

### Method
POST

### Endpoint
/phrase-parsing

### Parameters
#### Request Body
- **tools_name** (string) - Required - The name of the tool, should be 'wordstat'.
- **data** (object) - Required - Contains the parameters for parsing.
  - **type** (integer) - Required - The type of check, 2 for phrase parsing.
  - **queries** (array of strings) - Required - List of phrases to check.
  - **regions** (integer) - Optional - The region ID for the search (e.g., 213 for Moscow, 225 for Russia).
  - **device** (string) - Optional - Device type for parsing (desktop, mobile, phone, tablet). Empty value for all devices.
  - **minus_words** (array of strings) - Optional - List of minus words.
  - **is_clear_minus** (boolean) - Optional - Whether to remove phrases with minus words from the result.
  - **is_right** (boolean) - Optional - Whether to collect the right column data.
  - **is_clear** (boolean) - Optional - Whether to remove '+' from key phrases.

### Request Example
```json
{
	"tools_name": "wordstat",
	"data": {
		"type": 2,
		"queries": [
			"ремонт киа",
			"ремонт киа",
			"сервис киа",
			"автосервис киа",
			"купить киа"
		],
		"device": "desktop",
		"region": 213,
		"minus_words": [
			"дилер"
		],
		"is_clear_minus": true,
		"is_right": true,
		"is_clear": true
	}
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (object) - Contains the parsed phrase data.
  - **queries** (array of objects) - List of parsed queries with their statistics.
    - **query** (string) - The parsed query.
    - **count** (integer) - The search count for the query.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "queries": [
      {
        "query": "ремонт киа",
        "count": 1500
      },
      {
        "query": "сервис киа",
        "count": 800
      }
    ]
  }
}
```
```

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

### JSON Example for PAA Tool API Request

Source: https://help.arsenkin.ru/api/paa-yandex-google

Use this JSON structure to send data to the 'People Also Ask' tool API. Ensure all required parameters are correctly populated.

```json
{
	"tools_name": "paa",
	"data": {
		"queries": [
			"купить киа"
		],
		"se": 2,
		"region": 1011969,
		"google_domain": "www.google.ru",
		"google_lang": "ru",
		"google_from": "RU",
		"depth": 1,
		"count": 10
	}
}
```

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

### Commerce Tool API Request Example

Source: https://help.arsenkin.ru/api/commerce-geo-loc

This JSON object demonstrates the structure for sending data to the 'commerce' tool API. Ensure all required parameters such as 'tools_name', 'queries', 'se', and 'region' are correctly formatted.

```json
{
  "tools_name": "commerce",
  "data": {
    "queries": [
      "продвижение сайта",
	  "продвижение сайта в москве"
    ],
    "se": 1,
    "region": 213
  }
}
```

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

### Example JSON for Clustering API Request

Source: https://help.arsenkin.ru/api/clustering-dev

This JSON object demonstrates the structure and required parameters for sending data to the clustering API. Ensure all fields match the specified requirements for successful processing.

```json
{
	"tools_name": "clustering",
	"data": {
		"queries": [
			"ремонт киа",
			"сервис киа",
			"автосервис киа"
		],
		"group": "soft",
		"count": 3,
		"main": true,
		"ws": [
			"base",
			"quoted",
			"overal",
			"exact"
		],
		"se": 1,
		"region": 213,
		"depth": 20,
		"stoplist": [
			"http://yandex.ru",
			"auto.ru"
		]
	}
}
```

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

### Google Search Suggestion API Request Example

Source: https://help.arsenkin.ru/api/suggest-yandex-google-youtube

Use this JSON structure to request search suggestions from Google. Ensure all required fields like queries, search engine (se=2), region, domain, language, country, check options, depth, and stoplist are correctly populated.

```json
{
	"tools_name": "suggest",
	"data": {
		"queries": [
			"купить киа"
		],
		"se": 2,
		"region": 1011969,
		"google_domain": "www.google.bg",
		"google_lang": "bg",
		"google_from": "BG",
		"check": [
			"nrm",
			"spc",
			"lat",
			"cyr",
			"dig",
			"loc",
			"sho",
			"quo",
			"otzyv"
		],
		"depth": 1,
		"stoplist": [
			"дилер",
			"бесплатно"
		]
	}
}
```

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

### Retrieve Task Result

Source: https://help.arsenkin.ru/api/api-ai-serp

Request body for fetching results via the /api/tools/get endpoint, followed by an example of the returned result structure.

```json
{
  "task_id": "3944"
}
```

```json
{
	"code": "TASK_RESULT",
	"task_id": 30307237,
	"result": {
		"result": {
			"position": 1,
			"found": 1,
			"brand": 1
		},
		"top": {
			"hosts": {
				"skillbox.ru": 2,
				"help.reg.ru": 2,
				"gb.ru": 2,
				"yandex.ru": 1,
				"www.kaspersky.ru": 1,
				"practicum.yandex.ru": 1,
				"yandex.cloud": 1,
				"www.nic.ru": 1,
				"ai.tochka.com": 1,
				"ru.wikipedia.org": 1,
				"360.yandex.by": 1,
				"selectel.ru": 1,
				"developer.mozilla.org": 1,
				"tilda.education": 1,
				"repetitor.1c.ru": 1,
				"hi-tech.mail.ru": 1,
				"www.securitylab.ru": 1
			},
			"urls": {
				"https:\/\/yandex.ru\/adv\/edu\/materials\/chto-takoe-domen-i-kak-zaregistrirovat": 1,
				"https:\/\/ai.tochka.com\/blog\/domen-chto-eto-kak-vyglyadit-kak-zaregistrirovat\/": 1,
				"https:\/\/skillbox.ru\/media\/code\/dns-chto-eto-takoe-i-kak-eye-ispolzuyut\/": 1,
				"https:\/\/www.kaspersky.ru\/resource-center\/definitions\/dns": 1,
				"https:\/\/practicum.yandex.ru\/blog\/dns-kak-rabotaet-server-i-kak-zashchitit-ot-atak\/": 1,
				"https:\/\/yandex.cloud\/ru\/blog\/dns-server": 1,
				"https:\/\/www.nic.ru\/help\/registraciya-domenov_7935.html": 1,
				"https:\/\/gb.ru\/blog\/kak-zaregistrirovat-domen\/": 1,
				"https:\/\/help.reg.ru\/support\/domains\/registratsiya-domena\/kak-zaregistrirovat-domen": 1,
				"https:\/\/gb.ru\/blog\/domenoe-imya\/": 1,
				"https:\/\/360.yandex.by\/blog\/business\/chto-takoe-domen-i-kak-ego-zaregistrirovat\/": 1,
				"https:\/\/skillbox.ru\/media\/marketing\/chto-takoe-domen-kakim-on-dolzhen-byt-i-kak-ego-zaregistrirovat\/": 1,
				"https:\/\/ru.wikipedia.org\/wiki\/%D0%94%D0%BE%D0%BC%D0%B5%D0%BD%D0%BD%D0%BE%D0%B5_%D0%B8%D0%BC%D1%8F": 1,
				"https:\/\/help.reg.ru\/support\/domains\/obshchaya-informatsiya-o-domenakh\/chto-takoye-domen-domennoye-imya": 1,
				"https:\/\/selectel.ru\/blog\/what-is-domain\/": 1,
				"https:\/\/developer.mozilla.org\/ru\/docs\/Learn_web_development\/Howto\/Web_mechanics\/What_is_a_domain_name": 1,
				"https:\/\/tilda.education\/domain": 1,
				"https:\/\/repetitor.1c.ru\/informatics\/domen\/": 1,
				"https:\/\/hi-tech.mail.ru\/review\/125842-domen\/": 1,
				"https:\/\/www.securitylab.ru\/blog\/personal\/SimlpeHacker\/357977.php": 1
			}
		},
		"queries": [
			"что такое домен"
		],
		"table": [
			{
				"found": true,
				"position": {
					"position": 15,
					"url": "https:\/\/www.nic.ru\/help\/registraciya-domenov_7935.html"
				},
				"brand": true
```

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

### Get Running Tasks

Source: https://help.arsenkin.ru/api

Retrieve a list of tasks that are currently being executed. This requires a POST request to the /tools/info endpoint with query set to 'status'.

```APIDOC
## Get Running Tasks

### Description
Retrieves a list of tasks that are currently in the "In Progress" state. Completed tasks cannot be retrieved via this method.

### Method
POST

### Endpoint
https://arsenkin.ru/api/tools/info

### Request Body
- **query** (string) - Required - Must be set to "status".

### Request Example
```json
{
  "query": "status"
}
```

### Response
#### Success Response (200)
- **tasks** (array) - A list of currently running tasks, each with a task ID and status.

#### Response Example
```json
{
  "tasks": [
    {
      "task_id": 28780004,
      "status": "processing"
    }
  ]
}
```
```

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

### Get Currently Running Tasks

Source: https://help.arsenkin.ru/api

Fetch a list of tasks that are currently in progress. This endpoint does not provide a list of completed tasks. Use a POST request with 'query': 'status'.

```text
https://arsenkin.ru/api/tools/info
```

```json
{
  "query": "status"
}
```

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

### JSON Example for Phrase Parsing API Request

Source: https://help.arsenkin.ru/api/api-wordstat/phrase-parsing

Use this JSON structure to send data to the phrase parsing API. Ensure all required fields are correctly populated according to the parameter descriptions.

```json
{
	"tools_name": "wordstat",
	"data": {
		"type": 2,
		"queries": [
			"ремонт киа",
			"ремонт киа",
			"сервис киа",
			"автосервис киа",
			"купить киа"
		],
		"device": "desktop",
		"region": 213,
		"minus_words": [
			"дилер"
		],
		"is_clear_minus": true,
		"is_right": true,
		"is_clear": true
	}
}
```

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

### Copywriters API: JSON Request with Structure Generation

Source: https://help.arsenkin.ru/api/api-copyrighters

This example shows how to enable AI-driven article structure generation by setting 'generate-structure' to true. Include a 'url' parameter to specify where the generated text will be placed.

```json
{
	"tools_name": "copyrighters",
	"data": {
		"foreign": false,
		"remove_main": true,
		"se": 1,
		"region": 213,
		"generate-structure": true,
		"url": "https://www.altika.ru/kia/",
		"queries": [
			"ремонт киа",
			"автосервис киа"
		]
	}
}
```

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

### Example JSON for WHOIS API Request

Source: https://help.arsenkin.ru/api/mass-whois

This JSON payload is used to send domain names to the WHOIS tool API for availability checks. Ensure 'tools_name' is set to 'whois' and 'queries' contains a list of up to 500 domains.

```json
{
	"tools_name": "whois",
	"data": {
		"queries": [
			"altika.ru",
			"https://arsenkin.ru"
		]
	}
}
```

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

### Get Account Limits

Source: https://help.arsenkin.ru/api

Retrieve information about account limits, including total limits and usage. This requires a POST request to the /tools/info endpoint with query set to 'limits'.

```APIDOC
## Get Account Limits

### Description
Retrieves information about the user's account limits, including total available limits and current usage.

### Method
POST

### Endpoint
https://arsenkin.ru/api/tools/info

### Request Body
- **query** (string) - Required - Must be set to "limits".

### Request Example
```json
{
  "query": "limits"
}
```

### Response
#### Success Response (200)
- **limits_total** (integer) - The total number of limits available on the account.
- **limits_used** (integer) - The number of limits currently used.

#### Response Example
```json
{
  "limits_total": 1000,
  "limits_used": 500
}
```
```

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

### Yandex Search Suggestion API Request Example

Source: https://help.arsenkin.ru/api/suggest-yandex-google-youtube

This JSON format is used for requesting search suggestions from Yandex. Key parameters include the tool name, queries, search engine (se=1), region, and various check options for suggestion types.

```json
{
	"tools_name": "suggest",
	"data": {
		"queries": [
			"купить киа"
		],
		"se": 1,
		"region": 213,
		"check": [
			"nrm",
			"spc",
			"lat",
			"cyr",
			"dig",
			"loc",
			"sho",
			"quo",
			"otzyv"
		],
		"depth": 1,
		"stoplist": [
			"дилер",
			"бесплатно"
		]
	}
}
```

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

### JSON Example for Yandex Ads Parsing API

Source: https://help.arsenkin.ru/api/parser-ads-yandex

Use this JSON structure to send data for parsing and analyzing Yandex ads. Ensure all required parameters like 'tools_name', 'queries', and 'regions' are included.

```json
{
	"tools_name": "parser-ads",
	"data": {
		"queries": [
			"ремонт киа"
		],
		"regions": [
			213,
			225
		],
		"hosts": [
			"https://altika.ru",
			"ozon.ru"
		],
		"device": "desktop"
	}
}
```

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

### Get Account Limits Information

Source: https://help.arsenkin.ru/api

Retrieve information about your account's total and used API limits. This is done by sending a POST request with a JSON body containing 'query': 'limits'.

```text
https://arsenkin.ru/api/tools/info
```

```json
{
  "query": "limits"
}
```

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

### Example API Response for Task Results

Source: https://help.arsenkin.ru/api/api-top

This JSON structure represents the results of a task check. It includes details about the original request and the collected data, such as search queries and URLs.

```json
{
  "code": "TASK_RESULT",
  "task_id": "28587454",
  "result": {
    "request": {
      "queries": [
        "ремонт киа",
        "ремонт kia"
      ],
      "depth": 10,
      "ss": [
        {
          "ss": 1,
          "region": 213
        },
        {
          "ss": 11,
          "region": 1011969
        }
      ],
      "is_deny": false,
      "is_snippet": true,
      "is_noreask": false
    },
    "result": {
      "collect": [
        [
          [
            "https://yandex.ru/maps/213/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B%20Kia/",
            "https://dream-avto.ru/remont-kia.html",
            "https://www.avito.ru/moskva/predlozheniya_uslug?q=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0",
            "https://www.avtogermes.ru/servis/kia/",
            "https://kia.union-motors.ru/",
            "https://www.kia.ru/service/booking/",
            "https://uslugi.yandex.ru/213-moscow/category?text=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0",
            "https://www.autoservice-korean.ru/",
            "https://favorit-motors.ru/technical-center/worklist/kia/",
            "https://oem-zap.su/marki-i-modeli/remont-kia/"
          ],
          [
            "https://www.kia-favorit.ru/technical-center/",
            "https://yandex.ru/maps/213/moscow/search/%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%20%D0%BA%D0%B8%D0%B0/",
            "https://www.tokyogarage.ru/kia/",
            "https://www.avtogermes.ru/servis/kia/",
            "https://www.evis-motors.ru/service/kia/",
            "https://хендай-ремонт.рф/",
            "https://www.kp.ru/russia/moskva/luchshie-avtoservisy-kia-v-moskve/",
            "https://dream-avto.ru/",
            "https://autopilot-korea.ru/servis-kia/",
            "https://www.uservice.ru/service/kia/"
          ]
        ],
        [
          [
            "https://dream-avto.ru/",
            "https://yandex.ru/maps/213/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B%20Kia/",
            "https://kia.union-motors.ru/",
            "https://www.avito.ru/moskva/predlozheniya_uslug?q=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0",
            "https://favorit-motors.ru/technical-center/worklist/kia/",
            "https://www.avtogermes.ru/servis/kia/",
            "https://www.kia.ru/service/booking/",
            "https://uslugi.yandex.ru/213-moscow/category?text=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+kia",
            "https://autospot.ru/autoservice/repairs/kia/",
            "https://service.irbis-kia.ru/"
          ],
          [
            "https://www.kia-favorit.ru/technical-center/",
            "https://www.avtogermes.ru/servis/kia/",
            "https://yandex.ru/maps/213/moscow/search/%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%20%D0%BA%D0%B8%D0%B0/",
            "https://www.tokyogarage.ru/kia/",
            "https://www.evis-motors.ru/service/kia/",
            "https://dream-avto.ru/",
            "https://autopilot-korea.ru/servis-kia/",
            "https://www.uservice.ru/service/kia/",
            "https://www.kp.ru/russia/moskva/luchshie-avtoservisy-kia-v-moskve/",
            "https://2gis.ru/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%20%D0%BA%D0%B8%D0%B0"
          ]
        ]
      ],
      "snippets": {
        "https://yandex.ru/maps/213/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B%20Kia/": [
          {
            "title": "Kia Москве Автосервисы в на карте рядом со... — Яндекс Карты",
            "snippet": "Автосервисы Kia в Москве, Яндекс Карты: телефоны, часы работы, фото, входы, отзывы, как проехать на транспорте или пройти пешком."
          }
        ],
        "https://dream-avto.ru/remont-kia.html": [
          {
            "title": "Ремонт киа Москве киа в , а также сервис , всегда отличное...",
            "snippet": "Клубный сервис Киа в Москве работает с клиентами в следующем порядке: Автовладелец приезжает на станцию и передает машину менеджеру для предварительного осмотра и ремонт киа. Специалисты технического центра производят диагностику неисправностей систем и механизмов, и готовит предложения по их устранению."
          }
        ],
        "https://www.avito.ru/moskva/predlozheniya_uslug?q=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0": [
          {
            "title": "ремонт киа Москве в - цены и отзывы | Услуги на Авито",
            "snippet": ""
          }
        ]
      }
    }
  }
}
```

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

### Example JSON for sending seasonality data

Source: https://help.arsenkin.ru/api/api-wordstat/dynamics

This JSON structure is used to send requests for seasonality data. Ensure all required fields are populated correctly, and refer to the parameter descriptions for valid values and constraints.

```json
{
	"tools_name": "wordstat",
	"data": {
		"type": 3,
		"queries": [
			"ремонт киа",
			"ремонт киа",
			"сервис киа",
			"автосервис киа",
			"купить киа"
		],
		"device": "",
		"region": 213,
		"group": "day",
		"startdate": "2018-01-01",
		"enddate": "2025-03-31"
	}
}
```

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

### Semantics API Request JSON Example

Source: https://help.arsenkin.ru/api/semantics-url-domain

This JSON structure is used to send data to the Semantics API for keyword research. It includes various parameters to define the search mode, queries, region, and filtering options.

```json
{
	"tools_name": "semantics",
	"data": {
		"mode": "domain",
		"queries": [
			"altika.ru"
		],
		"region": "msk",
		"stopwords": [
			"киа"
		],
		"competitors_intersection": false,
		"competitors_intersection_val": 1,
		"queries_top": true,
		"queries_top_val_from": 1,
		"queries_top_val_till": 10,
		"remove_ws": true,
		"remove_ws_val": 10,
		"remove_ws2": true,
		"remove_ws2_val": 5,
		"remove_small": true,
		"remove_small_val": 5,
		"delete_porno": true,
		"delete_toponim": true,
		"delete_query": true,
		"only_toponim": true,
		"delete_doubles": true
	}
}
```

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

### Get Result

Source: https://help.arsenkin.ru/api/api-top

Retrieve the results of a task by sending a GET request to the specified URL with the task ID.

```APIDOC
## GET /api/tools/get

### Description
Retrieves the results of a task using its ID.

### Method
GET

### Endpoint
https://arsenkin.ru/api/tools/get

### Parameters
#### Query Parameters
- **task_id** (string) - Required - The ID of the task to retrieve results for.

### Request Example
```
GET /api/tools/get?task_id=abc12345
```

### Response
#### Success Response (200)
Returns a JSON object containing the task results.

### Response Example
```json
{
  "code": "TASK_RESULT",
  "task_id": "28587454",
  "result": {
    "request": {
      "queries": [
        "ремонт киа",
        "ремонт kia"
      ],
      "depth": 10,
      "ss": [
        {
          "ss": 1,
          "region": 213
        },
        {
          "ss": 11,
          "region": 1011969
        }
      ],
      "is_deny": false,
      "is_snippet": true,
      "is_noreask": false
    },
    "result": {
      "collect": [
        [
          [
            "https://yandex.ru/maps/213/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B%20Kia/",
            "https://dream-avto.ru/remont-kia.html",
            "https://www.avito.ru/moskva/predlozheniya_uslug?q=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0",
            "https://www.avtogermes.ru/servis/kia/",
            "https://kia.union-motors.ru/",
            "https://www.kia.ru/service/booking/",
            "https://uslugi.yandex.ru/213-moscow/category?text=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0",
            "https://www.autoservice-korean.ru/",
            "https://favorit-motors.ru/technical-center/worklist/kia/",
            "https://oem-zap.su/marki-i-modeli/remont-kia/"
          ],
          [
            "https://www.kia-favorit.ru/technical-center/",
            "https://yandex.ru/maps/213/moscow/search/%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%20%D0%BA%D0%B8%D0%B0/",
            "https://www.tokyogarage.ru/kia/",
            "https://www.avtogermes.ru/servis/kia/",
            "https://www.evis-motors.ru/service/kia/",
            "https://хендай-ремонт.рф/",
            "https://www.kp.ru/russia/moskva/luchshie-avtoservisy-kia-v-moskve/",
            "https://dream-avto.ru/",
            "https://autopilot-korea.ru/servis-kia/",
            "https://www.uservice.ru/service/kia/"
          ]
        ],
        [
          [
            "https://dream-avto.ru/",
            "https://yandex.ru/maps/213/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B%20Kia/",
            "https://kia.union-motors.ru/",
            "https://www.avito.ru/moskva/predlozheniya_uslug?q=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0",
            "https://favorit-motors.ru/technical-center/worklist/kia/",
            "https://www.avtogermes.ru/servis/kia/",
            "https://www.kia.ru/service/booking/",
            "https://uslugi.yandex.ru/213-moscow/category?text=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+kia",
            "https://autospot.ru/autoservice/repairs/kia/",
            "https://service.irbis-kia.ru/"
          ],
          [
            "https://www.kia-favorit.ru/technical-center/",
            "https://www.avtogermes.ru/servis/kia/",
            "https://yandex.ru/maps/213/moscow/search/%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%20%D0%BA%D0%B8%D0%B0/",
            "https://www.tokyogarage.ru/kia/",
            "https://www.evis-motors.ru/service/kia/",
            "https://dream-avto.ru/",
            "https://autopilot-korea.ru/servis-kia/",
            "https://www.uservice.ru/service/kia/",
            "https://www.kp.ru/russia/moskva/luchshie-avtoservisy-kia-v-moskve/",
            "https://2gis.ru/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%20%D0%BA%D0%B8%D0%B0"
          ]
        ]
      ],
      "snippets": {
        "https://yandex.ru/maps/213/moscow/search/%D0%90%D0%B2%D1%82%D0%BE%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B%20Kia/": [
          {
            "title": "Kia Москве Автосервисы в на карте рядом со... — Яндекс Карты",
            "snippet": "Автосервисы Kia в Москве, Яндекс Карты: телефоны, часы работы, фото, входы, отзывы, как проехать на транспорте или пройти пешком."
          }
        ],
        "https://dream-avto.ru/remont-kia.html": [
          {
            "title": "Ремонт киа Москве киа в , а также сервис , всегда отличное...",
            "snippet": "Клубный сервис Киа в Москве работает с клиентами в следующем порядке: Автовладелец приезжает на станцию и передает машину менеджеру для предварительного осмотра и ремонт киа. Специалисты технического центра производят диагностику неисправностей систем и механизмов, и готовит предложения по их устранению."
          }
        ],
        "https://www.avito.ru/moskva/predlozheniya_uslug?q=%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82+%D0%BA%D0%B8%D0%B0": [
          {
            "title": "ремонт киа Москве в - цены и отзывы | Услуги на Авито",
            "snippet": "На Авито можно найти ремонт киа в Москве по доступной цене. Сравните предложения от разных мастеров и выберите лучшее."
          }
        ]
      }
    }
  }
}
```
```

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

### Get Task Result

Source: https://help.arsenkin.ru/api

Retrieve the result of a completed task. This requires a POST request to the /tools/get endpoint.

```APIDOC
## Get Task Result

### Description
Retrieves the result of a task that has been completed. This endpoint is used to fetch the output of a processed task.

### Method
POST

### Endpoint
https://arsenkin.ru/api/tools/get

### Request Body
- **task_id** (integer) - Required - The ID of the task whose result is to be retrieved.

### Request Example
```json
{
  "task_id": 12345678
}
```

### Response
#### Success Response (200)
- **result** (object) - The result data of the completed task.

#### Response Example
```json
{
  "result": {
    "data": "task output"
  }
}
```
```

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

### ТЗ на копирайтинг API

Source: https://help.arsenkin.ru/api/api-copyrighters

This section details the parameters required for the 'ТЗ на копирайтинг' tool. It includes mandatory parameters like tool name, queries, search engine, and region, as well as optional parameters for competitor URLs, stop words, and more.

```APIDOC
## API ТЗ на копирайтинг 

### Description
This API endpoint is used to generate technical specifications for copywriting tasks. It requires specific parameters to define the scope of the analysis, including search queries, target region, and optionally, competitor data.

### Parameters

- **tools_name** (string) - Required - The name of the tool, which must be "copyrighters".
- **queries** (array of strings) - Required - A list of search queries for which results need to be collected.
- **se** (integer) - Required - The search engine to use: 1 for Yandex, 2 for Google.
- **region** (integer) - Required - The region ID for the search. For Google, use specific region IDs (e.g., 1011969 for Moscow). For Yandex, use its region ID (e.g., 213 for Moscow).
- **urls** (array of strings) - Optional - A list of competitor URLs to include in the analysis.
- **stoplist** (array of strings) - Optional - A list of stop domains to exclude from the analysis.
- **stopwords** (array of strings) - Optional - A list of stop words to exclude from the analysis and the generated ТЗ.
- **url** (string) - Optional - The URL where the generated text will be placed. This is automatically included in the ТЗ.
- **foreign** (boolean) - Optional - Set to `true` to collect data using foreign IP addresses; defaults to `false`.
- **remove_main** (boolean) - Optional - Set to `true` to exclude main pages from the analysis; defaults to `false`.
- **generate-structure** (boolean) - Optional - Set to `true` to generate an article structure using AI; defaults to `false`.

### Request Example 1
```json
{
	"tools_name": "copyrighters",
	"data": {
		"foreign": false,
		"remove_main": true,
		"se": 1,
		"region": 213,
		"urls": [
			"https://kia-atlantm.by/service-and-parts/service/remont-kia/",
			"https://kia-service.by/remont-avtomobiley-kia",
			"https://avtoverdikt.by/brands/remont-kia/"
		],
		"stopwords": [
			"дилер"
		],
		"stoplist": [
			"yandex.ru"
		],
		"queries": [
			"ремонт киа",
			"автосервис киа"
		]
	}
}
```

### Request Example 2
```json
{
	"tools_name": "copyrighters",
	"data": {
		"foreign": false,
		"remove_main": true,
		"se": 1,
		"region": 213,
		"generate-structure": true,
		"url": "https://www.altika.ru/kia/",
		"queries": [
			"ремонт киа",
			"автосервис киа"
		]
	}
}
```
```

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

### Get Task Result API Endpoint

Source: https://help.arsenkin.ru/api

Retrieve the results of a completed task using this POST endpoint. The API returns data in JSON format.

```text
https://arsenkin.ru/api/tools/get
```

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

### POST /api/tools/ai-serp

Source: https://help.arsenkin.ru/api/api-ai-serp

Submits a new task for AI-SERP analysis.

```APIDOC
## POST /api/tools/ai-serp

### Description
Submits a new task for AI-SERP analysis by providing search queries and configuration parameters.

### Method
POST

### Request Body
- **tools_name** (string) - Required - Must be "ai-serp"
- **data** (object) - Required - Contains the analysis configuration

### Response
#### Success Response (200)
- **task_id** (integer) - The ID of the created task

### Response Example
{
  "task_id": 3944
}
```

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

### Submit AI-SERP Request

Source: https://help.arsenkin.ru/api/api-ai-serp

JSON structure for initiating a new SERP analysis task.

```json
{
  "tools_name": "ai-serp",
  "data": {
    "queries": [
      "что такое домен"
    ],
    "se": 1,
    "region": 213,
    "host": "nic.ru",
    "subdomain": false,
    "brands": [
      "ICANN"
    ]
  }
}
```

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

### JSON Request for Highlight Parsing

Source: https://help.arsenkin.ru/api/api-sp

Use this JSON structure to send data to the 'Highlight Parsing' tool. Ensure all required parameters like 'tools_name', 'queries', 'se', 'region', and 'depth' are correctly specified.

```json
{
  "tools_name": "sp",
  "data": {
    "queries": [
      "продвижение сайта"
    ],
    "se": 1,
    "region": 213,
    "depth": 50
  }
}
```

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

### Send Data for URL Check

Source: https://help.arsenkin.ru/api/api-check-h

Use this JSON structure to send a URL for checking its meta tags and headers. Specify the tool name, mode as 'url', the URL in 'queries', and optionally 'pause' and 'foreign' parameters.

```json
{
	"tools_name": "check-h",
	"data": {
		"pause": 5,
		"foreign": false,
		"mode": "url",
		"queries": [
			"https://www.altika.ru/kia/"
		]
	}
}
```

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

### Send Data for Keyword Check

Source: https://help.arsenkin.ru/api/api-check-h

Use this JSON structure to send a keyword for checking its associated meta tags and headers. Specify the tool name, mode as 'key', the keyword in 'queries', search engine, region, and desired depth.

```json
{
	"tools_name": "check-h",
	"data": {
		"pause": 1,
		"foreign": false,
		"mode": "key",
		"queries": [
			"ремонт киа"
		],
		"se": 1,
		"region": 213,
		"depth": 20
	}
}
```

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

### Парсинг подсветок Яндекс и Google

Source: https://help.arsenkin.ru/api/api-sp

Этот метод API позволяет получить подсветки и LSI для заданных ключевых фраз в Яндекс или Google.

```APIDOC
## API - Парсинг подсветок Яндекс и Google

### Description
API для инструмента «Парсинг подсветок» Яндекс и Google.

### Method
POST

### Endpoint
/api/v1/parsing/highlights

### Parameters
#### Query Parameters
- **tools_name** (string) - Required - Название инструмента. Должно быть "sp".
- **queries** (array of strings) - Required - Список ключевых фраз.
- **se** (integer) - Required - Поисковая система: 1 для Яндекс, 2 для Google.
- **region** (integer) - Required - Регион поиска (ID региона).
- **depth** (integer) - Optional - Глубина проверки. Доступные значения: 10, 20, 50. По умолчанию: 50.

### Request Example
```json
{
  "tools_name": "sp",
  "data": {
    "queries": [
      "продвижение сайта"
    ],
    "se": 1,
    "region": 213,
    "depth": 50
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Статус выполнения запроса.
- **data** (object) - Результаты парсинга.
  - **query** (string) - Ключевая фраза.
  - **highlights** (array of strings) - Список подсветок.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "query": "продвижение сайта",
      "highlights": [
        "SEO-продвижение сайтов",
        "продвижение сайтов в топ"
      ]
    }
  ]
}
```
```

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

### Send List of URLs for IKS Check

Source: https://help.arsenkin.ru/api/iks-yandex

This JSON format is used to submit a list of URLs for IKS parameter checking. The 'mode' should be set to 'url' and 'queries' should contain the domain names.

```json
{
	"tools_name": "iks",
	"data": {
		"mode": "url",
		"queries": [
			"altika.ru",
			"ozon.ru"
		]
	}
}
```
Tokens:
Raw