GET /search/moto/breadcrumbs

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

Формат запроса

GET https://apiauto.ru/1.0/search/moto/breadcrumbs
? [bc_lookup=<array[string]>]
& [rid=<array[string]>]
& [state=<array[string]>]

bc_lookup

Уровень иерархии. Тип мототранспорта и идентификатор марки, разделенные закодированным символом «#» (%23), например MOTORCYCLE%23CONFEDERATE. При указании значений следует соблюдать порядок тип мототранспорта—марка. Часть значений может отсутствовать.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

bc_lookup=MOTORCYCLE%23MERCEDES&bc_lookup=MOTORCYCLE%23HONDA

rid

Массив идентификаторов регионов. Справочник регионов можно скачать по ссылке.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

rid=213&rid=215

state

Состояние транспорта.

Допустимые значения:
  • NEW — новый транспорт;
  • USED — транспорт с пробегом;
  • BEATEN — битый транспорт (для безопасной эксплуатации необходим ремонт).

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

Формат ответа

Общая структура
{
  "breadcrumbs":[
    {
      "entities":[
        {
          ...
        },
        {
          ...
        }
      ],
      "meta_level":"{string}",  /* MODEL_LEVEL */
      "mark":{
        ...
      }
    },
    {
    "entities":[
        {
          ...
        },
        {
          ...
        }
      ],
      "meta_level":"{string}"  /* MARK_LEVEL */
    },
    {
      "entities":[
        {
          ...
        },
        {
          ...
        }
      ],
      "meta_level":"{string}"  /* TYPE_LEVEL */
    }
  ],
  "status":"{string}"
}

breadcrumbs

Найденные уровни иерархии из каталога транспортных средств. Каждый объект breadcrumb содержит уровни иерархии entities.

entities

Один из уровней иерархии. Структура каталога Авто.ру состоит из следующих уровней:

  • «TYPE»;
  • «MARK»;
  • «MODEL».

В одном параметре entities выдается один из перечисленных уровней в порядке иерархии.

meta_level

Название уровня иерархии.

mark

Общая информация о данной марке.

status

Статус ответа.

Уровень иерархии «MODEL»
    {
      "entities":[
        {
          "id":"{string}",
          "name":"{string}",
          "offers_count":{integer},
          "is_popular":{boolean},
          "model":{
            "moto_functions":[
              "{string}",
              "{string}"
            ],
            "default_configuration_id":"{string}",
            "nameplates":[
              {
                "name":"{string}",
                "code":"{string}",
                "autoru_id":"{string}",
                "offers_count":{integer}
              },
              {
                ...
              }
            ],
            "photo":{
              "name":"{string}",
              "sizes":{
                "{string}":"{string}",
                "{string}":"{string}"
              }
            },
            "cyrillic_name":"{string}"
          },
          "reviews_count": {integer}
        },
        {
          ...
        }
      ],
      "meta_level":"{string}",  /* MODEL_LEVEL */
      "mark":{
        "id":"{string}",
        "name":"{string}",
        "offers_count":{integer},
        "is_popular":{boolean}, 
        "mark":{
          "logo":{
            "name":"{string}",
            "sizes":{
              "{string}":"{string}",
              "{string}":"{string}"
            }
          },
          "vendor_ids":[
            {integer},
            {integer}
          ],
          "cyrillic_name":"{string}"
        },
        "reviews_count": {integer}
      }
    }

entities

Уровень иерархии «MODEL» — уровень модели. На этом уровне перечисляются все модели для указанной в запросе марки и количество активных объявлений по каждой модели.

id

Идентификатор модели.

name

Название модели.

offers_count

Общее количество объявлений по данной модели.

is_popular

Признак популярности модели. Подсчет популярности основывается на рейтинге от экспертов области.

Допустимые значения:
  • true — модель популярна;
  • false — модель непопулярна.

model

Подробное описание модели.

default_configuration_id

Идентификатор конфигурации по умолчанию.

nameplates

Разновидности модели. Массив объектов.

name

Название разновидности модели.

