Skip to main content
GET
/
v1
/
onramp
/
assets
Get on-ramp asset config
curl --request GET \
  --url https://api.hypermid.io/v1/onramp/assets \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "assets": [
      {
        "symbol": "ETH",
        "name": "Ethereum",
        "chainId": 1,
        "address": "0x0000000000000000000000000000000000000000",
        "decimals": 18,
        "logoURI": "https://assets.hypermid.io/tokens/eth.png",
        "minAmountUSD": 20,
        "maxAmountUSD": 10000
      },
      {
        "symbol": "USDC",
        "name": "USD Coin",
        "chainId": 1,
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "decimals": 6,
        "logoURI": "https://assets.hypermid.io/tokens/usdc.png",
        "minAmountUSD": 10,
        "maxAmountUSD": 50000
      },
      {
        "symbol": "ETH",
        "name": "Ethereum",
        "chainId": 42161,
        "address": "0x0000000000000000000000000000000000000000",
        "decimals": 18,
        "logoURI": "https://assets.hypermid.io/tokens/eth.png",
        "minAmountUSD": 20,
        "maxAmountUSD": 10000
      },
      {
        "symbol": "SOL",
        "name": "Solana",
        "chainId": 1151111081099710,
        "address": "So11111111111111111111111111111111111111112",
        "decimals": 9,
        "logoURI": "https://assets.hypermid.io/tokens/sol.png",
        "minAmountUSD": 10,
        "maxAmountUSD": 10000
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "v2e3f4a5-b6c7-8901-5678-012345678901",
    "timestamp": 1711234580,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1978,
      "reset": 1711234627
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypermid.io/llms.txt

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

Returns the list of crypto assets that can be purchased through the fiat on-ramp, along with minimum and maximum purchase amounts. 
{
  "data": {
    "assets": [
      {
        "symbol": "ETH",
        "name": "Ethereum",
        "chainId": 1,
        "address": "0x0000000000000000000000000000000000000000",
        "decimals": 18,
        "logoURI": "https://assets.hypermid.io/tokens/eth.png",
        "minAmountUSD": 20,
        "maxAmountUSD": 10000
      },
      {
        "symbol": "USDC",
        "name": "USD Coin",
        "chainId": 1,
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "decimals": 6,
        "logoURI": "https://assets.hypermid.io/tokens/usdc.png",
        "minAmountUSD": 10,
        "maxAmountUSD": 50000
      },
      {
        "symbol": "ETH",
        "name": "Ethereum",
        "chainId": 42161,
        "address": "0x0000000000000000000000000000000000000000",
        "decimals": 18,
        "logoURI": "https://assets.hypermid.io/tokens/eth.png",
        "minAmountUSD": 20,
        "maxAmountUSD": 10000
      },
      {
        "symbol": "SOL",
        "name": "Solana",
        "chainId": 1151111081099710,
        "address": "So11111111111111111111111111111111111111112",
        "decimals": 9,
        "logoURI": "https://assets.hypermid.io/tokens/sol.png",
        "minAmountUSD": 10,
        "maxAmountUSD": 10000
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "v2e3f4a5-b6c7-8901-5678-012345678901",
    "timestamp": 1711234580,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1978,
      "reset": 1711234627
    }
  }
}

const assets = await client.getOnrampAssets();

// Find ETH on Ethereum
const ethOnMainnet = assets.data.assets.find(
  (a) => a.symbol === "ETH" && a.chainId === 1
);

console.log(`ETH purchase range: $${ethOnMainnet.minAmountUSD} - $${ethOnMainnet.maxAmountUSD}`);

Authorizations

​
X-API-Key
string
header
required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Query Parameters

​
currency
string
required

Crypto token symbol, e.g. 'ETH'

​
chain
string
required

Chain name, e.g. 'ethereum'

​
orderCurrency
string

Fiat currency, e.g. 'USD'

Response

Asset config

​
data
any
required

Response payload (null on error)

​
error
object
required
​
meta
object
required