> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Список биомаркеров

> Просмотреть каталог биомаркеров

Возвращает постраничный каталог биомаркеров, которые твой API-ключ может заказать для одного источника. Добавляй их к [записям](https://docs.anivahealth.com/ru/api/appointments/add-individual-biomarkers.md) или к [наборам для домашнего теста](https://docs.anivahealth.com/ru/api/home-kit-orders/add-individual-biomarkers.md). Архивные биомаркеры исключены.

Биомаркер попадает в список, если его выполняет заказ в лаборатории, доступной твоему ключу, и забор идёт только в контейнеры, которые есть у этого источника. Решают пробирки для проб, а не тип аналита.

Требуется область доступа `panels_access`. Для объекта `pricing` также требуется область доступа `prices_view`.

## Запрос

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

Источник может быть одного из двух видов: локация для сдачи анализов или набор для домашнего теста. Передай ровно один. Если не передать ни одного или передать оба, вернётся `400`.

> [tab] Локация для сдачи анализов
>
> **location\_id** `string` *required*
>
> Локация, в которой проходит забор крови по записям. Биомаркер попадает в список, если забор по
> его заказу идёт только в контейнеры, которые есть в этой локации. Сопоставляй со [Списком локаций](https://docs.anivahealth.com/ru/api/locations/list-locations.md).

> [tab] Набор для домашнего теста
>
> **home\_kit** `boolean` *required*
>
> Установи значение `true`. Биомаркер попадает в список, если забор по заказу в лаборатории,
> работающей с наборами для домашнего теста, идёт только в контейнеры из набора: капиллярная
> сыворотка и EDTA, сухая капля крови, моча и мазок. Биомаркеры, для которых нужна только
> венозная кровь, исключаются.

**rate\_card** `string`

Переопределяет тарифную карту для `price_cents`: `retail` или `id` тарифной карты, доступной твоему ключу. Этот `id` возвращает [Получить тарифную карту](https://docs.anivahealth.com/ru/api/pricing/get-rate-card.md). По умолчанию используется карта из платёжного аккаунта твоего API-ключа, иначе — розничная.
`retail_cents` всегда использует розничную карту.

**limit** `number`

Максимальное число результатов в ответе (1–1 000). Не указывай параметр, чтобы получить весь
подходящий каталог — он ограничен (максимум несколько тысяч строк). Если параметр не указан,
`pagination.limit` повторяет значение `total`.

**offset** `number` (default: 0)

Смещение пагинации. Должно быть ≥ 0.

## Ответ

**data** `Biomarker[]`

Массив биомаркеров, соответствующих запросу.

**Поля биомаркера**

**id** `number`

Стабильный идентификатор биомаркера — передавай его в [Добавить индивидуальные
биомаркеры](https://docs.anivahealth.com/ru/api/appointments/add-individual-biomarkers.md).

**slug** `string`

Безопасный для URL идентификатор.

**name** `string`

Отображаемое название.

**description** `string | null`

Подробное описание, если доступно.

**primary\_category** `string | null`

Основная категория (например, `Hormones`, `Vitamins`).

**secondary\_category** `string | null`

Дополнительная категория.

**type** `"clinical" | "genetic"`

Является ли биомаркер клиническим показателем или генетическим маркером.

**material** `string | null`

Требуемый материал пробы (например, `serum`, `whole_blood`).

**unit** `object | null`

Единица измерения по умолчанию. Используй `id` для сопоставления со [Списком единиц измерения](https://docs.anivahealth.com/ru/api/units/list-units.md),
если нужен стабильный идентификатор при переименованиях.

**Поля единицы измерения**

**id** `number`

Стабильный идентификатор единицы измерения.

**title** `string`

Каноническое название единицы измерения (например, `nmol/L`).

**display\_title** `string | null`

Человекочитаемое отображаемое название.

**pricing** `object | null`

Сколько стоит этот биомаркер и как он продаётся — см. [объекты цен](#obyekty-tsen). `null`
**только**, если у твоего ключа нет области доступа `prices_view`; биомаркер, для которого
Aniva не установила цену, всё равно возвращается с `pricing.price_cents: null`.

**pagination** `object`

**Поля пагинации**

**total** `number`

Общее число строк, соответствующих запросу, на всех страницах.

**limit** `number`

Ограничение, применённое к этой странице. Повторяет `total`, если параметр запроса `limit` не
был указан (возвращён весь каталог).

**offset** `number`

Смещение, применённое к этой странице.

**has\_more** `boolean`

`true`, если доступны следующие страницы.

## Объекты цен

Ценообразование имеет одинаковую структуру везде, где встречается — в биомаркерах, панелях,
[предпросмотре](https://docs.anivahealth.com/ru/api/appointments/preview-containers.md) записи и [расчёте стоимости](https://docs.anivahealth.com/ru/api/pricing/quote-cart.md). [Ценообразование](https://docs.anivahealth.com/ru/concepts/pricing.md) объясняет
лежащую в основе модель; здесь приведён справочник полей.

Все суммы указаны в центах целым числом.

**price\_cents** `integer | null`

Стоимость по **твоей** тарифной карте. `0` — это реальная нулевая цена: элемент не продаётся
отдельно, а блок `requires` или `positions` рядом показывает, как он продаётся вместо этого.
`null` означает другое: Aniva не установила для него цену, он не стоит ноль, его нельзя заказать,
и он ничего не добавляет к итоговой сумме.

**retail\_cents** `integer | null`

Та же сумма по рекомендованной розничной карте. Присутствует всегда; равна `price_cents`, если
твой ключ уже использует розничную карту.

**tier** `"routine" | "specialty"`

Какой из двух тарифов Aniva в твоей карте определяет цену этого маркера. Присутствует только
тогда, когда у него есть собственная цена.

**positions** `object[]`

Коммерческие предложения, содержащие этот биомаркер, сначала самые дешёвые. При `price_cents: 0`
это единственный способ заказать его; при положительном `price_cents` — комплекты, в которые он
также входит. Позиция оплачивается **один раз** и всегда поставляется целиком.

**id** `string`

Стабильный идентификатор позиции. Связывается с `via_position` в счете за запись.

**name** `string`

Название позиции для партнеров.

**price\_cents** `integer | null`

Стоимость всей позиции по твоему прайс-листу, оплачивается один раз. Рядом указано `retail_cents`.

**biomarker\_ids** `number[]`

Все биомаркеры, которые дает позиция, включая запрошенный.

**includes** `number[]`

Остальные элементы, кроме запрошенного биомаркера — то, что идет в комплекте при покупке.

**requires** `object[]`

Присутствует, если этот биомаркер — **соотношение**. При его заказе эти компоненты попадают в
корзину по своим ценам, причем компонент оплачивается один раз на корзину, сколько бы соотношений
на него ни опиралось. Собственная цена `price_cents` самого соотношения добавляется к стоимости
компонентов. Большинство соотношений стоят `0`. Каждый элемент содержит `id`, `name`,
`price_cents` и `retail_cents`.

Соотношение, у которого указаны цены не на все компоненты, полностью отсутствует в каталоге —
оно никогда не появляется с `price_cents: null`.

Панели содержат только `price_cents` и `retail_cents`: у панели одна цена в каталоге, без
позиций и компонентов.

## Ответы с ошибками

| Статус | Описание |
| - | - |
| `400` | Ошибка валидации — например, не указан источник или указаны два, `limit` вне диапазона либо неизвестный или недоступный `rate_card`. |
| `403` | Доступ запрещен — отсутствует разрешение `panels_access`. |
| `404` | `location_id` не соответствует ни одному пункту сдачи. |
| `500` | Внутренняя ошибка сервера. |

```bash cURL theme={null}
curl --url 'https://anivahealth.com/api/v1/biomarkers?home_kit=true&limit=5' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "data": [
    {
      "id": 42,
      "slug": "vitamin-d-25-oh",
      "name": "Vitamin D (25-OH)",
      "description": "Serum 25-hydroxyvitamin D …",
      "primary_category": "Vitamins",
      "secondary_category": null,
      "type": "clinical",
      "material": "serum",
      "unit": { "id": 1, "title": "nmol/L", "display_title": null },
      "pricing": {
        "price_cents": 3952,
        "retail_cents": 4549,
        "tier": "specialty",
        "positions": [
          {
            "id": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d",
            "name": "Vitamin panel",
            "price_cents": 6900,
            "retail_cents": 7935,
            "biomarker_ids": [42, 43, 44],
            "includes": [43, 44]
          }
        ]
      }
    }
  ],
  "pagination": { "total": 17, "limit": 5, "offset": 0, "has_more": true }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.