API Documentation / Документация по API

This document provides detailed instructions on how to use the /api/close/getAuc endpoint in both English and Russian.

Этот документ содержит подробные инструкции по использованию конечной точки API /api/close/getAuc на английском и русском языках.

1. Overview / Обзор

English:

This API endpoint retrieves auction lot data. It supports both production and test modes. In production mode, data is paginated with 250 records per page, while in test mode the page parameter is ignored and a limited dataset is returned. The API returns detailed information for each auction lot along with the total number of pages (in production).

Русский:

Эта конечная точка API возвращает данные о лотах аукциона. API поддерживает как рабочий (production), так и тестовый режим. В рабочем режиме данные разбиваются на страницы по 250 записей, а в тестовом режиме параметр страницы игнорируется, и возвращается ограниченный набор данных. API возвращает подробную информацию для каждого лота аукциона, а также общее количество страниц (в рабочем режиме).

2. Endpoint / Конечная точка

English:

URL: /api/close/getAuc
Method: GET or POST

Русский:

URL: /api/close/getAuc
Метод: GET или POST

3. Request Parameters / Параметры запроса

Parameter	Type	Required	Description (EN)	Описание (RU)
key	string	Yes	Your API key. If the key contains the substring "test", the API operates in test mode.	Ваш API-ключ. Если ключ содержит подстроку "test", API работает в тестовом режиме.
page	integer	No	The page number to retrieve (250 records per page). Ignored in test mode.	Номер страницы для выборки данных (на странице 250 записей). Игнорируется в тестовом режиме.
lang	string	No	Response language. Allowed values: `ru` (default) or `en`. If not specified, Russian (`ru`) will be used.	Язык ответа. Допустимые значения: `ru` (по умолчанию) или `en`. Если параметр не указан, используется русский (`ru`).

4. Rate Limiting / Ограничение запросов

English:

Test Mode: Allowed once every 5 seconds.
Production Mode: Allowed once every 5 seconds.

If a request is made before the allowed interval, the API returns an error message.

Русский:

Тестовый режим: Разрешён один запрос каждые 5 секунд.
Рабочий режим: Разрешён один запрос каждые 5 секунд.

Если запрос выполнен раньше установленного интервала, API возвращает сообщение об ошибке.

5. Response Structure / Структура ответа

On Success:

The API returns a JSON object with:

status: "success"
lots: An array of auction lot objects.
total_pages: (Production mode only) The total number of pages available.

При ошибке:

status: "error"
message: A description of the error.

6. Auction Lot Object Fields / Поля объекта лота аукциона

