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
, так же Вы можете использовать его при тестирований. В разделе списка объявлений отображается срез неактуальных объектов (некоторые данные по полям скрыты или заменены на тестовые), ограничения по другим разделам отсутствуют.
-
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
Параметр | Тип | Описание |
---|---|---|
sortBy | string | Сортировка объектов. Возможные значения: updated_desc - по убыванию даты изменения (по умолчанию), updated_asc - по возрастанию даты изменения, created_desc - по убыванию даты создания, created_asc - по возрастанию даты создания, id_desc - по убыванию идентификатора объявления, id_asc - по возрастанию идентификатора объявления. |
lastId | integer | Будут возвращены объекты с идентификатором большим, чем указанный. При использовании параметра, параметр sortBy доступен в двух значениях: id_desc (по умолчанию) и id_asc , остальные значения сортировки игнорируются. |
timeStart | integer | Дата начала выборки в формате UNIX-time, используется поле updated . |
timeEnd | integer | Дата конца выборки в формате UNIX-time, используется поле updated . |
regionId | integer | Идентификатор региона. |
cityId | integer | Идентификатор города. |
typeAd | integer | Идентификатор типа недвижимости. Возможные значения: 1 - сдам, 2 - продам, 3 - сниму, 4 - куплю. |
sectionId | integer | Идентификатор раздела недвижимости. |
categoryId | string/array | Идентификатор категории недвижимости. Для сокращения числа запросов можно запрашивать несколько категорий через запятую, например: categoryId=1,2 или массив в виде categoryId[]=1&categoryId[]=2 . |
withAgent | integer | 0 - отображать только собственников (задан по умолчанию), 1 - добавить в выдачу агентов. |
withPhoto | integer | Отображать объявления 0 - без фото, 1 - с фото. Если параметр не указан, отображаются объявления и с фото и без фото (задано по умолчанию). |
costMin | integer | Цена от. |
costMax | integer | Цена до. |
sqMin | float | Площадь от (десятичный разделитель - точка или запятая). |
sqMax | float | Площадь до (десятичный разделитель - точка или запятая). |
fields | string | Поля объявления, которые необходимо вернуть. Через запятую, без лишних символов. По умолчанию возвращаются все поля. Возможные значения: id, regionId, cityId, typeAd, sectionId, categoryId, title, address, floor, floors, sq, sqLand, cost, text, images, lat, lng, name, phones, url, agent, source, created, updated . |
expand | string | Дополнительные поля, не включенные по умолчанию. Через запятую, без лишних символов. Возможные значения: region, city, type, section, category, metro, material, rentTime, new, rooms, history, phoneProtected . |
page | integer | Параметр для обхода коллекции объектов. Пример: page=2 , т.е. получить объекты 2 страницы. |
per-page | integer | Ограничение на количество получаемых объектов. Пример: per-page=20 , т.е. получить 20 объектов в одном запросе. Максимальное значение равно количеству получаемых объектов по умолчанию (сейчас 20). |
_format | string | Формат возвращаемых данных. Возможные значения: 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: 20
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
Параметр | Тип | Описание |
---|---|---|
:id | integer | Идентификатор объявления (обязательный параметр ). |
fields | string | Поля объявления, которые необходимо вернуть. Через запятую, без лишних символов. По умолчанию возвращаются все поля. Возможные значения: id, regionId, cityId, typeAd, sectionId, categoryId, title, address, floor, floors, sq, sqLand, cost, text, images, lat, lng, name, phones, url, agent, source, created, updated . |
expand | string | Дополнительные поля, не включенные по умолчанию. Через запятую, без лишних символов. Возможные значения: region, city, type, section, category, metro, material, rentTime, new, rooms, history, phoneProtected . |
_format | string | Формат возвращаемых данных. Возможные значения: 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
}
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор объявления. |
regionId | integer | Идентификатор региона. |
cityId | integer | Идентификатор города. |
typeAd | integer | Идентификатор типа недвижимости. Возможные значения: 1 - сдам, 2 - продам, 3 - сниму, 4 - куплю. |
sectionId | integer | Идентификатор раздела недвижимости. |
categoryId | integer | Идентификатор категории недвижимости. |
title | string | Заголовок объявления (может быть пустым). |
address | string | Адрес объявления. |
floor | integer | Этаж. |
floors | integer | Этажность. |
sq | double | Площадь (м2). |
sqLand | float | Площадь участка (сот.). |
cost | integer | Стоимость. |
text | string | Текст объявления. |
images | array | Ссылки на изображения. |
lat | string | Широта - точка координат. |
lng | string | Долгота - точка координат. |
name | string | Имя пользователя, разместившего объявление. |
phones | array | Телефоны пользователя, разместившего объявление. |
url | string | Ссылка на источник объявления. |
agent | boolean | Агент или собственник. Возможные значения: true - агент, false - собственник. |
source | string | Источник объявления. Возможные значения: avito.ru, cian.ru, n1.ru, youla.io, sob.ru, bazarpnz.ru, move.ru, realty.yandex.ru, gipernn.ru, orsk.ru, domclick.ru . |
created | string | Дата добавления объявления (на сервер). |
updated | string | Дата последнего изменения объявления. |
region | string | Наименование региона. |
city | string | Наименование города. |
type | string | Наименование типа недвижимости. |
section | string | Наименование раздела недвижимости. |
category | string | Наименование категории недвижимости. |
material | string | Материал дома. |
rentTime | integer | Срок аренды. Возможные значения: 0 - не указан, 1 - на длительный срок, 2 - посуточно. |
new | boolean | Новостройка или вторичка. Возможные значения: true - новостройка, false - вторичка. |
rooms | integer | Количество комнат. |
history | array | История изменений. Возвращает массив в виде списка полей: date - дата изменения, cost - стоимость, phones - телефоны (массив), phoneProtected - телефон защищен. |
phoneProtected | boolean | телефон защищен. |
Список регионов
Возвращает список регионов.
Методы: GET
| POST
URL запроса: https://inpars.ru/api/v1/region
Параметр | Тип | Описание |
---|---|---|
_format | string | Формат возвращаемых данных. Возможные значения: 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": "Республика Башкортостан"
},
...
]
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор региона. |
title | string | Наименование региона. |
Список городов
Возвращает список городов.
Методы: GET
| POST
URL запроса: https://inpars.ru/api/v1/city
Параметр | Тип | Описание |
---|---|---|
regionId | integer | Идентификатор региона. Если указан, то ответ будут отфильтрован по заданному региону. |
_format | string | Формат возвращаемых данных. Возможные значения: 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
},
...
]
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор города. |
title | string | Наименование города. |
regionId | integer | Идентификатор региона. |
Список метро
Возвращает список метро.
Методы: GET
| POST
URL запроса: https://inpars.ru/api/v1/metro
Параметр | Тип | Описание |
---|---|---|
regionId | integer | Идентификатор региона. Если указан, то ответ будут отфильтрован по заданному региону. |
cityId | integer | Идентификатор города. Если указан, то ответ будут отфильтрован по заданному городу. |
_format | string | Формат возвращаемых данных. Возможные значения: xml , json . По умолчанию необходимый формат будет определен на основе HTTP заголовка "Accept". |
Пример запроса на получение списка метро региона "Москва" на языке PHP:
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://inpars.ru/api/v1/metro?regionId=77', // 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-Type: application/json; charset=UTF-8
[
{
"id": 1,
"title": "Андроновка",
"regionId": 77,
"cityId": 1
},
{
"id": 2,
"title": "Авиамоторная",
"regionId": 77,
"cityId": 1
},
...
]
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор метро. |
title | string | Наименование города. |
regionId | integer | Идентификатор региона. |
cityId | integer | Идентификатор города. |
Список разделов
Возвращает список разделов недвижимости.
Методы: GET
| POST
URL запроса: https://inpars.ru/api/v1/estate/section
Параметр | Тип | Описание |
---|---|---|
_format | string | Формат возвращаемых данных. Возможные значения: 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
},
...
]
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор раздела. |
title | string | Наименование раздела |
typeId | integer | Тип раздела недвижимости, не путать с typeAd (раздела списка объявлений). Возможные значения: 1 - аренда (сюда входят типы недвижимости: сдам и сниму), 2 - продажа (сюда входят типы недвижимости: продам и куплю). |
Список категорий
Возвращает список категорий недвижимости.
Методы: GET
| POST
URL запроса: https://inpars.ru/api/v1/estate/category
Параметр | Тип | Описание |
---|---|---|
sectionId | integer | Идентификатор раздела. Если указан, то ответ будут отфильтрован по заданному разделу. |
_format | string | Формат возвращаемых данных. Возможные значения: 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
},
...
]
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
id | integer | Идентификатор категории. |
title | string | Наименование категории |
typeId | integer | Тип раздела недвижимости, не путать с typeAd (раздела списка объявлений). Возможные значения: 1 - аренда (сюда входят типы недвижимости: сдам и сниму), 2 - продажа (сюда входят типы недвижимости: продам и куплю). |
sectionId | integer | Идентификатор раздела. |
Подписка
Возвращает список активных подписок.
Методы: GET
| POST
URL запроса: https://inpars.ru/api/v1/user/subscribe
Параметр | Тип | Описание |
---|---|---|
_format | string | Формат возвращаемых данных. Возможные значения: 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
}
...
]
Описание возвращаемых полей
Поле | Тип | Описание |
---|---|---|
regionId | integer | Идентификатор региона. |
typeId | integer | Тип раздела недвижимости, не путать с typeAd (раздела списка объявлений). Возможные значения: 1 - аренда (сюда входят типы недвижимости: сдам и сниму), 2 - продажа (сюда входят типы недвижимости: продам и куплю). |
startTime | string | Дата начала действия подписки. |
endTime | string | Дата окончания действия подписки. |
subscribe | string | Наименование подписки. |
api | boolean | Тип подписки: сайт или API. Возможные значения: true - API, false - сайт. |
Коды ошибок
Cписок кодов состояния HTTP, возвращаемых сервисом.
Код | Статус |
---|---|
200 | OK. Все сработало именно так, как и ожидалось. |
400 | Неверный запрос. Может быть связано с разнообразными проблемами, такими как неправильные параметры действия, и т.д. |
401 | Аутентификация завершилась неудачно. |
402 | Для доступа к сервису необходима оплата. |
403 | Аутентифицированному пользователю не разрешен доступ к указанной точке входа API. |
404 | Запрошенные данные не существуют. |
405 | Метод не поддерживается. Сверьтесь со списком поддерживаемых HTTP-методов в заголовке Allow . |
415 | Не поддерживаемый тип данных. Запрашивается неправильный тип данных или номер версии. |
429 | Слишком много запросов. Запрос отклонен из-за превышения ограничения частоты запросов. |
500 | Внутренняя ошибка сервера. |
Тарифы
Стоимость тарифа указана за один регион, тип недвижимости "Продажа" или "Аренда".
Дополнительная скидка за подключение двух и более регионов.
Города и регионы с повышенной ставкой: Москва.