Поиск

Документация по API сервиса

Документация по API сервиса «Пиксель Тулс» поможет разработчикам и пользователям получать данные от инструментов для собственных разработок в удобном формате.

В левом меню содержится список поддерживаемых методов API, примеры GET и POST-запросов и принятые форматы ответов в формате JSON.

API поддерживается только для пользователей на платных тарифах (PRO-тарифы). В случае возникновения трудностей, вы можете задать вопрос в службу поддержи.

Для формирования запросов требуется использовать свой ключ доступа к API, который вы можете сгенерировать в настройках аккаунта.

Пример использования API

1. Постановка задачи

Пример задачи: собрать основные параметры для запроса [купить iphone] по региону Москва.

Код на PHP с использованием CURL:

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://tools.pixelplus.ru/api/complex_queries_analyser?key={ключ-api}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('requests' => 'купить iphone','search_system' => '1','lr' => '213','deep' => '25','geo' => '1','intent' => '1','site_type' => '1'),
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;

?>

Ответ:

{
    "report_id": "2617068"
}

2. Получение результата

Код на PHP с использованием CURL:

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://tools.pixelplus.ru/api/complex_queries_analyser?key={ключ-api}&report_id={id-задачи}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
));

$response = curl_exec($curl);

curl_close($curl);

echo $response;

?>

Ответ:

{
    "status": "success",
    "msg": "completed",
    "time": "1621535800",
    "cost": 1,
    "request": {
        "requests": [
            "купить iphone"
        ],
        "search_system": "1",
        "lr": 213,
        "deep": 25,
        "geo": "1",
        "intent": "1",
        "site-type": "1",
        "exceptions_words": [],
        "gruppirovka_method": 3,
        "gruppirovka_user_grouping_pow": 3,
        "user_id": "99855",
        "requests_filtered": []
    },
    "response": {
        "response": {
            "result": [
                {
                    "geo": true,
                    "local_pow": 28,
                    "vital": false,
                    "thematic_words": [
                        "apple",
                        "цена",
                        "смартфон"
                        "магазин",
                        "интернет",
                    ],
                    "com": 72,
                    "rev": 20,
                    "media": 8,
                    "lex": 0,
                    "music": 0,
                    "trav": 0,
                    "competition": null,
                    "classified": {
                        "1": 20,
                        "2": 0,
                        "3": 56,
                        "4": 0,
                        "5": 0,
                        "6": 0,
                        "7": 0,
                        "8": 0,
                        "9": 4,
                        "10": 4,
                        "11": 0,
                        "12": 0,
                        "13": 0,
                        "14": 0,
                        "9999": 16
                    },
                    "morda_count": null,
                    "rel_url": null,
                    "site_pos": null,
                    "group": null,
                    "top_url": null,
                    "generated_url": null,
                    "ws_exact": null,
                    "ws_overall": null,
                    "query": "купить iphone"
                }
            ],
            "dictionary": {
                "classified": {
                    "1": "Агрегаторы",
                    "2": "Видео",
                    "3": "Интернет-магазины",
                    "4": "Контентные проекты",
                    "5": "Новости",
                    "6": "Онлайн-игры",
                    "7": "Порно, эротика",
                    "8": "Портал",
                    "9": "Представительства бизнесов и организаций",
                    "10": "Сервисы",
                    "11": "Сообщества",
                    "12": "Социальные сети",
                    "13": "Ставки",
                    "14": "Прочее"
                },
                "prep_slugs": null
            }
        }
    }
}