Ask for an invitation
Menu

API reference

Rates and assets

GET /v1/assets is the machine-readable network and asset matrix: every asset on the eleven networks, which rails accept it, whether it can be a settlement asset, the confirmations needed and the minimum order. GET /v1/rates gives reference prices. Both work with any key, including a publishable key.

Rates are reference figures, not dealing prices: coin prices come from the market feed (refreshed about every minute), fiat pairs from a daily mid-market table (fiat_table_as_of). The amount a payer must send is fixed only by a payment instruction's quote.

The asset object

JSON

{
  "object": "asset",
  "id": "ethereum:usdc",
  "network": "ethereum",
  "symbol": "USDC",
  "name": "USD Coin",
  "decimals": 6,
  "contract": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "native": false,
  "pay": {
    "orrerie_app": true,
    "relay": true,
    "direct": true,
    "relay_amount_mode": "exact"
  },
  "settle": true,
  "confirmations": [
    {
      "order_value_up_to": null,
      "count": 12,
      "unit": "blocks"
    }
  ],
  "minimum_order": {
    "relay": {
      "amount": "1.00",
      "currency": "USD"
    },
    "direct": {
      "amount": "0.01",
      "currency": "USD"
    }
  }
}

The rate object

JSON

{
  "object": "rate",
  "asset": "bitcoin:btc",
  "currency": "USD",
  "rate": "117043.12",
  "as_of": "2026-10-12T10:59:40.000Z",
  "source": "market_feed",
  "fiat_table_as_of": null
}

Every field

Fields of the asset object

Fields of the asset object
FieldTypeMeaning
objectstringThe type of this object.
idstringUnique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters.
networkstringThe network the asset is on.
symbolstringThe asset's symbol, as payers know it.
namestringThe asset's full name.
decimalsintegerHow many decimal places the asset has.
contractstring or nullThe token's contract or mint address; null for the network's own coin.
nativebooleantrue for the network's own coin.
payobjectThe ways payers can pay with the asset.
pay.orrerie_appbooleantrue when it can be paid with Pay with Orrerie.
pay.relaybooleantrue when it can be paid through Relay.
pay.directbooleantrue when it can be sent straight to the merchant's wallet.
pay.relay_amount_modestring or nullexact or open for a payment through Relay; null when Relay does not take the asset.
settlebooleantrue when the asset can be a settlement asset.
confirmationsarray of objectsHow many confirmations a payment needs, by order value.
confirmations[].order_value_up_toobject or nullThe largest order value this count applies to, in US dollars; null for any value above the last.
confirmations[].countintegerThe confirmations needed.
confirmations[].unitstringWhat is counted: blocks or slots.
minimum_orderobjectThe smallest order the asset can pay, by rail.
minimum_order.relayobject or nullThrough Relay, in US dollars; null when Relay does not take the asset.
minimum_order.directobject or nullSent directly, in US dollars; null when the asset cannot be paid directly.
minimum_direct_amountstring or nullOn Bitcoin, Litecoin and Dogecoin, the smallest amount of the coin a payment sent directly may be (the figure the rule is written in; minimum_order.direct is its value in US dollars at today's price, rounded up). For example 0.00005880 on Bitcoin, 0.00058800 on Litecoin and 0.20000000 on Dogecoin. Null on the other networks and when the asset cannot be paid directly.

Fields of the rate object

Fields of the rate object
FieldTypeMeaning
objectstringThe type of this object.
assetstringThe asset priced.
currencystringThe currency it is priced in.
ratestringOne unit of the asset in the currency, a decimal string.
as_ofstring (date-time)When the price was read.
sourcestringWhere the figure comes from: market_feed for coin prices.
fiat_table_as_ofstring or nullWhen the daily fiat table used for a currency other than US dollars was published; null for US dollars.

Endpoints