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

Получить валюту

GET /v1/currencies/:id

Возвращает валюту по коду (RUB, USD, EUR).

Параметры пути

Параметр Тип Обяз. Описание
id (path) string да Код валюты: RUB, USD, EUR. Список: GET /v1/currencies

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies/USD" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies/USD" \
  -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/USD', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Валюта со всеми полями
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 Знаков после запятой
data.dateUpdate datetime Дата последнего изменения
data.lang object Настройки отображения по языкам — формат, название, разделители. Ключ объекта — идентификатор языка, например ru

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

Объект lang сокращён до одного языка.

JSON 
{
  "success": true,
  "data": {
    "id": "USD",
    "fullName": "Доллар США",
    "amount": 92.5,
    "amountCnt": 1,
    "base": false,
    "sort": 200,
    "lid": "ru",
    "formatString": "$#",
    "decimals": 2,
    "decPoint": ".",
    "thousandsSep": ",",
    "dateUpdate": "2024-11-12T07:20:08.000Z",
    "lang": {
      "ru": {
        "FORMAT_STRING": "$#",
        "FULL_NAME": "Доллар США",
        "DEC_POINT": ".",
        "THOUSANDS_SEP": ",",
        "DECIMALS": "2",
        "THOUSANDS_VARIANT": "C",
        "HIDE_ZERO": "Y"
      }
    }
  }
}

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

404 — валюты с таким кодом нет:

JSON 
{
  "success": false,
  "error": { "code": "ENTITY_NOT_FOUND", "message": "Not found" }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Валюта не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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