Skip to main content
GET /v1/fx/route · Escala · One quota unit. Estimates which compatible market would return the most destination currency using its mid rate.

Request

Run these examples on your server. JavaScript and Python use the clients in the quickstart; configure COTIZAVE_API_KEY there.

Response

Illustrative response: figures and dates are not current quotes.
from is the input amount. best and each item in alternatives contain market, type, rate, amount (in the to currency), updated_at and staleness_sec. fetched_at identifies the snapshot. Optional skipped entries explain exclusions. Exclusion reasons: currency_mismatch, not_executable, feature_not_in_plan, one_way_market, no_quote and stale. BCV and parallel are excluded because they are reference rates, not executable markets. Remittances only participate in USD → VES.

What direction does

from and to determine the operation. Both direction values rank output amounts from highest to lowest. USD → VES favours a higher mid; VES → USD favours a lower one. Ties favour the more recent quote. Changing only direction does not reverse the conversion or ranking.

Display options

Display best and alternatives with the destination currency and quote age. Set max_staleness for your use case. Do not silently reintroduce a stale, excluded quote as a valid option.

Errors

  • 400: invalid input or an unknown parameter.
  • 402 feature_not_in_plan: missing access to route; plan information is under details.
  • 422 no_route with field: max_staleness: the age filter left no eligible routes.
  • 503 service_unavailable: no route is available.
The common errors for authentication, quota and availability also apply. API error responses are JSON; branch on code, not on the text of message.

Scope of the estimate

The API does not execute trades, include fees or check liquidity, provider limits or user eligibility. The number of markets can vary. A representative quote is not a binding exchange offer.