Для AI-агентов: markdown этой страницы — /docs-content/entities/currencies/search.md индекс документации — /llms.txt

Поиск валют

POST /v1/currencies/search

Возвращает валюты портала в теле POST-запроса — с выборкой полей, сортировкой и постраничным ограничением.

Фильтрация на стороне сервера для валют не поддерживается: любой ключ в filter возвращает 400 UNSUPPORTED_FILTER. Чтобы отобрать нужные валюты, получите весь справочник и отфильтруйте записи на стороне клиента. Валют на портале единицы, поэтому запрос возвращает тот же справочник, что и список валют — отличается только передачей параметров в теле запроса вместо строки запроса.

Поля запроса (body)

Параметр Тип Обяз. По умолч. Описание
select string[] нет — Выборка полей: ["id", "fullName", "amount"]
sort string нет — Сортировка: "-sort". Допустимые поля — sort, id, fullName. Неизвестное имя возвращает 400 UNKNOWN_SORT_FIELD до вызова Битрикс24
order object нет — Сортировка в объектной форме: { "sort": "asc" }. Те же допустимые поля, что у sort. При передаче обоих параметров приоритет у sort
limit number нет 50 Количество записей
offset number нет 0 Пропустить N записей от начала выборки
filter object нет — Не поддерживается для валют. Любой ключ возвращает 400 UNSUPPORTED_FILTER. Получите весь справочник и отфильтруйте записи на стороне клиента

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/currencies/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "select": ["id", "fullName", "amount", "base"],
    "order": { "sort": "asc" },
    "limit": 3
  }'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/currencies/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "select": ["id", "fullName", "amount", "base"],
    "order": { "sort": "asc" },
    "limit": 3
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    select: ['id', 'fullName', 'amount', 'base'],
    order: { sort: 'asc' },
    limit: 3,
  }),
})

const { success, data, meta } = await res.json()

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    select: ['id', 'fullName', 'amount', 'base'],
    order: { sort: 'asc' },
    limit: 3,
  }),
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив валют (поля — см. Поля)
meta.total number Сколько валют в справочнике
meta.hasMore boolean Есть ли следующая страница
meta.durationMs number Длительность запроса в миллисекундах

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная limit, последней страницы не исключает.

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

JSON 
{
  "success": true,
  "data": [
    { "id": "RUB", "fullName": "руб.", "amount": 1, "base": true },
    { "id": "THB", "fullName": "Бат", "amount": 5, "base": false },
    { "id": "USD", "fullName": "Доллар США", "amount": 1, "base": false }
  ],
  "meta": { "total": 7, "hasMore": true, "durationMs": 148 }
}

Пример ответа при ошибке

400 — фильтрация не поддерживается:

JSON 
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_FILTER",
    "message": "UNSUPPORTED_FILTER: 'currencies' does not support server-side filtering. Its Bitrix24 method (crm.currency.list) silently ignores every filter key and returns the full list — retrieve all records and filter client-side."
  }
}

Ошибки

HTTP Код Описание
400 UNSUPPORTED_FILTER Передан любой ключ в filter. Валюты не фильтруются на стороне сервера — получите весь справочник и отфильтруйте записи на стороне клиента
400 UNKNOWN_SORT_FIELD Поле в sort или order не входит в список sort, id, fullName. Сообщение перечисляет допустимые имена. Запрос не уходит в Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Смотрите также