Skip to main content
GET
/
autoramps
/
quotes-preview
Get autoramp quote preview
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramps/quotes-preview \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.sandbox.iron.xyz/api/autoramps/quotes-preview"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/autoramps/quotes-preview', 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.sandbox.iron.xyz/api/autoramps/quotes-preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.sandbox.iron.xyz/api/autoramps/quotes-preview"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.iron.xyz/api/autoramps/quotes-preview")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/autoramps/quotes-preview")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "amount_in": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "amount_out": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destination_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "fee": {
    "banking_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "iron_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "network_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "network_fees": [
      {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      }
    ],
    "network_fees_with_settlement": [
      {
        "fee_amount": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        }
      }
    ],
    "partner_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "partner_fees": [
      {
        "fee": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        },
        "label": "<string>"
      }
    ],
    "total_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "transaction_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "deducted_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    }
  },
  "fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "<string>",
  "source_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  }
}
"<string>"
"<string>"
"<string>"
"<string>"
{
"message": "<string>",
"trace_id": "<string>"
}

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the quote preview is scoped to the sub-partner

Query Parameters

customer_id
string<uuid>
required

The customer id

source_currency_code
string
required

The source currency code

Maximum string length: 32
source_currency_chain
enum<string>

The source currency chain Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
destination_currency_code
string
required

The destination currency code

Maximum string length: 32
destination_currency_chain
enum<string>

The destination currency chain Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
amount_in
string<decimal>

The source amount. Provide exactly one of amount_in / amount_out.

amount_out
string<decimal>

The destination amount. Provide exactly one of amount_in / amount_out.

fee_profile_id
string<uuid>

Price against this fee profile; resolved automatically when omitted

is_third_party
boolean

Is this a third party autoramp (defaults to false)

Response

Preview successful

Autoramp Quote Preview

A recipient-free pricing preview, shaped like a signed quote but not submittable: no quote_id, signature, or validity window.

amount_in
Amount · object
required

An amount of money

Example:
{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}
amount_out
Amount · object
required

An amount of money

Example:
{
"amount": "100.5",
"currency": { "code": "USD", "type": "Fiat" }
}
customer_id
string<uuid>
required

The customer id

destination_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
{ "blockchain": "Solana", "token": "USDC" }
fee
Fee · object
required

Fee

The fee for a given currency pair

fee_profile_id
string<uuid>
required

The fee profile this preview was priced against

fee_settlement
enum<string>
required

Fee Settlement

The settlement type for the fee

Available options:
deductedImmediately,
settledLater
rate
string<decimal>
required

The rate (destination per 1 source)

source_currency
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
{ "blockchain": "Solana", "token": "USDC" }
assumed_payout_rail
enum<string>

PaymentNetwork

A payment network

Available options:
Sepa,
Swift,
Fps,
Chats,
Ach,
Wire,
Rtp,
Fednow,
Pix,
Spei,
AfricanBankTransfer,
MobileMoney,
Chaps