> For the complete documentation index, see [llms.txt](https://docs.bbx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bbx.com/ru/publichnyi-api-bbx-dex/integraciya-coingecko/stakan-zayavok.md).

# Стакан заявок

Возвращает текущую глубину книги ордеров для указанного **BBX DEX** рынка бессрочных криптовалютных фьючерсов.

Ответ содержит отдельные `заявки на покупку` и `заявки на продажу` массивы. Каждый ценовой уровень представлен как `[цена, количество]` пара, при этом оба значения возвращаются в виде строк.

***

### Эндпоинт

```http
GET /fapi/market/v1/public/coingecko/orderbook
```

### Полный URL

```
https://dex.bbx.com/fapi/market/v1/public/coingecko/orderbook
```

***

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

Аутентификация не требуется.

Эндпоинт общедоступен и не требует:

* API-ключ
* Подпись запроса
* Учетные данные для входа
* Токен аутентификации
* Пользовательский заголовок запроса

***

### Параметры запроса

| Параметр    | Тип         | Обязательный | Описание                                                                        |
| ----------- | ----------- | -----------: | ------------------------------------------------------------------------------- |
| `ticker_id` | строка      |           Да | Идентификатор контракта в `BASE-TARGET` формате, например `BTC-USDT`            |
| `depth`     | целое число |          Нет | Общее запрошенное количество уровней книги ордеров по сторонам покупок и продаж |

***

### Именование пары

Пара `ticker_id` должна использовать следующий формат:

```
BASE-TARGET
```

Примеры:

```
BTC-USDT
ETH-USDT
SOL-USDT
```

***

### Правила глубины

Пара `depth` параметр представляет собой общее запрошенное количество уровней по обеим сторонам книги ордеров.

Примеры:

| Запрошенная глубина | Максимальное количество уровней на стороне покупок | Максимальное количество уровней на стороне продаж |
| ------------------: | -------------------------------------------------: | ------------------------------------------------: |
|               `100` |                                                 50 |                                                50 |
|               `200` |                                                100 |                                               100 |

Для нечётных значений глубины запрошенная глубина делится между обеими сторонами и округляется вверх, где применимо.

Если `depth` опущен или установлен в `0`, эндпоинт возвращает максимально доступную глубину, с ограничением не более 500 уровней на каждую сторону.

Значения, большие или равные `1000` рассматриваются как запрос на максимально доступную глубину.

Отрицательное `depth` значение возвращает `invalid_depth` ошибку.

***

### Пример запроса

```bash
curl -s \\
  'https://dex.bbx.com/fapi/market/v1/public/coingecko/orderbook?ticker_id=BTC-USDT&depth=200'
```

***

### Пример ответа

```json
{
  "ticker_id": "BTC-USDT",
  "timestamp": 1721548812345,
  "bids": [
    ["67249.8", "0.512"],
    ["67249.5", "1.203"]
  ],
  "asks": [
    ["67251.2", "0.877"],
    ["67251.9", "2.014"]
  ]
}
```

> Приведённые выше значения носят иллюстративный характер. В реальных ответах содержатся актуальные рыночные данные BBX.

***

### Поля ответа

| Поле                | Тип         | Требование    | Описание                                                                  |
| ------------------- | ----------- | ------------- | ------------------------------------------------------------------------- |
| `ticker_id`         | строка      | Обязательное  | Идентификатор контракта в `BASE-TARGET` формат                            |
| `timestamp`         | целое число | Рекомендуемое | Время обновления книги ордеров в виде Unix-метки времени в миллисекундах  |
| `заявки на покупку` | массив      | Обязательное  | Уровни заявок на покупку представлены как `[цена, количество]` пары строк |
| `заявки на продажу` | массив      | Обязательное  | Уровни заявок на продажу представлены как `[цена, количество]` пары строк |

***

### Сортировка ордеров

Уровни заявок на покупку сортируются от наибольшей цены к наименьшей.

Уровни заявок на продажу сортируются от наименьшей цены к наибольшей.

Каждый ценовой уровень представлен как:

```json
["цена", "количество"]
```

Например:

```json
["67249.8", "0.512"]
```

В этом примере:

* `67249.8` — это цена
* `0.512` — это доступное количество на данном ценовом уровне

***

### Единица времени метки

Пара `timestamp` поле возвращается в виде Unix-метки времени в миллисекундах.

Пример:

```
1721548812345
```

***

### Пустые книги ордеров

Если данные книги ордеров временно недоступны, включая недавно добавленный контракт, для которого кэш глубины ещё не заполнен, эндпоинт возвращает HTTP `200` с пустыми `заявки на покупку` и `заявки на продажу` массивами.

Пример:

```json
{
  "ticker_id": "BTC-USDT",
  "timestamp": 1721548812345,
  "bids": [],
  "asks": []
}
```

Эндпоинт не возвращает пустое тело ответа в этом случае.

***

### Недопустимые запросы

Неизвестный, отключённый или неподдерживаемый идентификатор контракта возвращает `invalid_symbol` ошибку.

Отрицательное `depth` значение возвращает `invalid_depth` ошибку.

См. раздел **Обработка ошибок** для соответствующего формата ответа с ошибкой.