API Documentation

Web Socket

Web Socket provide public updates of orderbook, trade history and rates.

The base URI is wss://api.exchange.ripio.com/ws/v2/consumer/non-persistent/public/default/

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/DAI the orderbook topic is orderbook_btc_dai, trade history topic is trades_btc_dai and rate topic i rate_btc_dai. There is special topic that notify the user's new trades. This is get in the paylod received when a user succesfully login.

Subscription:

The suscription is a token which identify you as suscriber so the web sockets know which messages was or wasn't deliver. Make sure use the same token to prevent missing updates. Each received message has to be aknowledge so the web socket don't send it again.


import asyncio
import websockets
import base64
import json

suscription = 'suscription-test'
TOPIC = f'wss://api.exchange.ripio.com/ws/v2/consumer/non-persistent/public/default/orderbook_btc_day/{suscription}'

async def consumer():
    async with websockets.connect(TOPIC) as websocket:
        while True:
            msg = await websocket.recv()
            data = json.loads(msg)
            print(base64.b64decode(data['payload']))
            ack = {'messageId': data['messageId']}
            await websocket.send(ack)

asyncio.get_event_loop().run_until_complete(consumer())
    

All the payloads are Base64 encoded

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.


{
    "buy": [
        {
            "amount": "0.00001", 
            "total": "0.7303333", 
            "price": "73033.33"
        }
    ], 
    "sell": [
        {
            "amount": "0.00000", 
            "total": "0.00", 
            "price": "73033.33"
        }
    ], 
    "updated_id": 9144
}
    

Trades


{
    "created_at": 1597343710, 
    "amount": "0.00206", 
    "price": "68392.03", 
    "side": "BUY", 
    "pair": "BTC_BRL", 
    "taker_fee": "0", 
    "taker_side": "BUY", 
    "maker_fee": "0", 
    "taker": 13570460, 
    "maker": 13570271
}
    

Rates


{
    "pair": "BTC_BRL", 
    "last_price": "68558.59", 
    "low": "54736.11", 
    "high": "70034.68", 
    "variation": "8.75", 
    "volume": "10.10537"
}
    

Public

This end-points do not need authentication.

GET All Rates

https://api.exchange.ripio.com/api/v1/rate/all/

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"
    }
]
                
Example RequestAll Rates
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/rate/all/" \
   --header "Content-Type: application/json" \
Example ResponseAll Rates
                        [
    {
        "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

https://api.exchange.ripio.com/api/v1/rate/{{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"
}
                
Example RequestRate per Pair
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/rate/{{pair}}/" \
   --header "Content-Type: application/json" \
Example ResponseRate per Pair
                        {
    "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

https://api.exchange.ripio.com/api/v1/rate/all/?country={{country_code}}

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"
    }
]
                
Example RequestRates per Country
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/rate/all/?country={{country_code}}" \
   --header "Content-Type: application/json" \
Example ResponseRates per Country
                        [
    {
        "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

https://api.exchange.ripio.com/api/v1/orderbook/{{pair}}/

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
}
                
Example RequestOrder book
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/orderbook/{{pair}}/" \
   --header "Content-Type: application/json" \
Example ResponseOrder book
                        {
    "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 Trade history

https://api.exchange.ripio.com/api/v1/tradehistory/{{pair}}/

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
    }
]
                
Example RequestTrade history
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/tradehistory/{{pair}}/" \
   --header "Content-Type: application/json" \
Example ResponseTrade history
                        [
    {
        "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
    }
]

GET List of Pairs

https://api.exchange.ripio.com/api/v1/pair/

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"
        }
    ]
}
                
Example RequestList of Pairs
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/pair/" \
   --header "Content-Type: application/json" \
Example ResponseList of Pairs
                        {
    "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 List of Currencies

https://api.exchange.ripio.com/api/v1/currency/

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
        }
    ]
}
                
Example RequestList of Currencies
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/currency/" \
   --header "Content-Type: application/json" \
Example ResponseList of Currencies
                        {
    "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 Order book Depth

https://api.exchange.ripio.com/api/v1/orderbook/{{pair}}/depth/?amount=1.4

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
    }
}
                
Example RequestOrder book Depth
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/orderbook/{{pair}}/depth/?amount=1.4" \
   --header "Content-Type: application/json" \
Example ResponseOrder book Depth
                        {
    "ask": {
        "price": 800583.54,
        "amount": 0.706,
        "quantity": 43
    },
    "bid": {
        "price": 689201.29,
        "amount": 0.6495,
        "quantity": 28
    }
}

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's balances

https://api.exchange.ripio.com/api/v1/balances/exchange_balances/

View all the balances of user's account

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"
    }
]
                
Example RequestAccount's balances
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/balances/exchange_balances/" \
   --header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
Example ResponseAccount's balances
                        [
    {
        "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"
    }
]

POST Create an order

https://api.exchange.ripio.com/api/v1/order/{{pair}}/

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
}
                
Example RequestCreate an order
                        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" }"
Example ResponseCreate an order
                        {
    "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
}

POST Cancel an order

https://api.exchange.ripio.com/api/v1/order/{{pair}}/{{order_id}}/cancel/

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
}
                
Example RequestCancel an order
                        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}}" \
Example ResponseCancel an order
                        {
    "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 orders

https://api.exchange.ripio.com/api/v1/order/{{pair}}/

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
            }
        ]
    }
}
                
Example RequestUser's orders
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/order/{{pair}}/" \
   --header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
Example ResponseUser's orders
                        {
    "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 Order's details

https://api.exchange.ripio.com/api/v1/order/{{pair}}/{{order_id}}/

Order's 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
}
                
Example RequestOrder's details
                        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}}" \
Example ResponseOrder's details
                        {
    "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

https://api.exchange.ripio.com/api/v1/order/{{pair}}/?status=OPEN,PART

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
            }
        ]
    }
}
                
Example RequestUser's orders filter per status
                        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}}" \
Example ResponseUser's orders filter per status
                        {
    "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
            }
        ]
    }
}

GET User's trade history

https://api.exchange.ripio.com/api/v1/trade/{{pair}}/

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
            }
        ]
    }
}
                
Example RequestUser's trade history
                        curl --location --request GET "https://api.exchange.ripio.com/api/v1/trade/{{pair}}/" \
   --header "Content-Type: application/json" \
--header "Authorization: Bearer {{API_KEY}}" \
Example ResponseUser's trade history
                        {
    "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
            }
        ]
    }
}