Ask for an invitation
Menu

Endpoint

List assets

GET/v1/assets

Returns every asset on the eleven networks: which rails accept it, whether it can be a settlement asset, the confirmations needed and the minimum order. Filter by network, rail or settle. Any key may call it, a publishable key too.

Scope a restricted key needs
any key
Publishable key
Allowed
Idempotency-Key
Not used. A GET is already safe to repeat.

Parameters

Parameters of List assets
ParameterType and placeMeaning
networkstringqueryOnly assets on this network.
railstringqueryOnly assets payable on this rail.
settlebooleanqueryOnly assets that can be a settlement asset.
Orrerie-VersionstringheaderAPI version date. Default: the version the key was created with. Example 2026-10-11.

Example request

curl

curl https://api.orrerie.com/v1/assets \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/assets", {
  headers: {
    Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
  },
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);

Python

import os
import requests

response = requests.get(
    "https://api.orrerie.com/v1/assets",
    headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
    timeout=30,
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)

PHP

<?php
$request = curl_init('https://api.orrerie.com/v1/assets');
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
    ],
]);
$body = curl_exec($request);
if ($body === false) {
    throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
    throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);

Responses

200 OK

A list whose data holds asset objects. Headers: Orrerie-Request-Id.

Example response, 200

{
  "object": "list",
  "url": "/v1/assets",
  "has_more": false,
  "data": [
    {
      "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"
        }
      }
    },
    {
      "object": "asset",
      "id": "bitcoin:btc",
      "network": "bitcoin",
      "symbol": "BTC",
      "name": "Bitcoin",
      "decimals": 8,
      "contract": null,
      "native": true,
      "pay": {
        "orrerie_app": true,
        "relay": true,
        "direct": true,
        "relay_amount_mode": "open"
      },
      "settle": false,
      "confirmations": [
        {
          "order_value_up_to": {
            "amount": "1000.00",
            "currency": "USD"
          },
          "count": 1,
          "unit": "blocks"
        },
        {
          "order_value_up_to": {
            "amount": "10000.00",
            "currency": "USD"
          },
          "count": 2,
          "unit": "blocks"
        },
        {
          "order_value_up_to": null,
          "count": 6,
          "unit": "blocks"
        }
      ],
      "minimum_order": {
        "relay": {
          "amount": "1.00",
          "currency": "USD"
        },
        "direct": {
          "amount": "0.50",
          "currency": "USD"
        }
      }
    },
    {
      "object": "asset",
      "id": "dogecoin:doge",
      "network": "dogecoin",
      "symbol": "DOGE",
      "name": "Dogecoin",
      "decimals": 8,
      "contract": null,
      "native": true,
      "pay": {
        "orrerie_app": true,
        "relay": false,
        "direct": true,
        "relay_amount_mode": null
      },
      "settle": false,
      "confirmations": [
        {
          "order_value_up_to": {
            "amount": "1000.00",
            "currency": "USD"
          },
          "count": 6,
          "unit": "blocks"
        },
        {
          "order_value_up_to": null,
          "count": 20,
          "unit": "blocks"
        }
      ],
      "minimum_order": {
        "relay": null,
        "direct": {
          "amount": "0.50",
          "currency": "USD"
        }
      }
    }
  ]
}

Any other status: an error

A status of 400 or above answers with the error object. Branch on its code, never on its message.

Errors

This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.