FIfireblocks
Trading

Create a quote

Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations.

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

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

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

post/trading/quotes

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 asset you receive on BUY / give on SELL.

baseAssetRail'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET'

Transfer rail:

  • BLOCKCHAIN - Transfer over the public blockchain
  • INTERNAL - Internal transfer within the same account (e.g. sub-accounts or same api key)
  • SWIFT - International wire transfer
  • IBAN - International Bank Account Number transfer
  • US_WIRE - Domestic wire transfer within the United States (e.g. FedWire)
  • ACH - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers
  • SEPA - Euro transfers within the SEPA zone
  • SPEI - Mexican interbank electronic payment system
  • PIX - Brazilian instant payment system
  • LBT - Local bank transfers
  • MOMO - Mobile money transfers (e.g. M-Pesa)
  • CHAPS - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom
  • PAYID - PayID payment identifier system (Australia)
  • INTERAC - Interac electronic funds transfer (Canada)
  • INTERNAL_TRANSFER - Internal transfer between accounts
  • CIPS - Cross-Border Interbank Payment System (China)
  • NEQUI - Nequi mobile payment (Colombia)
  • FPS_UK - UK Faster Payments (GBP)
  • FPS_HK - Hong Kong Faster Payment System (HKD)
  • INSTA_PAY - InstaPay instant payment (Philippines)
  • PESONET - PesoNet batch payment (Philippines)
quoteAssetIdstring required

The counter asset used to pay/receive.

quoteAssetRail'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET'

Transfer rail:

  • BLOCKCHAIN - Transfer over the public blockchain
  • INTERNAL - Internal transfer within the same account (e.g. sub-accounts or same api key)
  • SWIFT - International wire transfer
  • IBAN - International Bank Account Number transfer
  • US_WIRE - Domestic wire transfer within the United States (e.g. FedWire)
  • ACH - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers
  • SEPA - Euro transfers within the SEPA zone
  • SPEI - Mexican interbank electronic payment system
  • PIX - Brazilian instant payment system
  • LBT - Local bank transfers
  • MOMO - Mobile money transfers (e.g. M-Pesa)
  • CHAPS - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom
  • PAYID - PayID payment identifier system (Australia)
  • INTERAC - Interac electronic funds transfer (Canada)
  • INTERNAL_TRANSFER - Internal transfer between accounts
  • CIPS - Cross-Border Interbank Payment System (China)
  • NEQUI - Nequi mobile payment (Colombia)
  • FPS_UK - UK Faster Payments (GBP)
  • FPS_HK - Hong Kong Faster Payment System (HKD)
  • INSTA_PAY - InstaPay instant payment (Philippines)
  • PESONET - PesoNet batch payment (Philippines)
baseAmountstring required

Amount in baseAssetId. BUY = base amount to receive; SELL = base amount to sell.

slippageBpsnumber

Slippage tolerance in basis points (bps) for defi quotes - 1 is 0.01% and 10000 is 100%

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": "USD",
  "baseAssetRail": "FIAT_RAILS",
  "quoteAssetId": "BTC",
  "quoteAssetRail": "BLOCKCHAIN_RAILS",
  "baseAmount": "1000.00",
  "side": "BUY",
  "slippageBps": 100,
  "settlement": {
    "type": "DVP",
    "sourceAccount": {
      "type": "VAULT_ACCOUNT",
      "id": "vault_acc_3f7e1d9b2c5a8e4f"
    },
    "destinationAccount": {
      "type": "VAULT_ACCOUNT",
      "id": "vault_acc_7b2e5d8f1c4a9e3b"
    }
  }
}

Response

Quote created

Example response

{
  "quotes": [
    {
      "via": {
        "type": "PROVIDER_ACCOUNT",
        "providerId": "bridge-provider-001",
        "accountId": "acc_9f4e2d8b1c6a5e73"
      },
      "id": "quote_8f2e4d1a9c5b7e3f",
      "type": "COMMITTED",
      "baseAssetId": "USDC",
      "quoteAssetId": "BTC",
      "baseAmount": "1000.00",
      "quoteAmount": "0.02458",
      "priceImpact": 0.005,
      "quoteMinAmount": "0.02450",
      "expiresAt": "2024-01-15T10:35:00.000Z",
      "executionSteps": [
        {
          "type": "EXECUTE",
          "fee": {
            "feeType": "ORDER",
            "assetId": "USDC",
            "amountType": "FIXED",
            "amount": "2.50"
          }
        }
      ],
      "generalFees": [
        {
          "feeType": "ORDER",
          "assetId": "USDC",
          "amountType": "FIXED",
          "amount": "2.50"
        }
      ]
    }
  ],
  "quoteFailures": [
    {
      "providerId": "BRIDGE",
      "accountId": "acc_9f4e2d8b1c6a5e73",
      "error": {
        "code": 3107,
        "message": "This trading pair is not supported by the provider."
      }
    },
    {
      "providerId": "UNISWAP",
      "error": {
        "code": 3101,
        "message": "Provider not found.",
        "descriptor": {
          "providerId": "UNISWAP"
        }
      }
    }
  ]
}

Changes

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