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

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

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

Ограничение частоты запросов

Просим Вас обратить внимание на то, что частота запросов к нашему сервису ограничена (100 запросов за 10 минут). Если Вы превысите это ограничение - сервер вернет в ответ HTTP-заголовок со статусом 429 Too Many Requests, немного подождав, Вы сможете возобновить работу с сервисом. С каждым ответом сервер отправляет HTTP-заголовки, содержащие информацию о ограничениях для Вашего аккуанта.

HTTP-заголовки:

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

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

HTTP/1.1 429 Too Many Requests
Date: Wed, 11 Feb 2017 11:30:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 0
X-Rate-Limit-Reset: 600

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

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

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

  • HTTP Basic Auth

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

    curl -X GET -H "Accept: application/json" -H "Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhMGFfdlB6eHFXdm06" "https://inpars.ru/api/v1/estate"
  • Параметр запроса

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

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

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

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

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

Методы: GET | POST

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

ПараметрТипОписание
sortBystringСортировка объектов. Возможные значения:
updated_desc - по убыванию даты изменения (по умолчанию),
updated_asc - по возрастанию даты изменения,
created_desc - по убыванию даты создания,
created_asc - по возрастанию даты создания,
id_desc - по убыванию идентификатора объявления,
id_asc - по возрастанию идентификатора объявления.
lastIdintegerБудут возвращены объекты с идентификатором большим, чем указанный.
timeStartintegerДата начала выборки в формате UNIX-time.
timeEndintegerДата конца выборки в формате UNIX-time.
regionIdintegerИдентификатор региона.
cityIdintegerИдентификатор города.
typeAdintegerИдентификатор типа недвижимости. Возможные значения: 1 - сдам, 2 - продам, 3 - сниму, 4 - куплю.
sectionIdintegerИдентификатор раздела недвижимости.
categoryIdstring/arrayИдентификатор категории недвижимости. Для сокращения числа запросов можно запрашивать несколько категорий через запятую, например: categoryId=1,2 или массив в виде categoryId[]=1&categoryId[]=2.
withAgentinteger0 - отображать только собственников (задан по умолчанию), 1 - добавить в выдачу агентов.
withPhotointegerОтображать объявления 0 - без фото, 1 - с фото. Если параметр не указан, отображаются объявления и с фото и без фото (задано по умолчанию).
costMinintegerЦена от.
costMaxintegerЦена до.
sqMinfloatПлощадь от (десятичный разделитель - точка или запятая).
sqMaxfloatПлощадь до (десятичный разделитель - точка или запятая).
fieldsstringПоля объявления, которые необходимо вернуть. Через запятую, без лишних символов. По умолчанию возвращаются все поля. Возможные значения: id, regionId, cityId, typeAd, sectionId, categoryId, title, address, floor, floors, sq, sqLand, cost, text, images, lat, lng, name, phones, url, agent, source, created, updated.
expandstringДополнительные поля, не включенные по умолчанию. Через запятую, без лишних символов. Возможные значения: region, city, type, section, category, metro, material, rentTime, new, rooms, history.
pageintegerПараметр для обхода коллекции объектов. Пример: page=2, т.е. получить объекты 2 страницы.
per-pageintegerОграничение на количество получаемых объектов. Пример: per-page=20, т.е. получить 20 объектов в одном запросе. Максимальное значение равно количеству получаемых объектов по умолчанию (сейчас 20).
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

Пагинация: вместе с массивом объектов сервер возвращает HTTP заголовки, которые можно использовать для обхода коллекции.

  • X-Pagination-Total-Count: общее количество объектов;
  • X-Pagination-Page-Count: количество страниц;
  • X-Pagination-Current-Page: текущая страница (начиная с 1);
  • X-Pagination-Per-Page: количество объектов на странице;
  • Link: набор ссылок для обхода коллекции объектов.

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

<?php
								
$curl = curl_init();

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

$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: Wed, 27 Jun 2017 22:24:16 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
X-Pagination-Total-Count: 100
X-Pagination-Page-Count: 2
X-Pagination-Current-Page: 1
X-Pagination-Per-Page: 50
Link: <https://inpars.ru/api/v1/estate?page=1>; rel=self, 
	  <https://inpars.ru/api/v1/estate?page=2>; rel=next, 
	  <https://inpars.ru/api/v1/estate?page=2>; rel=last
Content-Length: 3583
Content-Type: application/json; charset=UTF-8