code

Код разновидности модели.

autoru_id

Идентификатор разновидности модели.

offers_count

Количество доступных объявлений для текущей разновидности модели.

moto_functions

Назначение мототранспорта (например, дорожный мотоцикл). Массив значений.

Внимание

Параметр актуален только для мототранспорта.

photo

Ссылки на фото.

name

Идентификатор фотографии.

sizes

Объект с возможными размерами фотографии. Пример: "120x90":"//images.md../943h4345/68..cd..ceeb..regbbdf43/120x90", где первый параметр — размер картинки, второй — URL-адрес картинки.

cyrillic_name

Название модели кириллицей.

reviews_count

Количество отзывов на данную модель.

meta_level

Название уровня иерархии.

mark

Общая информация о данной марке.

id

Идентификатор марки.

name

Название марки.

offers_count

Количество объявлений с данной маркой.

is_popular

Признак популярности марки. Подсчет популярности основывается на рейтинге от экспертов области.

Допустимые значения:
  • true — марка популярна;
  • false — марка непопулярна.

mark

Подробное описание марки.

logo

Ссылка на логотип марки.

name

Идентификатор фотографии.

sizes

Объект с возможными размерами фотографии. Пример: "120x90":"//images.md../943h4345/68..cd..ceeb..regbbdf43/120x90", где первый параметр — размер картинки, второй — URL-адрес картинки.

vendor_ids

Массив идентификаторов производителей данной марки.

cyrillic_name

Название марки кириллицей.

reviews_count

Количество отзывов на данную марку.

Уровень иерархии «MARK»
    {
      "entities":[
        {
          "id":"{string}",
          "name":"{string}",
          "offers_count":{integer},
          "is_popular":{boolean}, 
          "mark":{
            "logo":{
              "name":"{string}",
              "sizes":{
                "{string}":"{string}",
                "{string}":"{string}"
              }
            },
            "vendor_ids":[
              {integer},
              {integer}
            ],
            "cyrillic_name":"{string}"
          },
          "reviews_count": {integer}
        },
        {
          ...
        }
      ],
      "meta_level":"{string}",  /* MARK_LEVEL */
    }

entities

Уровень иерархии «MARK» — уровень марки. На этом уровне перечисляются все марки с активными объявлениями и количество активных объявлений по каждой марке.

id

Идентификатор марки.

name

Название марки.

offers_count

Количество объявлений с данной маркой.

is_popular

Признак популярности марки. Подсчет популярности основывается на рейтинге от экспертов области.

Допустимые значения:
  • true — марка популярна;
  • false — марка непопулярна.

mark

Подробное описание марки.

logo

Ссылка на логотип марки.

name

Идентификатор фотографии.

sizes

Объект с возможными размерами фотографии. Пример: "120x90":"//images.md../943h4345/68..cd..ceeb..regbbdf43/120x90", где первый параметр — размер картинки, второй — URL-адрес картинки.

vendor_ids

Массив идентификаторов производителей данной марки.

cyrillic_name

Название марки кириллицей.

reviews_count

Количество отзывов на данную марку.

meta_level

Название уровня иерархии.

Уровень иерархии «TYPE»
    {
      "entities":[
        {
          "id":"{string}",
          "name":"{string}",
          "offers_count":{integer},
          "reviews_count": {integer}
        },
        {
          ...
        }
      ],
      "meta_level":"{string}",  /* TYPE_LEVEL */
    }

entities

Уровень иерархии «TYPE» — уровень типа мототранспорта. На этом уровне перечисляются все типы с активными объявлениями и количеством активных объявлений по каждому типу.

id

Идентификатор типа транспорта.

name

Название типа транспорта.

offers_count

Общее количество объявлений по данному типу транспорта.

reviews_count

Количество отзывов по данному типа транспорта.

meta_level

Название уровня иерархии.

Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/search/moto/breadcrumbs?bc_lookup=MOTORCYCLE%23HONDA%23&state=USED&state=NEW&rid=213' -H 'x-authorization: 2dtrer432...'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 06 Sep 2017 13:35:57 GMT
Content-Type: application/json
Content-Length: 44208
Connection: keep-alive

