Trading

Get rates

Retrieve indicative exchange rate from specified providers for a given asset pair. Rates are non-executable price signals intended for discovery and display purposes.

If side is omitted it defaults to SELL. Use side: BOTH to get rates for each side the provider supports in a single call; providers that support only one side return that side only. Every returned rate carries a concrete BUY or SELL side, never BOTH.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

For detailed information about error codes and troubleshooting, please refer to our API Error Codes documentation.

post/trading/rates

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

baseAssetIdstring required

The source asset identifier.

quoteAssetIdstring required

The target asset identifier.

baseAmountstring

The amount to convert from

side'BUY' | 'SELL' | 'BOTH'

Side to price on a quote, rate or offer request. BUY: receive base / pay quote; SELL: give base / receive quote; BOTH: request pricing for both sides at once. Providers that support only one of the sides return entries for that side only. BOTH is accepted on requests only, never on order execution requests, and responses never return it: every returned quote, rate or offer carries a concrete BUY or SELL. When omitted, defaults to SELL.

Example request

{
  "scope": [
    {
      "providerId": "prov_8c3f1a4b2d6e9f7c",
      "accountId": "acc_5e9a2d1c4b7f3e8a"
    }
  ],
  "baseAssetId": "BTC",
  "quoteAssetId": "USD",
  "baseAmount": "100.00"
}

Response

Rate response

Example response

{
  "rates": [
    {
      "via": {
        "type": "PROVIDER_ACCOUNT",
        "providerId": "bridge-provider-001",
        "accountId": "acc_9f4e2d8b1c6a5e73"
      },
      "baseAssetRail": "BLOCKCHAIN",
      "quoteAssetRail": "BLOCKCHAIN",
      "rate": "1.2345"
    }
  ],
  "errors": [
    {
      "providerId": "BRIDGE",
      "accountId": "acc_9f4e2d8b1c6a5e73",
      "error": {
        "code": 900,
        "message": "Invalid base amount: must be greater than 0"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.