V3 Reference
This page describes version 1 of available REST API (we recommend to refer to the latest version which can be found at the last API Reference section).
Here is the list of endpoint that exposed by V1 Ramp API and their details.
Get available assets and price list
GET https://rampapi.fanbase.io/v3/host-api/assets
This endpoint returns the list of all existing available assets and their detail metadata including price
Query Parameters
Name
Type
Description
currencyCode
String
Sets the fiat currency that will be used in minPurchaseAmount, maxPurchaseAmount, minFeeAmount, networkFee properties. If no value is provided, EUR is used as a default setting.
userIp
String
String representing an IP address.
withDisabled
Boolean
Boolean parameter - if it's true, assets with enabled: false will be returned. Use this param to receive assets that are temporarily disabled, for example due to maintenance.
withHidden
Boolean
Boolean parameter - if it's true, assets with hidden: true will be returned.
{
"data": {
"minFeePercent": 0.99,
"maxFeePercent": 3.9,
"currencyCode": "EUR",
"assets": [
{
"symbol": "ARBITRUM_ETH",
"type": "ARBITRUM",
"apiV3Symbol": "ETH",
"apiV3Type": "ETH",
"chain": "ARBITRUM",
"name": "Ethereum",
"decimals": 18,
"address": null,
"logoUrl": "https://assets.ramp.network/crypto-assets/arbitrum-eth.svg",
"enabled": true,
"hidden": false,
"priceEur": 2750.07361133435,
"priceUpdateTs": "2024-02-21T06:15:01.578Z",
"price": {
"BWP": 40719.44618910404,
"KES": 434224.855664711,
"MZN": 188865.92538205357,
"UYU": 116190.87408594298,
"MXN": 50691.30385623157,
"ZAR": 56135.685086209625,
"PYG": 21692464.730602633,
"RON": 13680.769193716102,
"GBP": 2354.1372632897096,
"CHF": 2619.3406119987376,
"USD": 2974.14410903865,
"LAK": 61979755.90144539,
"MDL": 53199.38199006294,
"KWD": 915.053993288169,
"ILS": 10923.746146365907,
"PLN": 11868.146175160626,
"DOP": 174122.87700426645,
"HUF": 1066318.8304503355,
"GEL": 7866.758819859422,
"EUR": 2750.07361133435,
"BMD": 2974.14410903865,
"LKR": 926505.4758104763,
"DKK": 20500.838996807226,
"HKD": 23256.775765080936,
"RSD": 322296.16116470564,
"MKD": 169501.60655652886,
"NGN": 4777364.389410641,
"BGN": 5378.475715882435,
"CRC": 1527480.8853941762,
"ISK": 408055.27068234497,
"MYR": 14253.593026515377,
"KZT": 1346489.0175273463,
"BAM": 5379.93050482283,
"TJS": 32496.335580761523,
"COP": 11654604.716537552,
"PEN": 11285.804337592519,
"BRL": 14656.297305717511,
"THB": 106627.57560473612,
"SGD": 3995.496697625725,
"CZK": 69811.23464021142,
"HNL": 73315.90919998063,
"GTQ": 23169.405926448846,
"INR": 246544.00575362172,
"NZD": 4803.883585751069,
"SEK": 30775.147009635693
},
"minPurchaseAmountEur": 3.13,
"maxPurchaseAmountEur": -1,
"minPurchaseCryptoAmount": "19",
"networkFeeEur": 1.24,
"networkParamsUpdatedAt": "2024-02-21T06:16:02.232Z"
},
{
"symbol": "DOGE",
"type": "DOGE",
"apiV3Symbol": "DOGE",
"apiV3Type": "NATIVE",
"chain": "DOGE",
"name": "Dogecoin",
"decimals": 8,
"address": null,
"logoUrl": "https://assets.ramp.network/crypto-assets/doge.svg",
"enabled": true,
"hidden": false,
"priceEur": 0.07844897064014208,
"priceUpdateTs": "2024-02-21T06:15:01.578Z",
"price": {
"BWP": 1.1615684123531258,
"KES": 12.386756780933066,
"MZN": 5.387614852982433,
"UYU": 3.3144765406471843,
"MXN": 1.4460269687103122,
"ZAR": 1.6013341217639554,
"PYG": 618.8021737853283,
"RON": 0.3902594666517497,
"GBP": 0.0671544369901689,
"CHF": 0.074719663473851,
"USD": 0.08484083586995958,
"LAK": 1768.0428738183753,
"MDL": 1.5175727437300042,
"KWD": 0.026102953592859596,
"ILS": 0.31161225546279997,
"PLN": 0.3385523380213605,
"DOP": 4.9670526670946025,
"HUF": 30.41795473337923,
"GEL": 0.22440822280127676,
"EUR": 0.07844897064014208,
"BMD": 0.08484083586995958,
"LKR": 26.429620127339266,
"DKK": 0.5848096974315059,
"HKD": 0.6634259212770526,
"RSD": 9.193863749840741,
"MKD": 4.835225683198408,
"NGN": 136.2797407231186,
"BGN": 0.15342712347225237,
"CRC": 43.57312569299705,
"ISK": 11.64023967117824,
"MYR": 0.4065999165422674,
"KZT": 38.41012726638397,
"BAM": 0.15346862297772096,
"TJS": 0.9269948503852701,
"COP": 332.4608255800457,
"PEN": 0.32194037624345717,
"BRL": 0.418087513108986,
"THB": 3.0416725987152096,
"SGD": 0.11397607752497256,
"CZK": 1.99144469226943,
"HNL": 2.091419511310433,
"GTQ": 0.6609335974798153,
"INR": 7.032947550623736,
"NZD": 0.137036230893613,
"SEK": 0.8778959931307244
},
"minPurchaseAmountEur": 0.95,
"maxPurchaseAmountEur": -1,
"minPurchaseCryptoAmount": "1200000002",
"networkFeeEur": 0.37,
"networkParamsUpdatedAt": "2024-02-21T06:16:02.232Z"
}
]
},
"success": true
}Get available assets and price list
GET https://rampapi.fanbase.io/v3/host-api/offramp/assets
This endpoint returns the list of all existing available assets and their detail metadata including price
Query Parameters
Name
Type
Description
currencyCode
String
Sets the fiat currency that will be used in minPurchaseAmount, maxPurchaseAmount, minFeeAmount, networkFee properties. If no value is provided, EUR is used as a default setting.
userIp
String
String representing an IP address.
withDisabled
Boolean
Boolean parameter - if it's true, assets with enabled: false will be returned. Use this param to receive assets that are temporarily disabled, for example due to maintenance.
withHidden
Boolean
Boolean parameter - if it's true, assets with hidden: true will be returned.
{
"data": {
"assets": [
{
"symbol": "BTC",
"name": "Bitcoin",
"decimals": 8,
"type": "NATIVE",
"chain": "BTC",
"address": null,
"logoUrl": "https://assets.ramp.network/crypto-assets/btc.svg",
"price": {
"BWP": 707987.4847876112,
"UYU": 2020206.3708464769,
"GBP": 40940.37917544058,
"PYG": 377166071.4814668,
"CHF": 45556.402491057204,
"MXN": 881360.0207409852,
"LAK": 1077639693.484714,
"ZAR": 975488.2481557517,
"MZN": 3283732.94327398,
"RON": 238037.71086598677,
"USD": 51711.37129298696,
"KES": 7575777.334575419,
"MDL": 924975.6414483922,
"CRC": 26558252.909219235,
"ISK": 7103068.565359583,
"MYR": 247901.37853118422,
"KZT": 23411354.050185114,
"BAM": 93540.61178415318,
"TJS": 565012.5900060332,
"COP": 202638175.52856436,
"PEN": 196225.83337636004,
"BRL": 254823.045822581,
"THB": 1853205.5781384953,
"SGD": 69462.57702117076,
"CZK": 1213541.313080951,
"HNL": 1274740.9668157692,
"GTQ": 402845.5995282944,
"INR": 4287085.747655168,
"SEK": 535357.5400157814,
"NZD": 83541.00568816993,
"KWD": 15910.53623715682,
"UAH": 1987396.420427735,
"ILS": 189902.20908289237,
"DOP": 3027467.955180299,
"PLN": 206181.52973291284,
"HUF": 18538009.951618113,
"GEL": 136776.6380556997,
"EUR": 47831.96016389431,
"LKR": 16109115.976956764,
"CAD": 69899.23498550695,
"BMD": 51711.37129298696,
"DKK": 356588.3153249557,
"RSD": 5605974.370071248,
"HKD": 404398.03362737375,
"MKD": 2947118.106546423,
"NGN": 83063833.2404316,
"BGN": 93531.09322408057
},
"enabled": true,
"hidden": false,
"currencyCode": "EUR",
"minPurchaseAmount": -1,
"maxPurchaseAmount": -1,
"minPurchaseCryptoAmount": "-1"
},
{
"symbol": "BNB",
"name": "Binance Coin",
"decimals": 18,
"type": "NATIVE",
"chain": "BSC",
"address": null,
"logoUrl": "https://assets.ramp.network/crypto-assets/bsc-bnb.svg",
"price": {
"BWP": 4977.806109077043,
"UYU": 14203.917202593926,
"GBP": 287.84868934310975,
"PYG": 2651825.936330291,
"CHF": 320.3035978744541,
"MXN": 6196.7752111562695,
"LAK": 7576802.648173011,
"ZAR": 6858.583612476216,
"MZN": 23087.676345734166,
"RON": 1673.6250241695773,
"USD": 363.57871496584687,
"KES": 53264.7137235339,
"MDL": 6503.433320054408,
"CRC": 186729.054423305,
"ISK": 49941.13435274492,
"MYR": 1742.9757206390987,
"KZT": 164603.44810718932,
"BAM": 657.6769205541042,
"TJS": 3972.560508016893,
"COP": 1424733.5860476566,
"PEN": 1379.648896523363,
"BRL": 1791.6414364440182,
"THB": 13029.747342215842,
"SGD": 488.3860911071701,
"CZK": 8532.316589867269,
"HNL": 8962.606696373836,
"GTQ": 2832.376743140189,
"INR": 30142.17353180598,
"SEK": 3764.0581090645383,
"NZD": 587.3704513262169,
"KWD": 111.86576907326256,
"UAH": 13973.23293889974,
"ILS": 1335.187975510085,
"DOP": 21285.896722951766,
"PLN": 1449.6466397160004,
"HUF": 130339.33673979886,
"GEL": 961.666129870825,
"EUR": 336.3028706423954,
"LKR": 113261.96810665596,
"CAD": 491.4562000132645,
"BMD": 363.57871496584687,
"DKK": 2507.1452993022117,
"RSD": 39415.17903390811,
"HKD": 2843.291789109758,
"MKD": 20720.963053943327,
"NGN": 584015.4881715396,
"BGN": 657.6099962828464
},
"enabled": true,
"hidden": false,
"currencyCode": "EUR",
"minPurchaseAmount": -1,
"maxPurchaseAmount": -1,
"minPurchaseCryptoAmount": "-1"
},
]
},
"success": true
}Get service available currencies list
GET https://rampapi.fanbase.io/v1/host-api/currencies
This endpoint returns the list of currencies
{
"data": [
{
"fiatCurrency": "BWP",
"name": "Botswana Pula",
"onrampAvailable": true,
"offrampAvailable": false
},
{
"fiatCurrency": "UYU",
"name": "Uruguayan Peso",
"onrampAvailable": true,
"offrampAvailable": false
},
]
"success": true
}Get sale transaction
GET https://rampapi.fanbase.io/v1/host-api/offramp/sale/{id}
This endpoint returns Ramp Sale content
Path Parameters
Name
Type
Description
id*
String
Id of the purchase, received from a SDK event or a webhook call.
Query Parameters
Name
Type
Description
secret*
String
The purchaseViewToken received with the same purchase created event.
{
"id": "0ca7d027-5697-4e68-bc78-5794e314c69b",
"purchaseViewToken": "4eb9ndrsb59erawh",
"createdAt": "2019-10-24T14:41:39.372Z",
"crypto": {
"amount": "30000000000000000",
"assetInfo": {
"address": null,
"symbol": "ETH",
"chain": "ETH",
"type": "NATIVE",
"name": "Ether",
"decimals": 18
}
},
"fiat": {
"amount": 100.23,
"currencySymbol": "USD"
}
}Get On-ramp purchase quotation
POST https://stakingapi.fanbase.io/v1/host-api/onramp/quote/all
This endpoint returns a subset of the On-amp Purchase object.
Request Body
Name
Type
Description
cryptoAssetSymbol*
String
Cryptocuurrecy symbol
fiatCurrency*
String
Fiat currency symbol
cryptoAmount
String
Cryptocurrency amount
fiatValue
String
Fiat currency amount
{
"data": {
"CARD_PAYMENT": {
"fiatCurrency": "USD",
"cryptoAmount": "10",
"fiatValue": 2.76,
"baseRampFee": 2.69195145,
"appliedFee": 2.75681775
},
"GOOGLE_PAY": {
"fiatCurrency": "USD",
"cryptoAmount": "10",
"fiatValue": 2.76,
"baseRampFee": 2.69195145,
"appliedFee": 2.75681775
},
"APPLE_PAY": {
"fiatCurrency": "USD",
"cryptoAmount": "10",
"fiatValue": 2.76,
"baseRampFee": 2.69195145,
"appliedFee": 2.75681775
},
"asset": {
"symbol": "BNB",
"type": "NATIVE",
"chain": "BSC",
"name": "Binance Coin",
"decimals": 18,
"address": null,
"logoUrl": "https://assets.ramp.network/crypto-assets/bsc-bnb.svg",
"enabled": true,
"hidden": false,
"price": {
"BWP": 4972.689018390465,
"UYU": 14189.315843915494,
"GBP": 287.55278632577534,
"PYG": 2649099.9093409153,
"CHF": 319.97433182398015,
"MXN": 6190.40504324997,
"LAK": 7569013.838119862,
"ZAR": 6851.533118029974,
"MZN": 23063.9426504044,
"RON": 1671.9045692469988,
"USD": 363.2049629121465,
"KES": 53209.958603598454,
"MDL": 6496.74791340264,
"CRC": 186537.10048127407,
"ISK": 49889.79580964507,
"MYR": 1741.1839745100658,
"KZT": 164434.238870664,
"BAM": 657.0008410983761,
"TJS": 3968.4767908266285,
"COP": 1423268.9868237686,
"PEN": 1378.2306435089931,
"BRL": 1789.7996628780697,
"THB": 13016.353007982587,
"SGD": 487.88403942747493,
"CZK": 8523.545529524576,
"HNL": 8953.393305926616,
"GTQ": 2829.465113330668,
"INR": 30111.187946575657,
"SEK": 3760.1887284033446,
"NZD": 586.7666455932914,
"KWD": 111.75077317496353,
"UAH": 13958.868719288484,
"ILS": 1333.8154274829822,
"DOP": 21264.01522305207,
"PLN": 1448.1564303433627,
"HUF": 130205.35036276626,
"GEL": 960.6775552480035,
"EUR": 335.9571576416227,
"LKR": 113145.53694211437,
"CAD": 490.9509923195853,
"BMD": 363.2049629121465,
"DKK": 2504.5680012757653,
"RSD": 39374.6609741194,
"HKD": 2840.3689388390844,
"MKD": 20699.662295187994,
"NGN": 583415.1312773869,
"BGN": 656.9339856240053
},
"minPurchaseCryptoAmount": "1200000000000000",
"currencyCode": "USD",
"minPurchaseAmount": 0.2,
"maxPurchaseAmount": -1,
"networkFee": 0.07
}
},
"success": true
}Get Off-ramp purchase quotation
POST https://stakingapi.fanbase.io/v1/host-api/offramp/quote/all
This endpoint returns a subset of the Off-amp Purchase object.
Request Body
Name
Type
Description
cryptoAssetSymbol*
String
Cryptocuurrecy symbol
fiatCurrency*
String
Fiat currency symbol
cryptoAmount
String
Cryptocurrency amount
fiatValue
String
Fiat currency amount
{
"data": {
"asset": {
"symbol": "BNB",
"name": "Binance Coin",
"decimals": 18,
"type": "NATIVE",
"chain": "BSC",
"address": null,
"logoUrl": "https://assets.ramp.network/crypto-assets/bsc-bnb.svg",
"price": {
"BWP": 4972.689018390465,
"UYU": 14189.315843915494,
"GBP": 287.55278632577534,
"PYG": 2649099.9093409153,
"CHF": 319.97433182398015,
"MXN": 6190.40504324997,
"LAK": 7569013.838119862,
"ZAR": 6851.533118029974,
"MZN": 23063.9426504044,
"RON": 1671.9045692469988,
"USD": 363.2049629121465,
"KES": 53209.958603598454,
"MDL": 6496.74791340264,
"CRC": 186537.10048127407,
"ISK": 49889.79580964507,
"MYR": 1741.1839745100658,
"KZT": 164434.238870664,
"BAM": 657.0008410983761,
"TJS": 3968.4767908266285,
"COP": 1423268.9868237686,
"PEN": 1378.2306435089931,
"BRL": 1789.7996628780697,
"THB": 13016.353007982587,
"SGD": 487.88403942747493,
"CZK": 8523.545529524576,
"HNL": 8953.393305926616,
"GTQ": 2829.465113330668,
"INR": 30111.187946575657,
"SEK": 3760.1887284033446,
"NZD": 586.7666455932914,
"KWD": 111.75077317496353,
"UAH": 13958.868719288484,
"ILS": 1333.8154274829822,
"DOP": 21264.01522305207,
"PLN": 1448.1564303433627,
"HUF": 130205.35036276626,
"GEL": 960.6775552480035,
"EUR": 335.9571576416227,
"LKR": 113145.53694211437,
"CAD": 490.9509923195853,
"BMD": 363.2049629121465,
"DKK": 2504.5680012757653,
"RSD": 39374.6609741194,
"HKD": 2840.3689388390844,
"MKD": 20699.662295187994,
"NGN": 583415.1312773869,
"BGN": 656.9339856240053
},
"enabled": true,
"hidden": false,
"currencyCode": "USD",
"minPurchaseAmount": -1,
"maxPurchaseAmount": -1,
"minPurchaseCryptoAmount": "-1"
},
"CARD": {
"fiatCurrency": "USD",
"cryptoAmount": "10",
"fiatValue": -1.08,
"baseRampFee": 1.09,
"appliedFee": 1.09,
"hostFeeCut": 0
},
"AMERICAN_BANK_TRANSFER": {
"fiatCurrency": "USD",
"cryptoAmount": "10",
"fiatValue": -3.98,
"baseRampFee": 3.99,
"appliedFee": 3.99,
"hostFeeCut": 0
}
},
"success": true
}Last updated