Get a rate quote for an existing autoramp

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/quote \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/quote', 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/{autoramp_id}/quote",
  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/{autoramp_id}/quote"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/quote")

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"
    }
  },
  "autoramp_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"
          }
        },
        "fee_type": "SepaIn",
        "settlement": "deductedImmediately"
      }
    ],
    "partner_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "partner_fees": [
      {
        "fee": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        },
        "label": "<string>",
        "settlement": "deductedImmediately"
      }
    ],
    "total_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "transaction_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "banking_fee_network": "Sepa",
    "deducted_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "iron_fee_settlement": "deductedImmediately"
  },
  "fee_settlement": "deductedImmediately",
  "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "<string>",
  "rate_expiry_policy": "Return",
  "rate_lock_valid_until": "2023-11-07T05:31:56Z",
  "signature": "<string>",
  "source_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "valid_until": "2023-11-07T05:31:56Z",
  "customer_fees": {
    "banking_fee": {
      "amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "rail": "Sepa"
    },
    "network_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "total": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "transaction_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    }
  },
  "fee_profile": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiced_fees": {
    "banking_fee": {
      "amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "rail": "Sepa"
    },
    "network_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "platform_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "total": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    }
  },
  "iron_fee_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_reference": "<string>",
  "slippage_tolerance_in_bips": "<string>"
}

"<string>"

"<string>"

"<string>"

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

GET

autoramps

{autoramp_id}

quote

Get a rate quote for an existing autoramp

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/quote \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/quote', 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/{autoramp_id}/quote",
  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/{autoramp_id}/quote"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/quote")

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"
    }
  },
  "autoramp_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"
          }
        },
        "fee_type": "SepaIn",
        "settlement": "deductedImmediately"
      }
    ],
    "partner_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "partner_fees": [
      {
        "fee": {
          "amount": "100.5",
          "currency": {
            "code": "USD",
            "type": "Fiat"
          }
        },
        "label": "<string>",
        "settlement": "deductedImmediately"
      }
    ],
    "total_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "transaction_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "banking_fee_network": "Sepa",
    "deducted_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "iron_fee_settlement": "deductedImmediately"
  },
  "fee_settlement": "deductedImmediately",
  "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "<string>",
  "rate_expiry_policy": "Return",
  "rate_lock_valid_until": "2023-11-07T05:31:56Z",
  "signature": "<string>",
  "source_currency": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "valid_until": "2023-11-07T05:31:56Z",
  "customer_fees": {
    "banking_fee": {
      "amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "rail": "Sepa"
    },
    "network_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "total": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "transaction_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    }
  },
  "fee_profile": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "fee_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiced_fees": {
    "banking_fee": {
      "amount": {
        "amount": "100.5",
        "currency": {
          "code": "USD",
          "type": "Fiat"
        }
      },
      "rail": "Sepa"
    },
    "network_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "platform_fee": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    },
    "total": {
      "amount": "100.5",
      "currency": {
        "code": "USD",
        "type": "Fiat"
      }
    }
  },
  "iron_fee_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_reference": "<string>",
  "slippage_tolerance_in_bips": "<string>"
}

"<string>"

"<string>"

"<string>"

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

Authorizations

X-API-Key

string

header

required

API Key

Headers

X-API-Version

string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15.

Path Parameters

autoramp_id

string<uuid>

required

Query Parameters

source_currency_code

string

required

The source currency code — must be one of the autoramp's input currencies

Maximum string length: 32

source_currency_chain

enum<string>

The source currency chain (required for crypto source currencies) Blockchain

A type of blockchain

Available options:

Solana,

Ethereum,

Polygon,

Arbitrum,

Base,

Stellar,

Citrea,

Plasma,

Avalanche,

Moca,

Monad,

Tempo,

Tron,

Bsc,

Seismic,

Arc,

Optimism,

ZeroG

amount_in

string<decimal>

amount_out

string<decimal>

rate_lock_duration_minutes

integer<int64>

rate_expiry_policy

enum<string>

required

Rate Expiry Policy

The policy for the rate expiry

Available options:

Return,

Slippage

slippage_tolerance_in_bips

string<decimal>

expiry_in_hours

integer<int64>

required

Required range: x <= 24

payment_reference

string

An optional payout reference applied when paying out transactions matched to this quote. Overrides the autoramp's payment reference.

Required string length: 1 - 140

Pattern: ^[A-Za-z0-9 /\-?:().+]*$

Response

Get rate quote successful

Signed rate quote for an existing autoramp.

Contains only pricing fields — the autoramp's currencies, recipient, etc. are already known.

Deposits are matched to the newest active quote whose amount_in value and currency equal the deposit. Attaching a quote that overlaps an existing one on those fields supersedes it for new deposits; all of the newer quote's terms apply (rate lock, expiry policy, slippage tolerance, fees).

amount_in

Amount · object

required

An amount of money

Show child attributes

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

amount_out

Amount · object

required

An amount of money

Show child attributes

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

autoramp_id

string<uuid>

required

The autoramp this quote is for

destination_currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

Example:

{ "blockchain": "Solana", "token": "USDC" }

fee

Fee · object

required

Fee

The fee for a given currency pair

Show child attributes

fee_settlement

enum<string>

required

Fee Settlement

The settlement type for the fee

Available options:

deductedImmediately,

settledLater

quote_id

string<uuid>

required

The id of the quote

rate

string<decimal>

required

The rate

rate_expiry_policy

enum<string>

required

Rate Expiry Policy

The policy for the rate expiry

Available options:

Return,

Slippage

rate_lock_valid_until

string<date-time>

required

The rate lock valid until

signature

string

required

The signature

source_currency

Crypto · object

required

Currency

Can be either crypto or fiat

Crypto
Fiat

Show child attributes

Example:

{ "blockchain": "Solana", "token": "USDC" }

valid_until

string<date-time>

required

The valid until

customer_fees

QuoteCustomerFees · object

What the customer actually pays on this quote/transaction, right now.

Show child attributes

fee_profile

FeeProfileRef · object

A reference to the fee profile used to price a quote, autoramp, or transaction.

Show child attributes

fee_profile_id

string<uuid>

The id of the fee profile this quote was priced against. Unlike fee_profile, this is part of the signed contract (see SignedAutorampRateQuoteSignable) — attach_quote_to_autoramp persists this one as the quote's fee_profile_id, not fee_profile.id, so a partner can't repoint the record at an arbitrary fee profile by editing the unsigned fee_profile field before re-POSTing.

invoiced_fees

QuoteInvoicedFees · object

What Iron will invoice the partner separately for this quote/transaction.

Show child attributes

iron_fee_config_id

string<uuid>

The id of the iron fee config this quote was priced against, resolved from the quote's own source_currency at the time this quote was issued. Part of the signed contract (see SignedAutorampRateQuoteSignable) so a partner can't repoint it at a cheaper config by editing the response before re-POSTing. Repricing on rate-lock expiry uses this id rather than re-resolving by rule. None for a quote issued before this field existed: such a quote verifies against SignedAutorampRateQuoteSignableLegacy instead, which never commits to this field, so repricing falls back to the autoramp's own frozen config (see resolve_iron_fee_config_for_autoramp) rather than trusting any value sent back for it.

payment_reference

string

An optional payout reference used when paying out transactions matched to this quote. Overrides the autoramp's payment reference.

Required string length: 1 - 140

Pattern: ^[A-Za-z0-9 /\-?:().+]*$

slippage_tolerance_in_bips

string<decimal>

The slippage tolerance in bips