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

GET /v1/currencies/:id

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

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

Параметр Тип Описание
id string Код валюты (RUB, USD, EUR)

#Примеры

#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()

#Поля ответа

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

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

JSON 
{
  "success": true,
  "data": {
    "id": "USD",
    "fullName": "Доллар США",
    "amount": 92.5,
    "amountCnt": 1,
    "base": false,
    "sort": 200,
    "formatString": "$#",
    "decimals": 2,
    "decPoint": ".",
    "thousandsSep": ","
  }
}

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

JSON 
{
  "success": false,
  "error": { "code": "NOT_FOUND", "message": "Currency not found" }
}

#Ошибки

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

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

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