#Список валют

GET /v1/currencies

Возвращает список валют портала с курсами обмена. Обычно содержит менее 10 записей.

#Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей
offset number 0 Пропустить N записей
select string — Выборка полей: ?select=id,fullName,amount
order object — Сортировка: ?order[sort]=asc
filter object — Фильтрация по полям GET /v1/currencies/fields.
Синтаксис фильтрации. Пример: ?filter[base]=true

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies?select=id,fullName,amount,base" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies?select=id,fullName,amount,base" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies?select=id,fullName,amount,base', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, meta } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies?select=id,fullName,amount,base', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data, meta } = await res.json()

#Поля ответа

Поле Тип Описание
data[].id string Код валюты (RUB, USD, EUR)
data[].amountCnt number Количество единиц для курса
data[].amount number Курс обмена
data[].sort number Сортировка
data[].base boolean Базовая валюта
data[].fullName string Название (руб., $)
data[].LID string Язык
data[].formatString string Формат отображения
data[].decPoint string Разделитель дробной части
data[].thousandsSep string Разделитель тысяч
data[].decimals number Знаков после запятой

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": "RUB",
      "fullName": "Российский рубль",
      "amount": 1,
      "amountCnt": 1,
      "base": true,
      "sort": 100,
      "formatString": "# руб.",
      "decimals": 2,
      "decPoint": ".",
      "thousandsSep": " "
    },
    {
      "id": "USD",
      "fullName": "Доллар США",
      "amount": 92.5,
      "amountCnt": 1,
      "base": false,
      "sort": 200
    }
  ],
  "meta": { "total": 3, "hasMore": false }
}

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

JSON 
{
  "success": false,
  "error": { "code": "SCOPE_DENIED", "message": "This endpoint requires 'crm' scope" }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

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

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