Field	Type	Description (EN)	Описание (RU)
auction_date	integer	Unix timestamp of the auction date.	Unix timestamp даты аукциона.
line	string	Auction line.	Линия аукциона.
hub	string	Auction hub.	Хаб аукциона.
auction	string	Auction code.	Код аукциона.
status	integer	Auction status. If status equals 1, the lot is inspected; otherwise, it is not inspected.	Статус аукциона. Если status равен 1, лот осмотрен; в противном случае – не осмотрен.
availability	integer	Availability flag. 1: Sold, 2: Not sold, 4: Canceled; any other value means "for sale".	Флаг доступности. 1 – Продан, 2 – Не продан, 4 – Отменен; любое другое значение означает "в продаже".
bid	integer	Bid number.	Номер лота.
brand	string	Brand name.	Название бренда.
model	string	Model name.	Название модели.
cover	integer	Cover information.	Информация об cover.
frame	string	Frame number.	Номер рамы.
engine	string	Engine number.	Номер двигателя.
mileage	integer	Mileage.	Пробег.
mileage_name	string	Mileage. m – miles, km – kilometers	Пробег. m – мили, km – километры
mileage_type	integer	Mileage type. 0: No notes, 1: Doubt about mileage veracity, 2: Speedometer replaced, 3 – Service odometer replacement	Тип пробега. 0 – пометок нет, 1 – сомнение в правдивости пробега, 2 – спидометр заменён, 3 – Сервисная замена спидометра
inspection	integer	Inspection value.	Показатель осмотра.
history	string	Auction history.	История лота.
color	string	Vehicle color.	Цвет лота.
volume	integer	Engine volume.	Объём двигателя.
year	integer	Production year.	Год выпуска.
registration	string	Registration details.	Регистрационные данные.
number	string	Vehicle number.	Номер лота.
price_start	integer	Starting price.	Стартовая цена.
price_finish	integer	Final price.	Конечная цена.
comment_auction	string	Auction comment.	Комментарий аукциона.
sales_data	string	Sales data information.	Данные по продажам.
comment_seller	string	Seller comment.	Комментарий продавца.
rank	float	Overall rank.	Общая оценка.
ranks	array	Array of rank objects.	Массив объектов оценок.
updated	integer	Unix timestamp of the last update.	Unix timestamp последнего обновления.
added	integer	Unix timestamp when the record was added.	Unix timestamp добавления записи.
images	array	(Content and links may change!) Array of image URLs. Image types: 55 indicates video, 54 indicates main photo; other types match rank IDs. (domain for content https://img.motopodbor.com)	(Контент и ссылки могут изменяться!) Массив URL фотографий. Типы изображений: 55 – видео, 54 – основные фото, другие типы соответствуют ID оценок. (домен у контента https://img.motopodbor.com)
jba_dop_info	object	Additional information for lots with `auction = JBA`. Only present if `auction = JBA`.	Дополнительная информация для лотов с `auction = JBA`. Отображается только для таких лотов.

7. jba_dop_info Object Fields / Поля объекта jba_dop_info

The jba_dop_info object provides additional detailed evaluation information for auction lots with auction = JBA. Below is the description of its fields.

Объект jba_dop_info предоставляет дополнительную информацию по оценке лотов аукциона с auction = JBA. Ниже приведено описание его полей.

Field	Type	Description (EN)	Описание (RU)
flag_document	string	Document flag. "1" indicates documents are in order; "0" means documents are not in order.	Флаг документации. "1" означает, что документы в порядке, "0" – что документы не в порядке.
flag_not_working_engine	string	Engine functionality flag. "0" indicates the engine is working; "1" indicates it is not working.	Флаг работоспособности двигателя. "0" – двигатель работает, "1" – не работает.
flag_dtp	string	Accident flag. "0" indicates no accident history; "1" indicates an accident occurred.	Флаг ДТП. "0" означает отсутствие ДТП, "1" — наличие ДТП.
overal_rating	string	Overall rating as a numeric string (e.g., "3").	Общая оценка в виде числовой строки (например, "3").
appearance_rating	string	Appearance rating. Possible values: S, A, B, C, D, E.	Оценка внешнего вида. Возможные значения: S – новый, A – отлично, B – хорошо, C – удовлетворительно, D – плохо, E – значительный износ.
engine_rating	string	Engine rating. Possible values: S, A, B, C, D, E.	Оценка двигателя. Возможные значения: S – новый, A – отлично, B – хорошо, C – удовлетворительно, D – плохо, E – значительный износ.
frame_rating	string	Frame rating. Possible values: S, A, B, C, D, E.	Оценка рамы. Возможные значения: S – новый, A – отлично, B – хорошо, C – удовлетворительно, D – плохо, E – значительный износ.
shaken	string	Shaken status or additional notes regarding shaking; may be empty if not applicable.	Статус тряски или дополнительные примечания по поводу тряски; может быть пустым, если не применимо.
suspension_rating	string	Suspension rating. Possible values: S, A, B, C, D, E.	Оценка подвески. Возможные значения: S – новый, A – отлично, B – хорошо, C – удовлетворительно, D – плохо, E – значительный износ.

Possible Ratings / Возможные оценки

Rating	English Meaning	Russian Meaning
S	New	Новый
A	Excellent	Отлично
B	Good	Хорошо
C	Satisfactory	Удовлетворительно
D	Poor	Плохо
E	Significant wear	Значительный износ

8. IAUC comment_auction Data / Данные comment_auction для auction = IAUC

English:

If auction is equal to IAUC, the comment_auction field contains a JSON string with detailed evaluation data. The structure of the JSON is as follows:

{
    "condition": integer, // Overall technical condition rating.
    "exterior": integer,  // Exterior appearance rating.
    "equipment": [integer, ...], // Array of binary flags for equipment items.
    "changes": [integer, ...],   // Array of binary flags for modifications/additions.
    "remarks": string,    // Expert remarks (may include newline characters and HTML-encoded symbols).
    "tuning": integer     // Tuning status (1 indicates tuned).
}

Mapping for the arrays:

changes items correspond to: ["Steering Wheel", "Mirrors", "Turn Signals", "Speedometer", "Fenders", "Seat", "Footrests", "Muffler (canister)", "Muffler (highway)", "Shock Absorber"]
equipment items correspond to: ["Red Key", "No Documents", "Spare Key", "Instruction Manual", "Customs"]

Example:

{"condition":2,"exterior":2,"equipment":[0,0,0,0,0],"changes":[0,0,0,0,0,0,0,0,0,0],"remarks":"правый ... чехол  потертость < средний > \u000AR крыло ..< большой > \u000A зеркало  потертость < средний > \u000A зеркало  коррозия < большой > \u000A внешний вид  установка  смещение \u000A внешний вид ..< средний > \u000A внешний вид  пятна < средний > \u000A рычаг  потертость \u000A вилка  пыль  пыльник  порванный \u000AR багажник  коррозия","tuning":1}

Русский:

Если значение auction равно IAUC, то поле comment_auction содержит строку в формате JSON с подробными данными оценки. Структура JSON выглядит следующим образом:

{
    "condition": integer, // Общая оценка технического состояния.
    "exterior": integer,  // Оценка внешнего вида.
    "equipment": [integer, ...], // Массив флагов (0 – Нет, 1 – Да) для комплектации.
    "changes": [integer, ...],   // Массив флагов (0 – Нет, 1 – Да) для изменений/дополнений.
    "remarks": string,    // Замечания эксперта (может содержать переносы строк и HTML-кодированные символы).
    "tuning": integer     // Статус тюнинга (1 – тюнингован).
}

Соответствие элементов массивов:

Элементы массива changes соответствуют: ["Руль", "Зеркала", "Поворотники", "Спидометр", "Крылья", "Сиденье", "Подножки", "Глушитель (банка)", "Глушитель (трасса)", "Амортизатор"]
Элементы массива equipment соответствуют: ["Красный ключ", "Нет документов", "Запасной ключ", "Инструкция", "Таможня"]

Пример:

{"condition":2,"exterior":2,"equipment":[0,0,0,0,0],"changes":[0,0,0,0,0,0,0,0,0,0],"remarks":"правый ... чехол  потертость < средний > \u000AR крыло ..< большой > \u000A зеркало  потертость < средний > \u000A зеркало  коррозия < большой > \u000A внешний вид  установка  смещение \u000A внешний вид ..< средний > \u000A внешний вид  пятна < средний > \u000A рычаг  потертость \u000A вилка  пыль  пыльник  порванный \u000AR багажник  коррозия","tuning":1}

9. ARAI dop_info Object Fields / Поля объекта arai_dop_info

The arai_dop_info object provides additional detailed evaluation information for auction lots with auction = ARAI. This object appears only if auction = ARAI, similarly to how jba_dop_info is shown for auction = JBA. Below is the description of its fields.

Объект arai_dop_info предоставляет дополнительную информацию по оценке лотов аукциона с auction = ARAI. Этот объект отображается только в том случае, если auction = ARAI, аналогично тому, как jba_dop_info используется для auction = JBA.

Field	Type	Description (EN)	Описание (RU)
engine_rating	string	Engine rating. Possible values: S (New), A (Excellent), B (Good), C (Satisfactory), D (Poor), E (Significant wear), X (No rating).	Оценка двигателя. Возможные значения: S (Новый), A (Отлично), B (Хорошо), C (Удовлетворительно), D (Плохо), E (Значительный износ), X (Без оценки).
frame_rating	string	Frame rating. Possible values: S (New), A (Excellent), B (Good), C (Satisfactory), D (Poor), E (Significant wear), X (No rating).	Оценка рамы. Возможные значения: S (Новый), A (Отлично), B (Хорошо), C (Удовлетворительно), D (Плохо), E (Значительный износ), X (Без оценки).
appearance_rating	string	Appearance rating. Possible values: S (New), A (Excellent), B (Good), C (Satisfactory), D (Poor), E (Significant wear), X (No rating).	Оценка внешнего вида. Возможные значения: S (Новый), A (Отлично), B (Хорошо), C (Удовлетворительно), D (Плохо), E (Значительный износ), X (Без оценки).
suspension_rating	string	Suspension rating. Possible values: S (New), A (Excellent), B (Good), C (Satisfactory), D (Poor), E (Significant wear), X (No rating).	Оценка подвески. Возможные значения: S (Новый), A (Отлично), B (Хорошо), C (Удовлетворительно), D (Плохо), E (Значительный износ), X (Без оценки).