{ 
  "breadcrumbs":[
    {
      "entities":[
        {
          "id":"B120_WRAITH",
          "name":"B120 Wraith",
          "model":{
            "moto_functions":[
              "cruiser"
            ],
            "photo":{
              "name":"model-photo",
              "sizes":{
                "main":"//avatafdg3441019/mobile",
                "mini-card":"//avatargre3432019/minicard"
              }
            }
          }
        },
        {
          "id":"F124_HELLCAT",
          "name":"F124 Hellcat",
          "model":{
            "moto_functions":[
              "cruiser"
            ],
            "photo":{
              "name":"model-photo",
              "sizes":{
                "main":"//avatartg149404354/mobile",
                "mini-card":"//avatar453f/minicard"
              }
            }
          }
        },
        {
          ...
        }
      ],
      "meta_level":"MODEL_LEVEL",
      "mark":{
        "id":"CONFEDERATE",
        "name":"Confederate",
        "mark":{
          "logo":{
            "name":"mark-logo",
            "sizes":{
              "logo":"//avatar4tr144gdf437/logo"
            }
          }
        }
      }
    },
    {
      "entities":[
        {
          "id":"ABM",
          "name":"ABM",
          "offers_count":5,
          "mark":{
            "logo":{
              "name":"mark-logo",
              "sizes":{
                "logo":"//avataralogrt344/logo"
              }
            }
          }
        },
        {
          ...
        },
        {
          "id":"DODGE",
          "name":"Dodge",
          "is_popular":true,
          "mark":{
            "logo":{
              "name":"mark-logo",
              "sizes":{
      	   "logo":"//avatar45fd418/logo"
      	 }
            }
          }
        },
        {
          "id":"DUCATI",
          "name":"Ducati",
          "offers_count": 267,
          "mark":{
            "logo":{
              "name":"mark-logo",
              "sizes":{
      	   "logo":"//avatarrfg.11134f41/logo"
      	 }
            }
          }
        },
        {
          "id":"E_V_A_",
          "name":"E.V.A.",
          "mark":{
            "logo":{
              "name":"mark-logo"
            }
          }
        },
        {
          "id":"URAL",
          "name":"Урал",
          "offers_count": 65,
          "mark":{
            "logo":{
              "name":"mark-logo",
              "sizes":{
      	   "logo":"//avatar45fd20/logo"
      	 }
            }
          }
        }
      ],
      "meta_level":"MARK_LEVEL"
    },
    {
      "entities":[
        {
          "id":"ATV",
          "name":"Мотовездеход",
          "offers_count": 882
        },
        {
          "id":"MOTORCYCLE",
          "name":"Мотоцикл",
          "offers_count": 9371
        },
        {
          "id":"SCOOTERS",
          "name":"Скутер",
          "offers_count": 1799
        },
        {
          "id":"SNOWMOBILE",
          "name":"Снегоход",
          "offers_count": 172
        }
      ],
      "meta_level":"TYPE_LEVEL"
    }
  ],
  "status":"SUCCESS"
}

Уровень иерархии. Тип мототранспорта и идентификатор марки, разделенные закодированным символом «#» (%23), например MOTORCYCLE%23CONFEDERATE. При указании значений следует соблюдать порядок тип мототранспорта—марка. Часть значений может отсутствовать.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

bc_lookup=MOTORCYCLE%23MERCEDES&bc_lookup=MOTORCYCLE%23HONDA

Массив идентификаторов регионов. Справочник регионов можно скачать по ссылке.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

rid=213&rid=215

Состояние транспорта.

Допустимые значения:
  • NEW — новый транспорт;
  • USED — транспорт с пробегом;
  • BEATEN — битый транспорт (для безопасной эксплуатации необходим ремонт).

Подробное описание марки.

Предыдущая
GET /search/cars/breadcrumbs
Следующая
GET /search/trucks/breadcrumbs