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

TypeScript

const response: Promise<FireblocksResponse<QuotesResponse>> = fireblocks.trading.createQuote(tradingApiCreateQuoteRequest);

curl --request POST \
  --url https://api.fireblocks.io/v1/trading/quotes \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
    }
  })
};

fetch('https://api.fireblocks.io/v1/trading/quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/trading/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/trading/quotes"

	payload := strings.NewReader("{\n  \"scope\": [\n    {\n      \"providerId\": \"prov_8c3f1a4b2d6e9f7c\",\n      \"accountId\": \"acc_5e9a2d1c4b7f3e8a\"\n    }\n  ],\n  \"baseAssetId\": \"USD\",\n  \"baseAssetRail\": \"FIAT_RAILS\",\n  \"quoteAssetId\": \"BTC\",\n  \"quoteAssetRail\": \"BLOCKCHAIN_RAILS\",\n  \"baseAmount\": \"1000.00\",\n  \"side\": \"BUY\",\n  \"slippageBps\": 100,\n  \"settlement\": {\n    \"type\": \"DVP\",\n    \"sourceAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_3f7e1d9b2c5a8e4f\"\n    },\n    \"destinationAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_7b2e5d8f1c4a9e3b\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/trading/quotes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scope\": [\n    {\n      \"providerId\": \"prov_8c3f1a4b2d6e9f7c\",\n      \"accountId\": \"acc_5e9a2d1c4b7f3e8a\"\n    }\n  ],\n  \"baseAssetId\": \"USD\",\n  \"baseAssetRail\": \"FIAT_RAILS\",\n  \"quoteAssetId\": \"BTC\",\n  \"quoteAssetRail\": \"BLOCKCHAIN_RAILS\",\n  \"baseAmount\": \"1000.00\",\n  \"side\": \"BUY\",\n  \"slippageBps\": 100,\n  \"settlement\": {\n    \"type\": \"DVP\",\n    \"sourceAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_3f7e1d9b2c5a8e4f\"\n    },\n    \"destinationAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_7b2e5d8f1c4a9e3b\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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"
        }
      }
    }
  ]
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "message": "<string>",
  "code": 123
}

Headers

Idempotency-Key

string

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.

Body

application/json

scope

object[]

required

Show child attributes

baseAssetId

string

required

The asset you receive on BUY / give on SELL.

quoteAssetId

string

required

The counter asset used to pay/receive.

baseAmount

string

required

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

Pattern: ^\d+(\.\d+)?$

Example:

"100.00"

baseAssetRail

enum<string>

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)

Available options:

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

Example:

"BLOCKCHAIN"

quoteAssetRail

enum<string>

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)

Available options:

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

Example:

"BLOCKCHAIN"

slippageBps

number

default:50

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

Required range: 1 <= x <= 10000

settlement

object

Source/Destination accounts for the quote (must have for defi quotes)

Show child attributes

Example:

{
  "type": "DVP",
  "sourceAccount": {
    "type": "VAULT_ACCOUNT",
    "id": "vault_acc_3f7e1d9b2c5a8e4f"
  },
  "destinationAccount": {
    "type": "VAULT_ACCOUNT",
    "id": "vault_acc_7b2e5d8f1c4a9e3b"
  }
}

side

enum<string>

default:SELL

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.

Available options:

BUY,

SELL,

BOTH

participantsIdentification

object

KYC/AML participant identification

Show child attributes

Example:

{
  "originator": {
    "externalReferenceId": "user_123456",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "FirstParty",
    "fullName": { "firstName": "John", "lastName": "Smith" },
    "dateOfBirth": "1985-03-15",
    "email": "john.smith@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Main Street",
      "buildingNumber": "123",
      "postalCode": "10001",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  },
  "beneficiary": {
    "externalReferenceId": "user_789012",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "ThirdParty",
    "fullName": {
      "firstName": "Alice",
      "lastName": "Johnson"
    },
    "dateOfBirth": "1990-07-22",
    "email": "alice.johnson@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Broadway",
      "buildingNumber": "456",
      "postalCode": "10002",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  }
}

Response

Quote created

quotes

object[]

required

Show child attributes

quoteFailures

object[]

required

List of partial failures encountered while requesting quotes. Empty when all quote attempts succeed.

Show child attributes

⌘I

TypeScript

const response: Promise<FireblocksResponse<QuotesResponse>> = fireblocks.trading.createQuote(tradingApiCreateQuoteRequest);

curl --request POST \
  --url https://api.fireblocks.io/v1/trading/quotes \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
    }
  })
};

fetch('https://api.fireblocks.io/v1/trading/quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/trading/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/trading/quotes"

	payload := strings.NewReader("{\n  \"scope\": [\n    {\n      \"providerId\": \"prov_8c3f1a4b2d6e9f7c\",\n      \"accountId\": \"acc_5e9a2d1c4b7f3e8a\"\n    }\n  ],\n  \"baseAssetId\": \"USD\",\n  \"baseAssetRail\": \"FIAT_RAILS\",\n  \"quoteAssetId\": \"BTC\",\n  \"quoteAssetRail\": \"BLOCKCHAIN_RAILS\",\n  \"baseAmount\": \"1000.00\",\n  \"side\": \"BUY\",\n  \"slippageBps\": 100,\n  \"settlement\": {\n    \"type\": \"DVP\",\n    \"sourceAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_3f7e1d9b2c5a8e4f\"\n    },\n    \"destinationAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_7b2e5d8f1c4a9e3b\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/trading/quotes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scope\": [\n    {\n      \"providerId\": \"prov_8c3f1a4b2d6e9f7c\",\n      \"accountId\": \"acc_5e9a2d1c4b7f3e8a\"\n    }\n  ],\n  \"baseAssetId\": \"USD\",\n  \"baseAssetRail\": \"FIAT_RAILS\",\n  \"quoteAssetId\": \"BTC\",\n  \"quoteAssetRail\": \"BLOCKCHAIN_RAILS\",\n  \"baseAmount\": \"1000.00\",\n  \"side\": \"BUY\",\n  \"slippageBps\": 100,\n  \"settlement\": {\n    \"type\": \"DVP\",\n    \"sourceAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_3f7e1d9b2c5a8e4f\"\n    },\n    \"destinationAccount\": {\n      \"type\": \"VAULT_ACCOUNT\",\n      \"id\": \"vault_acc_7b2e5d8f1c4a9e3b\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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"
        }
      }
    }
  ]
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Create a quote

Headers

Body

Response