API для доступа к базе объявлений

Общая информация

При помощи API Вы можете легко и быстро интегрировать функционал нашего сервиса в свою систему. Информация отдается в двух форматах (json и xml), в зависимости от установленного заголовка (Accept) в запросе или при указании в GET параметре (_format). Для того чтобы начать работать с API, Вам необходимо зарегистрироваться, оплатить любой из тарифов, где указано API, скопировать токен (специальный код для доступа к API, найти его можно на странице профиля вашего аккуанта, вкладка API) и использовать его во всех запросах к сервису.

Запросы и ограничения

Внимание: частота запросов к нашему сервису ограничена (10 запросов в минуту), в тестовом режиме разрешено делать 1 запрос в секунду. Если Вы превысите это ограничение - сервер вернет в ответ HTTP-заголовок со статусом 429 Too Many Requests, немного подождав, Вы сможете возобновить работу.

С каждым ответом сервер отправляет HTTP-заголовки, а так же в самом теле ответа содержатся дополнительные информационные поля.

HTTP-заголовки

• X-Rate-Limit-Limit максимальное количество запросов
• X-Rate-Limit-Remaining оставшееся количество запросов
• X-Rate-Limit-Reset количество секунд до полного восстановления лимита

Поле meta

Некоторые значения могут появляться только в определенных запросах.

• limit количество элементов в запросе (равен значению параметра limit списка объявлений)
• totalCount общее количество элементов
• updateLimit доступное количество обновлений (1000 в месяц)
• updateRemaining оставшееся количество обновлений на текущий момент
• rateLimit максимальное количество запросов (аналог X-Rate-Limit-Limit)
• rateRemaining оставшееся количество запросов (аналог X-Rate-Limit-Remaining)
• rateReset количество секунд до полного восстановления лимита (аналог X-Rate-Limit-Reset)

Пример ответа с ошибкой:

HTTP/1.1 429 Too Many Requests
Date: Mon, 29 Jun 2020 07:50:54 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 0
X-Rate-Limit-Reset: 60
Content-Type: application/json; charset=UTF-8

{
	"name": "Too Many Requests",
	"message": "Rate limit exceeded.",
	"code": 0,
	"status": 429
}

Аутентификация

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

• HTTP Basic Auth

  Для использования данного метода необходимо отправлять с запросами HTTP-заголовок Authorization: Basic с base64-кодированным значением username:. В качестве имени пользователя (username) используется токен доступа к API, символ : так же должен быть закодирован.

  curl -X GET -H "Accept: application/json" -H "Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06" "https://inpars.ru/api/v2/estate"

• Параметр запроса

  Все запросы дополняются GET параметром access-token, значение которого равно токену для доступа к API.

  curl -X GET -H "Accept: application/json" "https://inpars.ru/api/v2/estate?access-token=aEcS9UfAagInparSiv23aoa_vPzxqWvm"

Список объявлений

Возвращает список последних объявлений, отсортированных по дате изменения в порядке убывания, включая все оплаченные по тарифу регионы, с возможностью фильтрации по указанным ниже параметрам. Количество объявлений в одном запросе по умолчанию равно 500.

Примечание: каждый день в 00:00 GMT +03:00 происходит смещение объявлений (минус год от начала текущего дня), т.е. Вы можете получить список объявлений только за год.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/estate

Обход коллекции объектов

Для обхода коллекции объектов используйте параметры timeStart, timeEnd и sortBy. Если в запросе объектов больше установленного лимита (поле totalCount больше поля limit), то используйте дату объекта с максимальным или минимальным значением поля updated (зависит от сортировки).

Предположим у Вас сортировка по возрастанию даты изменения sortBy=updated_asc, в таком случае нужно взять поле updated объекта с максимальным значением из списка (это последний объект) и подставить ее в следующий запрос в параметр timeStart (предварительно преобразовав время в формат UNIX-time), параметр timeEnd можно не указывать или указать значение текущей временной метки UNIX.

Предположим у Вас сортировка заданная по умолчанию, т.е. по убыванию даты изменения sortBy=updated_desc, в таком случае нужно взять поле updated объекта с минимальным значением из списка (это последний объект) и подставить ее в следующий запрос в параметр timeEnd (предварительно преобразовав время в формат UNIX-time), параметр timeStart указывать не нужно.

Рекомендуем использовать сортировку sortBy=updated_asc, так как она более привычна для обхода коллекции и временные интервалы в Вашей обработке будут последовательны.

Обратите внимание, что используя дату последнего полученного объекта и подставляя ее в новый запрос, Вы так же получите объекты с этой датой из предыдущего запроса, поэтому используйте фильтрацию на своей стороне.

