# API Общего индекса ATI.SU FTL РФ

API предоставляет текущее значение Общего индекса ATI.SU и его ежедневную историю для выбранного типа кузова: открытый, закрытый, рефрижератор и все типы.

Информация актуальна для полностью загруженных автомобилей 20 т, 82 м³. При расчёте учтены ставки участников ATI.SU, а также параметры реальных сделок на Бирже.

Также у нас есть API Индекса ATI.SU по направлениям — [информация об API Индекса по направлениям](https://ati.su/developers/raw/paid-api/index-by-directions.md).

## Что такое Общий индекс ATI.SU

Общий индекс ATI.SU — это аналитический инструмент. Он показывает, как меняются средние ставки на грузоперевозки по России в условных единицах.

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

До 1 августа 2025 года Индекс считался понедельно, с 1 августа — ежедневно. 

[Подробнее](https://help.ati.su/price-index)

## Методы

### Текущее состояние общего индекса

<a id="post-license-v1-current_index"></a>

Текущее состояние общего индекса

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/index/license/v1/current_index' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "CarType": "all"
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/index_ati.openapi.json)

**Описание полей запроса**
- `CarType` — Тип кузова. * `ref` - Рефрижераторы. * `close` - Закрытые. * `open` - Открытые. * `all` - Все типы.

**Пример ответа (200)**

```json
{
  "Index": 0,
  "IndexMovingUp": false,
  "CarType": "string",
  "Dynamic": {
    "day": {
      "Delta": 0.5
    },
    "week": {
      "Delta": 0.5
    },
    "month": {
      "Delta": 0.5
    },
    "3m": {
      "Delta": 0.5
    },
    "6m": {
      "Delta": 0.5
    },
    "ytd": {
      "Delta": 0.5
    },
    "1y": {
      "Delta": 0.5
    },
    "3y": {
      "Delta": 0.5
    },
    "alltime": {
      "Delta": 0.5
    }
  }
}
```

**Описание полей ответа**
- `Index` — Текущее значение индекса
- `IndexMovingUp` — Параметр, который показывает, был ли рост индекса по отношению к предыдущему значению
- `CarType` — Тип кузова. * `ref` - Рефрижераторы. * `close` - Закрытые. * `open` - Открытые. * `all` - Все типы.
- `Dynamic.day` — Динамика индекса за день. Значение указано в процентах.
- `Dynamic.day.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.week` — Динамика индекса за неделю. Значение указано в процентах.
- `Dynamic.week.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.month` — Динамика индекса за месяц. Значение указано в процентах.
- `Dynamic.month.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.3m` — Динамика индекса за три месяца. Значение указано в процентах.
- `Dynamic.3m.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.6m` — Динамика индекса за шесть месяцев. Значение указано в процентах.
- `Dynamic.6m.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.ytd` — Динамика индекса с начала года. Значение указано в процентах.
- `Dynamic.ytd.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.1y` — Динамика индекса за год. Значение указано в процентах.
- `Dynamic.1y.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.3y` — Динамика индекса за три года. Значение указано в процентах.
- `Dynamic.3y.Delta` — Дельта индекса, значение указано в процентах
- `Dynamic.alltime` — Динамика индекса за все время. Значение указано в процентах.
- `Dynamic.alltime.Delta` — Дельта индекса, значение указано в процентах

**Пример ответа (400)**

```json
{
  "error_body": "string",
  "reason": "string",
  "status_code": 0,
  "details": {}
}
```

**Описание полей ответа**
- `error_body` — основное тело ошибки с описанием
- `reason` — тип ошибки если имеется
- `status_code` — код возвращаемой ошибки
- `details` — какие-либо дополнительные детали ошибки


### Динамика общего индекса

<a id="post-license-v1-general_index_dynamic"></a>

Динамика общего индекса

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/index/license/v1/general_index_dynamic' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "CarType": "all",
  "DateFrom": "2022-02-01",
  "DateTo": "2022-03-02"
}'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/index_ati.openapi.json)

**Описание полей запроса**
- `CarType` — Тип кузова. * `ref` - Рефрижераторы. * `close` - Закрытые. * `open` - Открытые. * `all` - Все типы.
- `DateFrom` — Начало периода. Формат ISO-8601.
- `DateTo` — Конец периода. Формат ISO-8601.

**Пример ответа (200)**

```json
{
  "CarType": "string",
  "Data": [
    {
      "Date": "1970-01-01",
      "Index": 0
    }
  ]
}
```

**Описание полей ответа**
- `CarType` — Тип кузова. * `ref` - Рефрижераторы. * `close` - Закрытые. * `open` - Открытые. * `all` - Все типы.
- `Data` — Набор данных индекса
- `Data[].Date` — Дата, Формат ISO-8601
- `Data[].Index` — Значение индекса

**Пример ответа (400)**

```json
{
  "error_body": "string",
  "reason": "string",
  "status_code": 0,
  "details": {}
}
```

**Описание полей ответа**
- `error_body` — основное тело ошибки с описанием
- `reason` — тип ошибки если имеется
- `status_code` — код возвращаемой ошибки
- `details` — какие-либо дополнительные детали ошибки