-
-
-
GET
-
GET
-
GET
-
GET
-
GET
-
GET
-
-
GET
-
POST
-
GET
-
GET
-
POST
-
GET
-
-
API Documentation
CCXT - CryptoCurrency eXchange Trading Library
CCXT is our authorized SDK provider and you may access our API through CCXT. For more information, please visit https://ccxt.trade.
Web Socket
Web Socket provide public updates of orderbook, trade history and rates.
The base URI is wss://api.exchange.ripio.com/ws/v1/
Topics:
There are three kinds of topics: orderbook
, trades
and rate
which has to be concatenated with the pair. E.g.: For the pair BTC/USDC the orderbook topic is [email protected]_USDC
, trade
history topic is [email protected]_USDC
and rate topic is [email protected]_USDC
.
import socketio
sio = socketio.Client()
@sio.on('connect', namespace='/ws/v1/')
def on_connect():
print('connection established')
msg = {
"method": "SUBSCRIBE",
"params": [
"[email protected]_USDC",
"[email protected]_USDC",
"[email protected]_USDC"
]
}
sio.emit('message', msg)
@sio.on('message', namespace='/ws/v1/')
def on_message(data):
print('message received with ', data)
@sio.on('disconnect', namespace='/ws/v1/')
def on_disconnect():
print('disconnected from server')
sio.connect('wss://api.exchange.ripio.com/ws/v1/')
sio.wait()
Orderbook
updated_id
are for the continuity of the updates of the orderbook.
Updates of the order book with amount 0 means that the level must be deleted.
{
"message": "Orderbook update",
"sendType": "PAIR",
"params": {
"eventType": "orderbook",
"pair": "BTC_USDC"
},
"data": {
"buy": [{
"amount": "37.30170",
"total": "5556.83",
"price": "148.97"
}],
"sell": [{
"amount": "0.00000",
"total": "0.00",
"price": "148.97"
}],
"updated_id": 417691
}
}
Trades
{
"message": "New trade",
"sendType": "PAIR",
"params": {
"eventType": "trades",
"pair": "BTC_USDC"
},
"data": {
"created_at": 1601923119,
"amount": "0.00444",
"price": "10701.860000",
"side": "BUY",
"pair": "BTC_USDC",
"taker_fee": "0",
"taker_side": "BUY",
"maker_fee": "0"
}
}
Rates
{
"message": "Rate update",
"sendType": "PAIR",
"params": {
"eventType": "rate",
"pair": "BTC_USDC"
},
"data": {
"pair": "BTC_USDC",
"last_price": "10699.85",
"low": "10550.00",
"high": "10848.10",
"variation": "1.01",
"volume": "0.47474"
}
}
Web Socket Authentication:
For receive updates of your orders fills you should provide your API token at the moment of connect to the web socker; wss://api.exchange.ripio.com/ws/v1/?token={{API-token}}
If the token is in valid you will receive an error messages:
{
"result": "ERROR",
"message": "Unauthorized"
}
Otherwise If the token is valid you will receive a messages notifying you about a new fill in your orders in any pair.
{
"message": "Order update",
"sendType": "USER",
"params": {
"eventType": "order",
"pair": "BTC_USDC",
"user_channel": "15ab668a44d74383b53cead4aacc464f"
},
"data": {
"order_id": "b658df61-17d4-4cca-a039-a1a7ecb72888",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00001",
"notional": "1500000",
"fill_or_kill": False,
"all_or_none": False,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1605660080,
"filled": "0.00000",
"fills": [],
"filled_at": None,
"limit_price": "1500.00",
"fee": Decimal("0.00"),
"fill_price": None
}
}
Public
This end-points do not need authentication.
GET List of Currencies
List of available currencies
Headers
Content-Type | application/json |
Response
raw (application/json){
"next": null,
"previous": null,
"results": [
{
"name": "Argentine Peso",
"symbol": "$",
"decimal_places": 2,
"currency": "ARS",
"country": "AR",
"enabled": true
},
{
"name": "Bitcoin Cash",
"symbol": "BCH",
"decimal_places": 8,
"currency": "BCH",
"country": "AR",
"enabled": true
},
{
"name": "Bitcoin",
"symbol": "BTC",
"decimal_places": 8,
"currency": "BTC",
"country": "AR",
"enabled": true
},
{
"name": "DAI",
"symbol": "DAI",
"decimal_places": 18,
"currency": "DAI",
"country": "AR",
"enabled": true
},
{
"name": "Ether",
"symbol": "ETH",
"decimal_places": 18,
"currency": "ETH",
"country": "AR",
"enabled": true
},
{
"name": "Mike Tango Bravo 18",
"symbol": "MTB18",
"decimal_places": 18,
"currency": "MTB18",
"country": "AR",
"enabled": true
},
{
"name": "RCN",
"symbol": "RCN",
"decimal_places": 18,
"currency": "RCN",
"country": "AR",
"enabled": true
},
{
"name": "USD Coin",
"symbol": "USDC",
"decimal_places": 6,
"currency": "USDC",
"country": "AR",
"enabled": true
},
{
"name": "ZCash",
"symbol": "ZEC",
"decimal_places": 8,
"currency": "ZEC",
"country": "AR",
"enabled": true
},
{
"name": "DAI",
"symbol": "DAI",
"decimal_places": 18,
"currency": "DAI",
"country": "ZZ",
"enabled": true
},
{
"name": "USD Coin",
"symbol": "USDC",
"decimal_places": 6,
"currency": "USDC",
"country": "ZZ",
"enabled": true
}
]
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/currency/" \
--header "Content-Type: application/json" \
{
"next": null,
"previous": null,
"results": [
{
"name": "Argentine Peso",
"symbol": "$",
"decimal_places": 2,
"currency": "ARS",
"country": "AR",
"enabled": true
},
{
"name": "Bitcoin Cash",
"symbol": "BCH",
"decimal_places": 8,
"currency": "BCH",
"country": "AR",
"enabled": true
},
{
"name": "Bitcoin",
"symbol": "BTC",
"decimal_places": 8,
"currency": "BTC",
"country": "AR",
"enabled": true
},
{
"name": "DAI",
"symbol": "DAI",
"decimal_places": 18,
"currency": "DAI",
"country": "AR",
"enabled": true
},
{
"name": "Ether",
"symbol": "ETH",
"decimal_places": 18,
"currency": "ETH",
"country": "AR",
"enabled": true
},
{
"name": "Mike Tango Bravo 18",
"symbol": "MTB18",
"decimal_places": 18,
"currency": "MTB18",
"country": "AR",
"enabled": true
},
{
"name": "RCN",
"symbol": "RCN",
"decimal_places": 18,
"currency": "RCN",
"country": "AR",
"enabled": true
},
{
"name": "USD Coin",
"symbol": "USDC",
"decimal_places": 6,
"currency": "USDC",
"country": "AR",
"enabled": true
},
{
"name": "ZCash",
"symbol": "ZEC",
"decimal_places": 8,
"currency": "ZEC",
"country": "AR",
"enabled": true
},
{
"name": "DAI",
"symbol": "DAI",
"decimal_places": 18,
"currency": "DAI",
"country": "ZZ",
"enabled": true
},
{
"name": "USD Coin",
"symbol": "USDC",
"decimal_places": 6,
"currency": "USDC",
"country": "ZZ",
"enabled": true
}
]
}
GET List of Pairs
List all available pairs and theirs fees
Headers
Content-Type | application/json |
Response
raw (application/json){
"next": null,
"previous": null,
"results": [
{
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"symbol": "BTC_ARS",
"country": "AR",
"enabled": true,
"priority": 0,
"taker_fee": 0.0,
"maker_fee": 0.0,
"cancellation_fee": 0.0,
"min_amount": "0.00001",
"price_tick": "0.01",
"min_value": "100"
},
{
"base": "ETH",
"base_name": "Ether",
"quote": "ARS",
"quote_name": "Argentine Peso",
"symbol": "ETH_ARS",
"country": "AR",
"enabled": true,
"priority": 0,
"taker_fee": 0.0,
"maker_fee": 0.0,
"cancellation_fee": 0.0,
"min_amount": "0.00001",
"price_tick": "0.01",
"min_value": "100"
}
]
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/pair/" \
--header "Content-Type: application/json" \
{
"next": null,
"previous": null,
"results": [
{
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"symbol": "BTC_ARS",
"country": "AR",
"enabled": true,
"priority": 0,
"taker_fee": 0.0,
"maker_fee": 0.0,
"cancellation_fee": 0.0,
"min_amount": "0.00001",
"price_tick": "0.01",
"min_value": "100"
},
{
"base": "ETH",
"base_name": "Ether",
"quote": "ARS",
"quote_name": "Argentine Peso",
"symbol": "ETH_ARS",
"country": "AR",
"enabled": true,
"priority": 0,
"taker_fee": 0.0,
"maker_fee": 0.0,
"cancellation_fee": 0.0,
"min_amount": "0.00001",
"price_tick": "0.01",
"min_value": "100"
}
]
}
GET All Rates
List all rates for all the availables pairs
Headers
Content-Type | application/json |
Response
raw (application/json)[
{
"last_price": "618290.41",
"low": "550000.00",
"high": "640000.03",
"variation": "6.60",
"volume": "2.85738",
"pair": "BTC_ARS",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"bid": "580000.01",
"ask": "588326.27",
"avg": "610901.39",
"ask_volume": "0.00320",
"bid_volume": "0.00210",
"created_at": "2020-01-07 17:53:03.221650+00:00"
},
{
"last_price": "32166.49",
"low": "30126.63",
"high": "32824.70",
"variation": "6.19",
"volume": "8.53806",
"pair": "BTC_BRL",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "BRL",
"quote_name": "Brazilian Real",
"bid": "30289.89",
"ask": "30205.70",
"avg": "31583.87",
"ask_volume": "0.00272",
"bid_volume": "0.00291",
"created_at": "2020-01-07 17:53:03.309171+00:00"
},
{
"last_price": "7200.00",
"low": "7200.00",
"high": "8400.00",
"variation": "-6.27",
"volume": "0.02052",
"pair": "BTC_USDC",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "USDC",
"quote_name": "USD Coin",
"bid": "7681.69",
"ask": "8400.00",
"avg": "7760.56",
"ask_volume": "0.00315",
"bid_volume": "0.00270",
"created_at": "2020-01-07 17:53:03.485787+00:00"
}
]
curl --location --request GET "https://api.exchange.ripio.com/api/v1/rate/all/" \
--header "Content-Type: application/json" \
[
{
"last_price": "618290.41",
"low": "550000.00",
"high": "640000.03",
"variation": "6.60",
"volume": "2.85738",
"pair": "BTC_ARS",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"bid": "580000.01",
"ask": "588326.27",
"avg": "610901.39",
"ask_volume": "0.00320",
"bid_volume": "0.00210",
"created_at": "2020-01-07 17:53:03.221650+00:00"
},
{
"last_price": "32166.49",
"low": "30126.63",
"high": "32824.70",
"variation": "6.19",
"volume": "8.53806",
"pair": "BTC_BRL",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "BRL",
"quote_name": "Brazilian Real",
"bid": "30289.89",
"ask": "30205.70",
"avg": "31583.87",
"ask_volume": "0.00272",
"bid_volume": "0.00291",
"created_at": "2020-01-07 17:53:03.309171+00:00"
},
{
"last_price": "7200.00",
"low": "7200.00",
"high": "8400.00",
"variation": "-6.27",
"volume": "0.02052",
"pair": "BTC_USDC",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "USDC",
"quote_name": "USD Coin",
"bid": "7681.69",
"ask": "8400.00",
"avg": "7760.56",
"ask_volume": "0.00315",
"bid_volume": "0.00270",
"created_at": "2020-01-07 17:53:03.485787+00:00"
}
]
GET Rate per Pair
Rate per Pair
Headers
Content-Type | application/json |
Response
raw (application/json){
"last_price": "618677.89",
"low": "550000.00",
"high": "640000.03",
"variation": "6.66",
"volume": "2.87748",
"pair": "BTC_ARS",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"bid": "580000.01",
"ask": "588326.27",
"avg": "610960.60",
"ask_volume": "0.00320",
"bid_volume": "0.00210",
"created_at": "2020-01-07 18:03:32.502568+00:00"
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/rate/{{pair}}/" \
--header "Content-Type: application/json" \
{
"last_price": "618677.89",
"low": "550000.00",
"high": "640000.03",
"variation": "6.66",
"volume": "2.87748",
"pair": "BTC_ARS",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"bid": "580000.01",
"ask": "588326.27",
"avg": "610960.60",
"ask_volume": "0.00320",
"bid_volume": "0.00210",
"created_at": "2020-01-07 18:03:32.502568+00:00"
}
GET Rates per Country
Rates per Country
Headers
Content-Type | application/json |
Response
raw (application/json)[
{
"last_price": "618290.41",
"low": "550000.00",
"high": "640000.03",
"variation": "6.60",
"volume": "2.85738",
"pair": "BTC_ARS",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"bid": "580000.01",
"ask": "588326.27",
"avg": "610901.39",
"ask_volume": "0.00320",
"bid_volume": "0.00210",
"created_at": "2020-01-07 17:53:03.221650+00:00"
},
{
"last_price": "32166.49",
"low": "30126.63",
"high": "32824.70",
"variation": "6.19",
"volume": "8.53806",
"pair": "BTC_BRL",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "BRL",
"quote_name": "Brazilian Real",
"bid": "30289.89",
"ask": "30205.70",
"avg": "31583.87",
"ask_volume": "0.00272",
"bid_volume": "0.00291",
"created_at": "2020-01-07 17:53:03.309171+00:00"
},
{
"last_price": "7200.00",
"low": "7200.00",
"high": "8400.00",
"variation": "-6.27",
"volume": "0.02052",
"pair": "BTC_USDC",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "USDC",
"quote_name": "USD Coin",
"bid": "7681.69",
"ask": "8400.00",
"avg": "7760.56",
"ask_volume": "0.00315",
"bid_volume": "0.00270",
"created_at": "2020-01-07 17:53:03.485787+00:00"
}
]
curl --location --request GET "https://api.exchange.ripio.com/api/v1/rate/all/?country={{country_code}}" \
--header "Content-Type: application/json" \
[
{
"last_price": "618290.41",
"low": "550000.00",
"high": "640000.03",
"variation": "6.60",
"volume": "2.85738",
"pair": "BTC_ARS",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "ARS",
"quote_name": "Argentine Peso",
"bid": "580000.01",
"ask": "588326.27",
"avg": "610901.39",
"ask_volume": "0.00320",
"bid_volume": "0.00210",
"created_at": "2020-01-07 17:53:03.221650+00:00"
},
{
"last_price": "32166.49",
"low": "30126.63",
"high": "32824.70",
"variation": "6.19",
"volume": "8.53806",
"pair": "BTC_BRL",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "BRL",
"quote_name": "Brazilian Real",
"bid": "30289.89",
"ask": "30205.70",
"avg": "31583.87",
"ask_volume": "0.00272",
"bid_volume": "0.00291",
"created_at": "2020-01-07 17:53:03.309171+00:00"
},
{
"last_price": "7200.00",
"low": "7200.00",
"high": "8400.00",
"variation": "-6.27",
"volume": "0.02052",
"pair": "BTC_USDC",
"base": "BTC",
"base_name": "Bitcoin",
"quote": "USDC",
"quote_name": "USD Coin",
"bid": "7681.69",
"ask": "8400.00",
"avg": "7760.56",
"ask_volume": "0.00315",
"bid_volume": "0.00270",
"created_at": "2020-01-07 17:53:03.485787+00:00"
}
]
GET Order book
Get the pair's order book snapshot. Updates of the order book are received by web socket.
Headers
Content-Type | application/json |
Response
raw (application/json){
"buy": [
{
"amount": "0.00100",
"total": "662.00",
"price": "662000.00"
},
{
"amount": "0.00100",
"total": "661.00",
"price": "661000.00"
}
],
"sell": [
{
"amount": "0.00100",
"total": "665.00",
"price": "665000.00"
},
{
"amount": "0.01000",
"total": "6800.00",
"price": "680000.00"
},
{
"amount": "0.00100",
"total": "681.00",
"price": "681000.00"
}
],
"updated_id": 0
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/orderbook/{{pair}}/" \
--header "Content-Type: application/json" \
{
"buy": [
{
"amount": "0.00100",
"total": "662.00",
"price": "662000.00"
},
{
"amount": "0.00100",
"total": "661.00",
"price": "661000.00"
}
],
"sell": [
{
"amount": "0.00100",
"total": "665.00",
"price": "665000.00"
},
{
"amount": "0.01000",
"total": "6800.00",
"price": "680000.00"
},
{
"amount": "0.00100",
"total": "681.00",
"price": "681000.00"
}
],
"updated_id": 0
}
GET Order book Depth
Get the order book depth for specific amount or all the order book if the amount parameter is not sent
Headers
Content-Type | application/json |
Response
raw (application/json){
"ask": {
"price": 800583.54,
"amount": 0.706,
"quantity": 43
},
"bid": {
"price": 689201.29,
"amount": 0.6495,
"quantity": 28
}
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/orderbook/{{pair}}/depth/?amount=1.4" \
--header "Content-Type: application/json" \
{
"ask": {
"price": 800583.54,
"amount": 0.706,
"quantity": 43
},
"bid": {
"price": 689201.29,
"amount": 0.6495,
"quantity": 28
}
}
GET Trade history
Get pair's last trades
Headers
Content-Type | application/json |
Response
raw (application/json)[
{
"created_at": 1578414028,
"amount": "0.00100",
"price": "665000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "66500000",
"maker_fee": "0",
"taker": 4892,
"maker": 4889
},
{
"created_at": 1578413945,
"amount": "0.00100",
"price": "662000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66200000",
"maker_fee": "0",
"taker": 4891,
"maker": 4817
},
{
"created_at": 1578340155,
"amount": "0.00100",
"price": "663000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66300000",
"maker_fee": "0",
"taker": 4890,
"maker": 4886
},
{
"created_at": 1578340040,
"amount": "0.00100",
"price": "664000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66400000",
"maker_fee": "0",
"taker": 4888,
"maker": 4887
},
{
"created_at": 1578340021,
"amount": "0.01000",
"price": "675000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "67500000",
"maker_fee": "0",
"taker": 4885,
"maker": 4882
},
{
"created_at": 1578332198,
"amount": "0.01000",
"price": "670000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "67000000",
"maker_fee": "0",
"taker": 4884,
"maker": 4881
}
]
curl --location --request GET "https://api.exchange.ripio.com/api/v1/tradehistory/{{pair}}/" \
--header "Content-Type: application/json" \
[
{
"created_at": 1578414028,
"amount": "0.00100",
"price": "665000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "66500000",
"maker_fee": "0",
"taker": 4892,
"maker": 4889
},
{
"created_at": 1578413945,
"amount": "0.00100",
"price": "662000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66200000",
"maker_fee": "0",
"taker": 4891,
"maker": 4817
},
{
"created_at": 1578340155,
"amount": "0.00100",
"price": "663000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66300000",
"maker_fee": "0",
"taker": 4890,
"maker": 4886
},
{
"created_at": 1578340040,
"amount": "0.00100",
"price": "664000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66400000",
"maker_fee": "0",
"taker": 4888,
"maker": 4887
},
{
"created_at": 1578340021,
"amount": "0.01000",
"price": "675000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "67500000",
"maker_fee": "0",
"taker": 4885,
"maker": 4882
},
{
"created_at": 1578332198,
"amount": "0.01000",
"price": "670000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "67000000",
"maker_fee": "0",
"taker": 4884,
"maker": 4881
}
]
Private
This end-points do need authentication.
For this endpoints It is required an authentication API key that can be adquire in the API menu of your account.
GET Account balances
Wallet and exchange balances side to side
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json)[
{
"symbol": "BTC",
"currency": "Bitcoin",
"balance_type": "crypto",
"wallet_available": 0.93745674,
"exchange_available": 0.0
},
{
"symbol": "USDC",
"currency": "USD Coin",
"balance_type": "crypto",
"wallet_available": 4.9e-05,
"exchange_available": 0.0
},
{
"symbol": "BCH",
"currency": "Bitcoin Cash",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "ZEC",
"currency": "ZCash",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "MTB18",
"currency": "Mike Tango Bravo 18",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "LTC",
"currency": "Litecoin",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "ARS",
"currency": "Argentine Peso",
"balance_type": "fiat",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "ETH",
"currency": "Ether",
"balance_type": "crypto",
"wallet_available": 4.5827767853207e-05,
"exchange_available": 0.0
},
{
"symbol": "RCN",
"currency": "RCN",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "DAI",
"currency": "DAI",
"balance_type": "crypto",
"wallet_available": 4.25e-16,
"exchange_available": 0.0
}
]
curl --location --request GET "https://api.exchange.ripio.com/api/v1/balances/balances/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
[
{
"symbol": "BTC",
"currency": "Bitcoin",
"balance_type": "crypto",
"wallet_available": 0.93745674,
"exchange_available": 0.0
},
{
"symbol": "USDC",
"currency": "USD Coin",
"balance_type": "crypto",
"wallet_available": 4.9e-05,
"exchange_available": 0.0
},
{
"symbol": "BCH",
"currency": "Bitcoin Cash",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "ZEC",
"currency": "ZCash",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "MTB18",
"currency": "Mike Tango Bravo 18",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "LTC",
"currency": "Litecoin",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "ARS",
"currency": "Argentine Peso",
"balance_type": "fiat",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "ETH",
"currency": "Ether",
"balance_type": "crypto",
"wallet_available": 4.5827767853207e-05,
"exchange_available": 0.0
},
{
"symbol": "RCN",
"currency": "RCN",
"balance_type": "crypto",
"wallet_available": 0.0,
"exchange_available": 0.0
},
{
"symbol": "DAI",
"currency": "DAI",
"balance_type": "crypto",
"wallet_available": 4.25e-16,
"exchange_available": 0.0
}
]
GET Account's exchange balances
View all the balances the user has for trading.
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json)[
{
"id": 10,
"currency": "Argentine Peso",
"symbol": "ARS",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "fiat"
},
{
"id": 11,
"currency": "Bitcoin",
"symbol": "BTC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 12,
"currency": "Bitcoin Cash",
"symbol": "BCH",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 13,
"currency": "ZCash",
"symbol": "ZEC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 14,
"currency": "Ether",
"symbol": "ETH",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 17,
"currency": "DAI",
"symbol": "DAI",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 18,
"currency": "USD Coin",
"symbol": "USDC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
}
]
curl --location --request GET "https://api.exchange.ripio.com/api/v1/balances/exchange_balances/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
[
{
"id": 10,
"currency": "Argentine Peso",
"symbol": "ARS",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "fiat"
},
{
"id": 11,
"currency": "Bitcoin",
"symbol": "BTC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 12,
"currency": "Bitcoin Cash",
"symbol": "BCH",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 13,
"currency": "ZCash",
"symbol": "ZEC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 14,
"currency": "Ether",
"symbol": "ETH",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 17,
"currency": "DAI",
"symbol": "DAI",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
},
{
"id": 18,
"currency": "USD Coin",
"symbol": "USDC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
}
]
GET Exchange balance details
Exchange balance details
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"id": 11,
"currency": "Bitcoin",
"symbol": "BTC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/balances/exchange_balances/{{balance_id}}" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"id": 11,
"currency": "Bitcoin",
"symbol": "BTC",
"available": "0",
"locked": "0",
"code": "exchange",
"balance_type": "crypto"
}
GET Account's wallet balances
View all the balances the user has stored in the wallet.
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json)[
{
"currency": "Bitcoin",
"amount": 93745674,
"code": null,
"balance_type": "crypto",
"addresses": [
"1CxjiLtSBPAYt3vgFmoXrVTegkeTh2D2Rs",
"1Jn7v4xp8CZpbRscmuPmeCwdVRQNF4qRPs"
],
"id": 178223,
"available": 0.93745674,
"symbol": "BTC"
},
{
"currency": "USD Coin",
"amount": 49,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF32142E5836673b5C07Dd3aB"
],
"id": 832502,
"available": 4.9e-05,
"symbol": "USDC"
},
{
"currency": "Bitcoin Cash",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 998252,
"available": 0.0,
"symbol": "BCH"
},
{
"currency": "ZCash",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 998253,
"available": 0.0,
"symbol": "ZEC"
},
{
"currency": "Mike Tango Bravo 18",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 998254,
"available": 0.0,
"symbol": "MTB18"
},
{
"currency": "Litecoin",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"MAQpqLg1MAsPircreZSRkU7AasG2u7eK87"
],
"id": 1041199,
"available": 0.0,
"symbol": "LTC"
},
{
"currency": "Argentine Peso",
"amount": 0,
"code": null,
"balance_type": "fiat",
"addresses": [],
"id": 14945,
"available": 0.0,
"symbol": "ARS"
},
{
"currency": "Ether",
"amount": 45827767853207,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF33142E5836073b5C07Dd3aB"
],
"id": 338107,
"available": 4.5827767853207e-05,
"symbol": "ETH"
},
{
"currency": "RCN",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 420616,
"available": 0.0,
"symbol": "RCN"
},
{
"currency": "DAI",
"amount": 425,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF33142E5836623b5C07Dd3aB"
],
"id": 425646,
"available": 4.25e-16,
"symbol": "DAI"
}
]
curl --location --request GET "https://api.exchange.ripio.com/api/v1/balances/wallet_balances/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
[
{
"currency": "Bitcoin",
"amount": 93745674,
"code": null,
"balance_type": "crypto",
"addresses": [
"1CxjiLtSBPAYt3vgFmoXrVTegkeTh2D2Rs",
"1Jn7v4xp8CZpbRscmuPmeCwdVRQNF4qRPs"
],
"id": 178223,
"available": 0.93745674,
"symbol": "BTC"
},
{
"currency": "USD Coin",
"amount": 49,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF32142E5836673b5C07Dd3aB"
],
"id": 832502,
"available": 4.9e-05,
"symbol": "USDC"
},
{
"currency": "Bitcoin Cash",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 998252,
"available": 0.0,
"symbol": "BCH"
},
{
"currency": "ZCash",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 998253,
"available": 0.0,
"symbol": "ZEC"
},
{
"currency": "Mike Tango Bravo 18",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 998254,
"available": 0.0,
"symbol": "MTB18"
},
{
"currency": "Litecoin",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"MAQpqLg1MAsPircreZSRkU7AasG2u7eK87"
],
"id": 1041199,
"available": 0.0,
"symbol": "LTC"
},
{
"currency": "Argentine Peso",
"amount": 0,
"code": null,
"balance_type": "fiat",
"addresses": [],
"id": 14945,
"available": 0.0,
"symbol": "ARS"
},
{
"currency": "Ether",
"amount": 45827767853207,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF33142E5836073b5C07Dd3aB"
],
"id": 338107,
"available": 4.5827767853207e-05,
"symbol": "ETH"
},
{
"currency": "RCN",
"amount": 0,
"code": "primary",
"balance_type": "crypto",
"addresses": [],
"id": 420616,
"available": 0.0,
"symbol": "RCN"
},
{
"currency": "DAI",
"amount": 425,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF33142E5836623b5C07Dd3aB"
],
"id": 425646,
"available": 4.25e-16,
"symbol": "DAI"
}
]
GET Wallet balance details
Wallet balance details
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"currency": "DAI",
"amount": 425,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF33142E5836623b5C07Dd3aB"
],
"id": 425646,
"available": 4.25e-16,
"symbol": "DAI"
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/balances/wallet_balances/{{balance_id}}" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"currency": "DAI",
"amount": 425,
"code": "primary",
"balance_type": "crypto",
"addresses": [
"0x65074fB50ACF521DF33142E5836623b5C07Dd3aB"
],
"id": 425646,
"available": 4.25e-16,
"symbol": "DAI"
}
POST Create an order
Create an order
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Body
raw (application/json){
"order_type": "LIMIT",
"amount": "0.04",
"limit_price": "10",
"side": "BUY"
}
Response
raw (application/json){
"order_id": "160f523c-f6ef-4cd1-a7c9-1a8ede1468d8",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00400",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1578413945,
"filled": "0.00000",
"limit_price": "10.00",
"stop_price": null,
"distance": null
}
curl --location --request POST "https://api.exchange.ripio.com/api/v1/order/{{pair}}/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
--data "{
"order_type":"LIMIT",
"amount":"0.04",
"limit_price":"10",
"side":"BUY"
}"
{
"order_id": "160f523c-f6ef-4cd1-a7c9-1a8ede1468d8",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00400",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1578413945,
"filled": "0.00000",
"limit_price": "10.00",
"stop_price": null,
"distance": null
}
GET Order details
Order details
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"order_id": "0b4ff48e-cfd6-42db-8d8c-3b536da447af",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1575472944,
"filled": "0.00000",
"limit_price": "661000.00",
"stop_price": null,
"distance": null
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/order/{{pair}}/{{order_id}}/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"order_id": "0b4ff48e-cfd6-42db-8d8c-3b536da447af",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1575472944,
"filled": "0.00000",
"limit_price": "661000.00",
"stop_price": null,
"distance": null
}
GET User's orders
List all user's orders
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"next": "https://api.exchange.ripio.com/api/v1/order/BTC_ARS/?limit=20&offset=20&page=1&page_size=25",
"previous": null,
"results": {
"data": [
{
"order_id": "ca74280b-6966-4b73-a720-68709078922b",
"pair": "BTC_ARS",
"side": "SELL",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1578340134,
"filled": "0.00000",
"limit_price": "665000.00",
"stop_price": null,
"distance": null
},
{
"order_id": "0b4ff48e-cfd6-42db-8d8c-3b536da447af",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1575472944,
"filled": "0.00000",
"limit_price": "661000.00",
"stop_price": null,
"distance": null
}
]
}
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/order/{{pair}}/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"next": "https://api.exchange.ripio.com/api/v1/order/BTC_ARS/?limit=20&offset=20&page=1&page_size=25",
"previous": null,
"results": {
"data": [
{
"order_id": "ca74280b-6966-4b73-a720-68709078922b",
"pair": "BTC_ARS",
"side": "SELL",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1578340134,
"filled": "0.00000",
"limit_price": "665000.00",
"stop_price": null,
"distance": null
},
{
"order_id": "0b4ff48e-cfd6-42db-8d8c-3b536da447af",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1575472944,
"filled": "0.00000",
"limit_price": "661000.00",
"stop_price": null,
"distance": null
}
]
}
}
GET User's orders filter per status
User's orders filter per status.
Status consist in a 4 letter tag which possibilities are:
- OPEN: Open order available to be fill in the orderbook.
- PART: Partially filled order, the remaining amount to fill remains in the orderbook.
- CLOS: Order was cancelled before be fully filled but the amount already filled amount is traded.
- CANC: Order was cancelled before any fill.
- COMP: Order was fully filled.
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"next": "https://api.exchange.ripio.com/api/v1/order/BTC_ARS/?limit=20&offset=20&page=1&page_size=25&status=OPEN%2CPART",
"previous": null,
"results": {
"data": [
{
"order_id": "ca74280b-6966-4b73-a720-68709078922b",
"pair": "BTC_ARS",
"side": "SELL",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1578340134,
"filled": "0.00000",
"limit_price": "665000.00",
"stop_price": null,
"distance": null
},
{
"order_id": "0b4ff48e-cfd6-42db-8d8c-3b536da447af",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1575472944,
"filled": "0.00000",
"limit_price": "661000.00",
"stop_price": null,
"distance": null
}
]
}
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/order/{{pair}}/?status=OPEN,PART" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"next": "https://api.exchange.ripio.com/api/v1/order/BTC_ARS/?limit=20&offset=20&page=1&page_size=25&status=OPEN%2CPART",
"previous": null,
"results": {
"data": [
{
"order_id": "ca74280b-6966-4b73-a720-68709078922b",
"pair": "BTC_ARS",
"side": "SELL",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1578340134,
"filled": "0.00000",
"limit_price": "665000.00",
"stop_price": null,
"distance": null
},
{
"order_id": "0b4ff48e-cfd6-42db-8d8c-3b536da447af",
"pair": "BTC_ARS",
"side": "BUY",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "OPEN",
"created_at": 1575472944,
"filled": "0.00000",
"limit_price": "661000.00",
"stop_price": null,
"distance": null
}
]
}
}
POST Cancel an order
Cancel an order
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"order_id": "286e560e-b8a2-464b-8b84-15a7e2a67eab",
"pair": "BTC_ARS",
"side": "SELL",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "CANC",
"created_at": 1575472707,
"filled": "0.00000",
"limit_price": "681000.00",
"stop_price": null,
"distance": null
}
curl --location --request POST "https://api.exchange.ripio.com/api/v1/order/{{pair}}/{{order_id}}/cancel/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"order_id": "286e560e-b8a2-464b-8b84-15a7e2a67eab",
"pair": "BTC_ARS",
"side": "SELL",
"amount": "0.00100",
"notional": null,
"fill_or_kill": false,
"all_or_none": false,
"order_type": "LIMIT",
"status": "CANC",
"created_at": 1575472707,
"filled": "0.00000",
"limit_price": "681000.00",
"stop_price": null,
"distance": null
}
GET User's trade history
User's trade history
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"next": "https://api.exchange.ripio.com/api/v1/trade/<pair>/?limit=20&offset=20",
"previous": null,
"results": {
"data": [
{
"created_at": 1578414028,
"amount": "0.00100",
"price": "665000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "66500000",
"maker_fee": "0",
"taker": 4892,
"maker": 4889
},
{
"created_at": 1578413945,
"amount": "0.00100",
"price": "662000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66200000",
"maker_fee": "0",
"taker": 4891,
"maker": 4817
}
]
}
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/trade/{{pair}}/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"next": "https://api.exchange.ripio.com/api/v1/trade/<pair>/?limit=20&offset=20",
"previous": null,
"results": {
"data": [
{
"created_at": 1578414028,
"amount": "0.00100",
"price": "665000.00",
"side": "BUY",
"taker_fee": "0",
"taker_side": "BUY",
"match_price": "66500000",
"maker_fee": "0",
"taker": 4892,
"maker": 4889
},
{
"created_at": 1578413945,
"amount": "0.00100",
"price": "662000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66200000",
"maker_fee": "0",
"taker": 4891,
"maker": 4817
}
]
}
}
GET Trade details
Trade details
Headers
Content-Type | application/json |
Authorization | Bearer {{API_KEY}} |
Response
raw (application/json){
"created_at": 1578413945,
"amount": "0.00100",
"price": "662000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66200000",
"maker_fee": "0",
"taker": 4891,
"maker": 4817
}
curl --location --request GET "https://api.exchange.ripio.com/api/v1/trade/{{pair}}/{{trade_id}}" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
{
"created_at": 1578413945,
"amount": "0.00100",
"price": "662000.00",
"side": "SELL",
"taker_fee": "0",
"taker_side": "SELL",
"match_price": "66200000",
"maker_fee": "0",
"taker": 4891,
"maker": 4817
}
Errors
Response payload of errors.
Errors consist of three parts: an status code, message and errors. Errors is a dictionary which each key is the source of the error and the value an array of the errors. Here is the error JSON payload:
{
"status_code":400,
"errors":{
"non_field_errors":[
"Your balance is not enough for this order: You have 0 BTC but you need 1 BTC"
]
},
"message":"An error has occurred, please check the form."
}