Пример запроса на получение списка объявлений на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/estate', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06',
    ),
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 07:12:40 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 106876174,
            "regionId": 77,
            "cityId": 1,
            "metroId": 30,
            "typeAd": 1,
            "sectionId": 6,
            "categoryId": 29,
            "title": "2-к квартира, 55 м², 9/14 эт.",
            "address": "Москва, Открытое ш., 24к11",
            "floor": 9,
            "floors": 14,
            "sq": 55,
            "sqLand": 0,
            "cost": 43000,
            "text": "Сдаю 2 комнатную квартиру 55 кв м., 9 этаж (14 эт.) панельного дома, комнаты изолированные (17 и 13 кв. м), кухня 9 кв. м. Вся мебель и бытовая техника есть. Окна выходят во двор, домофон, развитая инфраструктура. Собственник.",
            "images": [
                "https://22.img.avito.st/640x480/8845088222.jpg",
                "https://63.img.avito.st/640x480/8845089163.jpg",
                "https://31.img.avito.st/640x480/8845089631.jpg",
                "https://01.img.avito.st/640x480/8845090401.jpg",
                "https://56.img.avito.st/640x480/8845091056.jpg",
                "https://97.img.avito.st/640x480/8845091497.jpg"
            ],
            "lat": "55.823014",
            "lng": "37.757557",
            "name": "Оксана",
            "phones": [
                79000000000
            ],
            "url": "https://www.avito.ru/moskva/kvartiry/",
            "agent": 0,
            "source": "avito.ru",
            "sourceId": 1,
            "created": "2020-06-29T10:57:34+03:00",
            "updated": "2020-06-29T10:57:34+03:00"
        },
        {
            "id": 104873288,
            "regionId": 77,
            "cityId": 1,
            "metroId": 362,
            "typeAd": 1,
            "sectionId": 6,
            "categoryId": 32,
            "title": "Комната, 12.8 м²",
            "address": "Москва, Некрасовка, Некрасовская улица, 7",
            "floor": 16,
            "floors": 17,
            "sq": 53,
            "sqLand": 0,
            "cost": 15000,
            "text": "Комната очень уютная и теплая для одного человека очень хорошо.если для двоих то сумма будет на тысячу больше.рядом в шаговой доступности магазины аптеки сбербанк.и т.д",
            "images": [
                "https://cdn0.youla.io/files/images/orig/5e/da/5eda159cdaddaa6da4475084-1.jpg",
                "https://cdn0.youla.io/files/images/orig/5e/da/5eda15a195494856b062a598-1.jpg",
                "https://cdn0.youla.io/files/images/orig/5e/da/5eda15a5a38a1930b614e535-1.jpg",
                "https://cdn0.youla.io/files/images/orig/5e/da/5eda15a960c15645d65e1512-1.jpg"
            ],
            "lat": "55.681185",
            "lng": "37.924486",
            "name": "Ольга .",
            "phones": [
                79000000000
            ],
            "url": "//youla.io/moskva/nedvijimost/arenda-komnati/",
            "agent": 0,
            "source": "youla.io",
            "sourceId": 5,
            "created": "2020-06-05T12:53:24+03:00",
            "updated": "2020-06-29T10:57:34+03:00"
        },
        ...
    ],
    "meta": {
        "limit": 10,
        "totalCount": 4784081,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Объявление

Возвращает данные объявления по его идентификатору. В большинстве случаев, запрос использовать не обязательно, т.к. в списке объявлений отображаются все поля.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/estate/:id

Пример запроса на получения информации по объявлению с дополнительными полями на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/estate/106876174?expand=region,city,type,section,category,metro,material,rentTime,isNew,rooms,history,phoneProtected,parseId', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06',
    ),
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 07:12:40 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": {
        "id": 106876174,
        "regionId": 77,
        "cityId": 1,
        "metroId": 30,
        "typeAd": 1,
        "sectionId": 6,
        "categoryId": 29,
        "title": "2-к квартира, 55 м², 9/14 эт.",
        "address": "Москва, Открытое ш., 24к11",
        "floor": 9,
        "floors": 14,
        "sq": 55,
        "sqLand": 0,
        "cost": 43000,
        "text": "Сдаю 2 комнатную квартиру 55 кв м., 9 этаж (14 эт.) панельного дома, комнаты изолированные (17 и 13 кв. м), кухня 9 кв. м. Вся мебель и бытовая техника есть. Окна выходят во двор, домофон, развитая инфраструктура. Собственник.",
        "images": [
            "https://22.img.avito.st/640x480/8845088222.jpg",
            "https://63.img.avito.st/640x480/8845089163.jpg",
            "https://31.img.avito.st/640x480/8845089631.jpg",
            "https://01.img.avito.st/640x480/8845090401.jpg",
            "https://56.img.avito.st/640x480/8845091056.jpg",
            "https://97.img.avito.st/640x480/8845091497.jpg"
        ],
        "lat": "55.823014",
        "lng": "37.757557",
        "name": "Оксана",
        "phones": [
            79000000000
        ],
        "url": "https://www.avito.ru/moskva/kvartiry/",
        "agent": 0,
        "source": "avito.ru",
        "sourceId": 1,
        "created": "2020-06-29T10:57:34+03:00",
        "updated": "2020-06-29T10:57:34+03:00",
        "region": "Москва",
        "city": "Москва",
        "type": "Сдам",
        "section": "Жилая недвижимость",
        "category": "2-к квартира",
        "metro": "Бульвар Рокоссовского",
        "material": "панельный",
        "rentTime": 1,
        "isNew": false,
        "rooms": 2,
        "history": [
            {
                "date": "2020-06-29T10:57:34+03:00",
                "cost": 43000,
                "phones": [
                    79000000001
                ],
                "phoneProtected": true
            }
        ],
        "phoneProtected": true,
        "parseId": "1234567890"
    },
    "meta": {
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Обновление объявлений

Позволяет обновить объекты или добавить пропущенные.

Объект будет добавлен/обновлен при следующих условиях:

• если прошло 24 часа с момента последнего добавления/обновления объекта
• если процесс обработки объекта не вызвал ошибку

Вы можете обновить до 1000 объектов в месяц (динамичное значение, зависит от нагрузки, смотрите значение updateLimit). Если в запросе присутствует ссылка на объект которого нет в базе данных, объект считается новым и не будет учитываться в лимите (значение updateRemaining не уменьшается).

Если Вы или другой пользователь в течении 24 часов отправили ссылку на добавление/обновление объекта, отправив повторный запрос с этой же ссылкой, будет возвращен результат с информацией о задаче. Информация будет доступна 24 часа, спустя 24 часа последующий запрос с этой же ссылкой создаст новую задачу на обновление.

Задача может выполняться в течении 24 часов, средний интервал добавления/обновления объекта составляет 5-10 минут.

На данный момент для добавления/обновления объектов доступны следующие источники: avito.ru, cian.ru, youla.io, gipernn.ru, domclick.ru (список будет расширяться), остальные источники будут проигнорированы.

Примечание: все возможные ограничения для запроса возможно будут изменены в будущем.

Внимание: на запрос не действуют общие ограничения на частоту запросов, что позволяет выполнять запросы к API параллельно с другими, разрешено делать 10 запросов в минуту.

Метод: POST

URL запроса: https://inpars.ru/api/v2/estate/task

Тело запроса: необходимо отправить данные в json формате с параметрами, указанными ниже

Пример запроса на добавление/обновление объектов на языке PHP:

<?php
				
// список ссылок
$urlList = [
    'urls' => [
        'https://avito.ru/moskva/kvartiry/1-k_kvartira_11_m_914_et._1234567890',
        'https://domclick.ru/card/sale__flat__1234567890'
    ]
];
				
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://inpars.ru/api/v2/estate/task', // URL запроса, если требуется добавить ?_format=xml или ?_format=json
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'Content-type: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06',
    ],
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($urlList), // кодируем в json
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Tue, 30 May 2023 16:23:57 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 1,
            "url": "https://avito.ru/moskva/kvartiry/1-k_kvartira_11_m_914_et._1234567890",
            "isExist": false,
            "status": "created",
            "message": "URL добавлен в очередь.",
            "created": "2023-05-30T19:23:57+03:00",
            "updated": "2023-05-30T19:23:57+03:00"
        },
        {
            "id": 2,
            "url": "https://domclick.ru/card/sale__flat__1234567890",
            "isExist": true,
            "status": "inprogress",
            "message": "Объект в обработке.",
            "created": "2023-05-30T19:23:14+03:00",
            "updated": "2023-05-30T19:23:16+03:00"
        }
    ],
    "meta": {
        "updateLimit": 1000,
        "updateRemaining": 999,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Дополнительные поля meta

• updateLimit доступное количество обновлений (1000 в месяц)
• updateRemaining оставшееся количество обновлений на текущий момент

Список регионов

Возвращает список регионов.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/region

Пример запроса на получение списка регионов на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/region', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06',
    ),
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 08:24:37 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 1,
            "title": "Республика Адыгея"
        },
        {
            "id": 2,
            "title": "Республика Башкортостан"
        },
        {
            "id": 3,
            "title": "Республика Бурятия"
        },
        ...
    ],
    "meta": {
        "totalCount": 85,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Список городов

Возвращает список городов.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/city

Пример запроса на получение списка городов региона "Республика Адыгея" на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/city?regionId=1', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06',
    ),
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 08:30:58 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 127,
            "title": "Майкоп",
            "regionId": 1
        },
        {
            "id": 128,
            "title": "Абадзехская",
            "regionId": 1
        },
        {
            "id": 129,
            "title": "Адыгейск",
            "regionId": 1
        },
        ...
    ],
    "meta": {
        "totalCount": 26,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Список метро

Возвращает список метро.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/metro

Пример запроса на получение списка метро региона "Москва" на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/metro?regionId=77', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhb2FfdlB6eHFXdm06',
    ),
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 08:35:17 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 1,
            "title": "Андроновка",
            "regionId": 77,
            "cityId": 1
        },
        {
            "id": 2,
            "title": "Авиамоторная",
            "regionId": 77,
            "cityId": 1
        },
        {
            "id": 3,
            "title": "Автозаводская",
            "regionId": 77,
            "cityId": 1
        },
        ...
    ],
    "meta": {
        "totalCount": 239,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Список разделов

Возвращает список разделов недвижимости.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/estate/section

Пример запроса на получение списка разделов недвижимости на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/estate/section?access-token=aEcS9UfAagInparSiv23aoa_vPzxqWvm', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTPHEADER => array(
        'Accept: application/json'
	)
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 08:38:40 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 1,
            "typeId": 2,
            "title": "Жилая недвижимость"
        },
        {
            "id": 4,
            "typeId": 2,
            "title": "Коммерческая недвижимость"
        },
        {
            "id": 5,
            "typeId": 2,
            "title": "Загородная недвижимость"
        },
        {
            "id": 6,
            "typeId": 1,
            "title": "Жилая недвижимость"
        },
        {
            "id": 7,
            "typeId": 1,
            "title": "Коммерческая недвижимость"
        },
        {
            "id": 8,
            "typeId": 1,
            "title": "Загородная недвижимость"
        }
    ],
    "meta": {
        "totalCount": 6,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Список категорий

Возвращает список категорий недвижимости.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/estate/category

Пример запроса на получение списка категорий недвижимости на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/estate/category?access-token=aEcS9UfAagInparSiv23aoa_vPzxqWvm', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTPHEADER => array(
        'Accept: application/json'
	)
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 08:40:17 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "id": 1,
            "title": "1-к квартира",
            "typeId": 2,
            "sectionId": 1
        },
        {
            "id": 2,
            "title": "2-к квартира",
            "typeId": 2,
            "sectionId": 1
        },
        {
            "id": 3,
            "title": "3-к квартира",
            "typeId": 2,
            "sectionId": 1
        },
        ...
    ],
    "meta": {
        "totalCount": 30,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Подписка

Возвращает список активных подписок.

Методы: GET | POST

URL запроса: https://inpars.ru/api/v2/user/subscribe

Пример запроса на получение списка активных подписок на языке PHP:

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v2/user/subscribe?access-token=aEcS9UfAagInparSiv23aoa_vPzxqWvm', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 3,
    CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTPHEADER => array(
        'Accept: application/json'
	)
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
    echo 'cURL Error #:' . $error;
} else {
	echo $response;
}

Пример ответа в формате JSON:

HTTP/1.1 200 OK
Date: Mon, 29 Jun 2020 08:41:54 GMT
X-Rate-Limit-Limit: 10
X-Rate-Limit-Remaining: 9
X-Rate-Limit-Reset: 6
Content-Type: application/json; charset=UTF-8

{
    "data": [
        {
            "regionId": 55,
            "typeId": 1,
            "startTime": "2020-06-12T21:00:00+03:00",
            "endTime": "2020-07-13T21:00:00+03:00",
            "subscribe": "1 месяц",
            "api": false
        },
        {
            "regionId": 77,
            "typeId": 1,
            "startTime": "2020-03-02T10:10:00+03:00",
            "endTime": "2020-07-31T10:10:00+03:00",
            "subscribe": "API 1 месяц",
            "api": true
        }
    ],
    "meta": {
        "totalCount": 2,
        "rateLimit": 10,
        "rateRemaining": 9,
        "rateReset": 6
    }
}

Описание возвращаемых полей

Коды ошибок

Cписок кодов состояния HTTP, возвращаемых сервисом.

Примеры

Простой пример работы с текущей версией API на языке PHP Вы можете скачать тут.