Skip to main content
GET
/
exchange-rate
Get exchange rate
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/exchange-rate \
  --header 'X-API-Key: <api-key>'
{
  "effective_rate": "<string>",
  "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"
  },
  "from": {
    "blockchain": "Solana",
    "token": "USDC"
  },
  "out_amount": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "to": {
    "blockchain": "Solana",
    "token": "USDC"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.iron.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API Key

Query Parameters

​
customer_id
string<uuid>

customer id

​
source_currency_code
string
required

source currency code

Maximum string length: 32
​
source_currency_type
enum<string>
required

source currency type Currency Type

The type of currency

Available options:
fiat,
crypto
​
source_currency_chain
enum<string>

source currency chain Blockchain

A type of blockchain

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

destination currency code

Maximum string length: 32
​
destination_currency_type
enum<string>
required

destination currency type Currency Type

The type of currency

Available options:
fiat,
crypto
​
destination_currency_chain
enum<string>

destination currency chain Blockchain

A type of blockchain

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

amount

​
_partner_fee_in_bips
integer<uint64>

partner fee in bips

Response

The exchange rate response

Exchange Rate

The exchange rate for a given currency pair

​
effective_rate
string<decimal>
required

The effective rate

​
fee
Fee · object
required

Fee

The fee for a given currency pair

​
from
Crypto · object
required

Currency

Can be either crypto or fiat

Example:
{ "blockchain": "Solana", "token": "USDC" }
​
out_amount
Amount · object
required

An amount of money

Example:
{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}
​
to
Crypto · object
required

Currency

Can be either crypto or fiat

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