[
    {
        "id": 8471034,
        "regionId": 77,
        "cityId": 1,
        "typeAd": 1,
        "sectionId": 7,
        "categoryId": 38,
        "title": "Помещение 3700 кв.м",
        "address": "Москва",
        "floor": 0,
        "floors": 0,
        "sq": 3700,
        "sqLand": 0,
        "cost": 250,
        "text": "База площадью 3700 м2 с АБК, гаражами и РММ. Сдается на длительный срок. Цена указана за м2.",
        "images": [
            "http://11.img.avito.st/640x480/4379580011.jpg",
            "http://12.img.avito.st/640x480/4379580012.jpg"
        ],
        "lat": "55.755814",
        "lng": "37.617635",
        "name": "Вячеслав",
        "phones": [
            "79000000000"
        ],
        "url": "https://inpars.ru",
        "agent": false,
        "source": "avito.ru",
        "created": "2017-06-21T12:55:32+03:00",
        "updated": "2017-06-21T12:55:32+03:00"
    },
    {
        "id": 8115639,
        "regionId": 77,
        "cityId": 1,
        "typeAd": 1,
        "sectionId": 7,
        "categoryId": 37,
        "title": "Помещение под склад 1020 кв.м, высота потолков: 7 м, подключенная мощность: 63 кВт, Гоголя",
        "address": "Москва, Гоголя",
        "floor": 0,
        "floors": 1,
        "sq": 1020,
        "sqLand": 0,
        "cost": 3000,
        "text": "СКЛАДЫ и ОФИСЫ В АРЕНДУ ОТ СОБСТВЕННИКА В ПОС.ТОМИЛИНО. В пос.Томилино Люберецкого р-на М.О., ул.Гоголя, строение 12, рядом с ЖК «Гоголя-2» дома №№54 корпуса 1 и 2 (Юго-Восток, 10 км.от МКАД) сдаем в прямую аренду складские и офисные помещения. Склад-ангар класса «В» год постройки – 2007г., утеплённый, сухой, автономное воздушное отопление (мощные финские дизельные воздушные тепловентиляторы). Состоит из двух складских блоков, общей площадью 2200 м2 (1180м2 и/или 1020м2, возможно деление блоков) и двухэтажного офисного блока - 170м2 (возможно частями). Склады: высота потолков до низа ферм соответственно 6,2м. и 7,5м., рабочее состояние, 7-мь ворот, не пылящие полы (асфальтобетон), подход еврофур с обеих сторон склада. Рабочее состояние. Сдаётся складской блок 1020м2. Четверо ворот, полы в уровень проезжей части, - в «0» уровень. Удобный подъезд со стороны Октябрьского проспекта через г.Люберцы и с реконструированного Новорязанского шоссе, благоустроенная, огороженная территория 0,7га., площадка для отстоя транспорта, АПС, открытая площадка, все коммуникации, кроме газа, телефоны, интернет, контроль доступа, видеонаблюдение, парковка. Цены – договорные, фиксированные рублёвые, невысокие, разумный торг - уместен. Комиссия – до 50%. Валерий Васильевич (не посредник).",
        "images": [
            "http://11.img.avito.st/640x480/4379580011.jpg",
            "http://12.img.avito.st/640x480/4379580012.jpg"
        ],
        "lat": "55.748741",
        "lng": "37.600370",
        "name": "Валерий",
        "phones": [
            "79000000000"
        ],
        "url": "https://inpars.ru",
        "agent": false,
        "source": "avito.ru",
        "created": "2017-06-15T14:41:32+03:00",
        "updated": "2017-06-15T14:41:32+03:00"
    },
	...
]

Объявление

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

Методы: GET | POST

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

ПараметрТипОписание
:idintegerИдентификатор объявления (обязательный параметр).
fieldsstringПоля объявления, которые необходимо вернуть. Через запятую, без лишних символов. По умолчанию возвращаются все поля. Возможные значения: id, regionId, cityId, typeAd, sectionId, categoryId, title, address, floor, floors, sq, sqLand, cost, text, images, lat, lng, name, phones, url, agent, source, created, updated.
expandstringДополнительные поля, не включенные по умолчанию. Через запятую, без лишних символов. Возможные значения: region, city, type, section, category, metro, material, rentTime, new, rooms, history.
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

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

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v1/estate/3450130?fields=id,title,address,floor,floors,sq,sqLand,cost,text,images,lat,lng,name,phones,url,agent,created,updated&expand=region,city,type,section,category,material,rentTime,new', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Accept: application/json',
        'Authorization: Basic YUVjUzlVZkFhZ0lucGFyU2l2MjNhMGFfdlB6eHFXdm06',
    ),
));

$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: Thu, 27 Jun 2017 00:10:26 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
Content-Length: 1410
Content-Type: application/json; charset=UTF-8

