Skip to main content
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>'
{
  "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",
  "slippage_tolerance_in_bips": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API Key

Path Parameters

​
autoramp_id
string<uuid>
required

Query Parameters

​
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

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

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" }
}
​
autoramp_id
string<uuid>
required

The autoramp this quote is for

​
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_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

Example:
{ "blockchain": "Solana", "token": "USDC" }
​
valid_until
string<date-time>
required

The valid until

​
slippage_tolerance_in_bips
string<decimal>

The slippage tolerance in bips