ImportOS · Документація
Довідник API

GET /v1/fx

Exchange rate

Exchange rate

NBU official rate for any pair with UAH, ECB for the rest, cross rates otherwise. Requires scope read:pricing.

  • Автентифікація: заголовок Authorization: Bearer rv_live_... (API-ключі та scopes)
  • Потрібний scope: read:pricing
Опис операції, параметрів і полів походить зі специфікації OpenAPI (openapi.json) і подається англійською, як у самому API.

Параметри

ПолеДеТипОбов’язк.Опис
basequerystringтакISO-4217 base currency, e.g. EUR.
quotequerystringтакISO-4217 quote currency, e.g. UAH.
datequerystringніRate date (yyyy-mm-dd). Default: latest. Weekends/holidays return the previous working day (stale: true).

Відповіді

200

Exchange rate.

application/json · Схема: FxResponse

ПолеТипОбов’язк.Опис
basestringтак
quotestringтак
ratenumberтак1 base = rate quote.
requested_datestringтак
effective_datestringтак
stalebooleanтакtrue if effective_date differs from requested_date.
sourcestringтакnbu | ecb | nbu-cross | identity | mock.
mode"live" | "test" | "mock"так

400

Invalid request parameters or body (code validation_error).

application/problem+json · Схема: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Схема: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Схема: Problem

422

Date in the future or no rate for the pair.

application/problem+json · Схема: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Схема: Problem

502

Rate provider unavailable.

application/problem+json · Схема: Problem

Приклад

curl -s "https://api.importos.app/v1/fx?base=EUR&quote=UAH" \
  -H "Authorization: Bearer $IMPORTOS_API_KEY"

На цій сторінці