{
    "id": 3450130,
    "title": "1-комн. квартира, коммунальная",
    "address": "Москва, коммунальная",
    "floor": 4,
    "floors": 5,
    "sq": 18,
    "sqLand": 0,
    "cost": 9000,
    "text": "Гостинка теплая состояние хорошее, ванна 1.2 м, пластиковые окна, железная дверь, пустая на длительный срок, собственник",
    "images": [
		"http://11.img.avito.st/640x480/4379580011.jpg",
		"http://12.img.avito.st/640x480/4379580012.jpg"
    ],
    "lat": "55.755814",
    "lng": "37.617635",
    "name": "Мария",
    "phones": [
        "79000000000"
    ],
    "url": "https://inpars.ru",
    "agent": false,
    "created": "2017-04-09T16:31:32+03:00",
    "updated": "2017-04-09T16:31:32+03:00",
    "region": "Москва",
    "city": "Москва",
    "type": "Сдам",
    "section": "Жилая недвижимость",
    "category": "1-к квартира",
    "material": "панельный",
    "rentTime": 1,
    "new": false
}

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

ПолеТипОписание
idintegerИдентификатор объявления.
regionIdintegerИдентификатор региона.
cityIdintegerИдентификатор города.
typeAdintegerИдентификатор типа недвижимости. Возможные значения: 1 - сдам, 2 - продам, 3 - сниму, 4 - куплю.
sectionIdintegerИдентификатор раздела недвижимости.
categoryIdintegerИдентификатор категории недвижимости.
titlestringЗаголовок объявления (может быть пустым).
addressstringАдрес объявления.
floorintegerЭтаж.
floorsintegerЭтажность.
sqdoubleПлощадь (м2).
sqLandfloatПлощадь участка (сот.).
costintegerСтоимость.
textstringТекст объявления.
imagesarrayСсылки на изображения.
latstringШирота - точка координат.
lngstringДолгота - точка координат.
namestringИмя пользователя, разместившего объявление.
phonesarrayТелефоны пользователя, разместившего объявление.
urlstringСсылка на источник объявления.
agentbooleanАгент или собственник. Возможные значения: true - агент, false - собственник.
sourcestringИсточник объявления. Возможные значения: avito.ru, cian.ru, irr.ru, n1.ru, youla.io, sob.ru, egent.ru, bazarpnz.ru, kupiprodai.ru, move.ru, realty.yandex.ru, mirkvartir.ru, moyareklama.ru, life-realty.ru.
createdstringДата добавления объявления (на сервер).
updatedstringДата последнего изменения объявления.
regionstringНаименование региона.
citystringНаименование города.
typestringНаименование типа недвижимости.
sectionstringНаименование раздела недвижимости.
categorystringНаименование категории недвижимости.
materialstringМатериал дома.
rentTimeintegerСрок аренды. Возможные значения: 0 - не указан, 1 - на длительный срок, 2 - посуточно.
newbooleanНовостройка или вторичка. Возможные значения: true - новостройка, false - вторичка.
roomsintegerКоличество комнат.
historyarrayИстория изменений. Возвращает массив в виде списка полей: date - дата изменения, cost - стоимость, agent - агент или собственник (1 - агент, 0 - собственник), phones - телефоны (массив).

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

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

Методы: GET | POST

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

ПараметрТипОписание
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

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

<?php
								
$curl = curl_init();

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

$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, 19 Jun 2017 12:04:32 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
Content-Length: 180
Content-Type: application/json; charset=UTF-8

[
	{
		"id": 1,
		"title": "Республика Адыгея"
	},
	{
		"id": 2,
		"title": "Республика Башкортостан"
	},
	...
]

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

ПолеТипОписание
idintegerИдентификатор региона.
titlestringНаименование региона.

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

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

Методы: GET | POST

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

ПараметрТипОписание
regionIdintegerИдентификатор региона. Если указан, то ответ будут отфильтрован по заданному региону.
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

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

<?php
								
$curl = curl_init();

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

$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, 19 Jun 2017 12:04:32 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
Content-Length: 194
Content-Type: application/json; charset=UTF-8

[
    {
        "id": 127,
        "title": "Майкоп",
        "regionId": 1
    },
    {
        "id": 128,
        "title": "Абадзехская",
        "regionId": 1
    },
	...
]

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

ПолеТипОписание
idintegerИдентификатор города.
titlestringНаименование города.
regionIdintegerИдентификатор региона.

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

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

Методы: GET | POST

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

ПараметрТипОписание
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

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

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v1/estate/section?access-token=aEcS9UfAagInparSiv23a0a_vPzxqWvm', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_CUSTOMREQUEST => 'GET',
	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, 19 Jun 2017 12:04:32 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
Content-Length: 770
Content-Type: application/json; charset=UTF-8

