Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Liudmyla-Ortynska authored Jan 16, 2024
1 parent c6daa90 commit f6bbd40
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@


# Тенденции на рынке б/у авто с REST API AUTO.RIA

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**
**Отслеживайте, анализируйте и прогнозируйте**

Мы запускаем в свободное пользование **“Подсчёт средней цены”**
Expand All @@ -45,7 +47,7 @@


# REST API сайта AUTO.RIA.com

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**
API возвращает данные в формате JSON. Формат данных в большинстве случаев стандартный - коллекция объектов с полями *name* (название объекта) и *value* (его идентификатор).

Идентификатор любой сущности является целым числом.
Expand Down Expand Up @@ -79,8 +81,10 @@ API возвращает данные в формате JSON. Формат да
- [Не на ходу](#user-content-Не-на-ходу)

## Подсчет средней цены
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

### Список поддерживаемых параметров
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

На данный момент поддерживаются следующие параметры:

Expand Down Expand Up @@ -110,7 +114,7 @@ API возвращает данные в формате JSON. Формат да
| [Не на ходу](#user-content-Не-на-ходу) |onRepairParts |`Number`|

### Формат данных в запросе

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**
Все параметры описанные в таблице поддерживаемых параметров должны передаватся в виде чисел. Исключениями являются только параметры - *год выпуска*. *пробег*, *опции* и *коробка передач*.

Если передать массив в параметре *коробка передач*, то это будет интерпретироваться как поиск коробок передач с логическим оператором *ИЛИ*. Т.е. `http://api.auto.ria.com/average?marka_id=9&model_id=31612&gear_id=1&gear_id=2` - выберет для подсчета все **BMW 318** с автоматическими и ручными коробками передач. Аналогично и с параметром *тип топлива*, например: `http://api.auto.ria.com/average?marka_id=9&model_id=31887&yers=2014&fuel_id=1&fuel_id=2` - выберет для подсчета все **BMW 520 2014 года** с дизельными и бензиновыми двигателями.
Expand All @@ -120,6 +124,7 @@ API возвращает данные в формате JSON. Формат да
Если передать массив значений в параметре *опции* это будет интерпретироваться как поиск опций с логическим оператором "И". Т.е. `http://api.auto.ria.com/average?auto_options=217&auto_options=463` выберет для подсчета все объявления, у которых есть опция *ABS* **И** *Галогенные фары*.

### Формат данных в ответе
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

В случае успешного подсчета средней цены по указанным параметрам результат будет со статусом **200 OK**.

Expand Down Expand Up @@ -199,6 +204,7 @@ API возвращает данные в формате JSON. Формат да
Средняя цена для Honda Accord в Киеве - [http://api.auto.ria.com/average?marka_id=28&model_id=262&city_id=9](http://api.auto.ria.com/average?marka_id=28&model_id=262&city_id=9)

## Методы для работы с типами транспорта и кузова
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

### Типы транспорта

Expand All @@ -218,6 +224,7 @@ API возвращает данные в формате JSON. Формат да
```

### Типы кузова
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Типы кузова зависят от типов транспорта. Поэтому для того, чтобы получить список типов кузова необходимо отправить GET запрос на адрес `http://api.auto.ria.com/categories/:categoryId/bodystyles`, где *categoryId* - идентификатор типа транспорта.

Expand Down Expand Up @@ -292,8 +299,10 @@ API возвращает данные в формате JSON. Формат да
Также, при необходимости, можно получиться просто весь список типов кузовов, послав GET запрос по адресу [http://api.auto.ria.com/bodystyles](http://api.auto.ria.com/bodystyles).

## Методы для работы с марками и моделями
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

### Марки
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Марки зависят от типов транспорта. Поэтому для того, чтобы получить список марок необходимо отправить GET запрос по адресу `http://api.auto.ria.com/categories/:categoryId/marks`, где *categoryId* - идентификатор типа транспорта.

Expand All @@ -319,6 +328,8 @@ API возвращает данные в формате JSON. Формат да

### Модели

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Модели зависят от типов транспорта и марок. Следовательно список марок можно получить по адресу `http://api.auto.ria.com/categories/:categoryId/marks/:markId/models`, где *categoryId* - идентификатор типа транспорта а *markId* - идентификатор марки.

Например, для мотоциклов BMW ([http://api.auto.ria.com/categories/2/marks/9/models](http://api.auto.ria.com/categories/2/marks/9/models)), список моделей будет следующим:
Expand Down Expand Up @@ -393,6 +404,8 @@ API возвращает данные в формате JSON. Формат да

## Методы для работы с областями и городами

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

### Области

Получить список областей можно отправив GET запрос по адресу [http://api.auto.ria.com/states](http://api.auto.ria.com/states).
Expand Down Expand Up @@ -429,6 +442,7 @@ API возвращает данные в формате JSON. Формат да
```

### Города
**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Города зависят от областей, поэтому, чтобы получить их список, необходимо послать GET запрос по адресу `http://api.auto.ria.com/states/:stateId/cities`, где *stateId* - идентификатор области.

Expand Down Expand Up @@ -469,6 +483,8 @@ API возвращает данные в формате JSON. Формат да

## Методы для работы с техническими характеристиками

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

### Коробки передач

Коробки передач зависят от типа транспорта, поэтому, чтобы получить их список, необходимо послать GET запрос по адресу `http://api.auto.ria.com/categories/:categoryId/gearboxes`, где *categoryId* - идентификатор типа транспорта.
Expand All @@ -486,6 +502,8 @@ API возвращает данные в формате JSON. Формат да

### Типы привода

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Типы привода также зависят от типа транспорта, поэтому, чтобы получить их список, необходимо плсать GET запрос по адресу `http://api.auto.ria.com/categories/:categoryId/driverTypes`, где *categoryId* - идентификатор типа транспорта.

Например, список типов привода для мотоциклов ([http://api.auto.ria.com/categories/2/driverTypes](http://api.auto.ria.com/categories/2/driverTypes)) выглядит следующим образом:
Expand All @@ -499,6 +517,8 @@ API возвращает данные в формате JSON. Формат да

### Типы топлива

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Типы топлива можно получить отправив GET запрос по адресу [http://api.auto.ria.com/fuels](http://api.auto.ria.com/fuels). Ответ будет выглядеть так:
```javascript
[
Expand All @@ -516,6 +536,8 @@ API возвращает данные в формате JSON. Формат да

### Опции

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Опции зависят от типа транспорта. Получить их список можно отправив GET запрос по адресу `http://api.auto.ria.com/categories/:categoryId/options`, где *categoryId* - идентификатор типа транспорта.

Например, список опций для легковых автомобилей ([http://api.auto.ria.com/categories/1/options](http://api.auto.ria.com/categories/1/options)) будет выглядеть примерно так:
Expand All @@ -537,6 +559,8 @@ API возвращает данные в формате JSON. Формат да

## Цвета

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Получить список всех цветов можно, если отправить GET запрос по адресу [http://api.auto.ria.com/colors](http://api.auto.ria.com/colors). Результат будет седующим:
```javascript
[
Expand Down Expand Up @@ -566,23 +590,31 @@ API возвращает данные в формате JSON. Формат да

## Растаможка ##

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Параметр растаможки может принимать только два значения: `1` - нерастаможенный и `0` - растаможенный.


## После ДТП ##

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Данный параметр принимает следующие значения:
`1` - объявления после ДТП
`0` - остальные объявления

## Взято в кредит ##

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Данный параметр может принимать следующие значения:
`1` - объявления взятые в кредит
`0` - остальные объявления

## Конфискат ##

**Для перегляду актуальної документації перейдіть у розділ ["Документація"](https://developers.ria.com/docs/)**

Данный параметр может принимать следующие значения:
`1` - только конфискованные объявления
`0` - только неконфискованные объявления
Expand Down

0 comments on commit f6bbd40

Please sign in to comment.