[
    {
        "id": 1,
        "title": "Жилая недвижимость",
        "typeId": 2
    },
    {
        "id": 6,
        "title": "Жилая недвижимость",
        "typeId": 1
    },
	...
]

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

ПолеТипОписание
idintegerИдентификатор раздела.
titlestringНаименование раздела
typeIdintegerТип раздела недвижимости, не путать с typeAd (раздела списка объявлений). Возможные значения: 1 - аренда (сюда входят типы недвижимости: сдам и сниму), 2 - продажа (сюда входят типы недвижимости: продам и куплю).

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

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

Методы: GET | POST

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

ПараметрТипОписание
sectionIdintegerИдентификатор раздела. Если указан, то ответ будут отфильтрован по заданному разделу.
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

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

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v1/estate/category?access-token=aEcS9UfAagInparSiv23a0a_vPzxqWvm', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_CUSTOMREQUEST => 'GET',
	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: Wed, 27 Jun 2017 22:24:16 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
Content-Length: 3583
Content-Type: application/json; charset=UTF-8

[
    {
        "id": 1,
        "title": "1-к квартира",
        "typeId": 2,
        "sectionId": 1
    },
    {
        "id": 2,
        "title": "2-к квартира",
        "typeId": 2,
        "sectionId": 1
    },
	...
]

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

ПолеТипОписание
idintegerИдентификатор категории.
titlestringНаименование категории
typeIdintegerТип раздела недвижимости, не путать с typeAd (раздела списка объявлений). Возможные значения: 1 - аренда (сюда входят типы недвижимости: сдам и сниму), 2 - продажа (сюда входят типы недвижимости: продам и куплю).
sectionIdintegerИдентификатор раздела.

Подписка

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

Методы: GET | POST

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

ПараметрТипОписание
_formatstringФормат возвращаемых данных. Возможные значения: xml, json. По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept".

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

<?php
								
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://inpars.ru/api/v1/user/subscribe?access-token=aEcS9UfAagInparSiv23a0a_vPzxqWvm', // URL запроса
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_CUSTOMREQUEST => 'GET',
	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: Fri, 28 Sep 2017 15:45:12 GMT
Server: nginx
X-Rate-Limit-Limit: 20
X-Rate-Limit-Remaining: 19
X-Rate-Limit-Reset: 0
Content-Length: 418
Content-Type: application/json; charset=UTF-8

[
    {
        "regionId": 22,
        "typeId": 1,
        "startTime": "2017-09-16T13:26:42+03:00",
        "endTime": "2017-10-16T13:26:42+03:00",
        "subscribe": "API 1 месяц",
        "api": true
    },
    {
        "regionId": 55,
        "typeId": 2,
        "startTime": "2017-09-16T13:26:42+03:00",
        "endTime": "2017-10-16T13:26:42+03:00",
        "subscribe": "API 1 месяц",
        "api": true
    }
	...
]

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

ПолеТипОписание
regionIdintegerИдентификатор региона.
typeIdintegerТип раздела недвижимости, не путать с typeAd (раздела списка объявлений). Возможные значения: 1 - аренда (сюда входят типы недвижимости: сдам и сниму), 2 - продажа (сюда входят типы недвижимости: продам и куплю).
startTimestringДата начала действия подписки.
endTimestringДата окончания действия подписки.
subscribestringНаименование подписки.
apibooleanТип подписки: сайт или API. Возможные значения: true - API, false - сайт.

Коды ошибок

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

КодСтатус
200OK. Все сработало именно так, как и ожидалось.
400Неверный запрос. Может быть связано с разнообразными проблемами, такими как неправильные параметры действия, и т.д.
401Аутентификация завершилась неудачно.
402Для доступа к сервису необходима оплата.
403Аутентифицированному пользователю не разрешен доступ к указанной точке входа API.
404Запрошенные данные не существуют.
405Метод не поддерживается. Сверьтесь со списком поддерживаемых HTTP-методов в заголовке Allow.
415Не поддерживаемый тип данных. Запрашивается неправильный тип данных или номер версии.
429Слишком много запросов. Запрос отклонен из-за превышения ограничения частоты запросов.
500Внутренняя ошибка сервера.

Тарифы

Стоимость тарифа указана за один регион, тип недвижимости "Продажа" или "Аренда".

Дополнительная скидка за подключение двух и более регионов.

API 1 месяц

 

2 500

30 дней
Оплатить

API 3 месяца

скидка 5%

7 125

90 дней
Оплатить

API 6 месяцев

скидка 10%

13 500

180 дней
Оплатить

API 12 месяцев

скидка 20%

24 000

365 дней
Оплатить

Города и регионы с повышенной ставкой: Москва.