List Your Exchange on XRP Charts
In addition to providing data about the XRP Ledger network and its accounts and transactions, XRP Charts also provides XRP market data from external exchanges. This tutorial describes how to have your exchange and its XRP trade and order book data listed on XRP Charts.
To enable XRP Charts to list your exchange, you'll need to make the following data available. Your exchange may have existing RESTful API endpoints that can deliver this data. If so, there may be little to no development effort required on your part to complete tasks 1 and 2.
Then, you'll need to send an exchange listing request to XRP Charts.
If you have any questions about endpoint specifications, contact xrpcharts_support@ripple.com.
Provide a Recently Executed Trades Endpoint
Provide a RESTful API endpoint that returns the most recent 500-1,000 individual trades executed in a particular XRP market.
To ensure that it doesn't miss a trade, XRP Charts queries the endpoint between every 5 and 30 seconds, aiming to get responses that have overlapping trade data. Ensure that any rate limit enforced by your endpoint can accommodate this query frequency. XRP Charts records unique trade data only, even if it gets overlapping trades.
If XRP Charts needs to query your endpoint at a frequency that exceeds your rate limit, XRP Charts may request that you adjust the rate limit or provide the last_tid parameter.
Request Format
Provide a request format like the following:
GET {api_base_url}/v1/trades
Authentication
XRP Charts prefers to work with a publicly accessible endpoint.
Parameters
Provide parameters that help XRP Charts filter trades returned in the response. The parameter field names are examples. You can use other names. Your endpoint doesn't have to provide the optional parameters, but they are useful.
| Field | Type | Description |
|---|---|---|
market |
String | Returns trades executed in a particular market in which XRP is either the base or counter currency. Use a suggested format of <basecurrency>_<countercurrency> to provide valid values like xrp_btc, btc_xrp, xrp_usd, or usd_xrp, for example. |
last_tid |
Integer | (Optional) Returns trades executed after a specific trade ID. For example, XRP Charts can use this parameter to get all trades after the last set of trades recorded in site data, ensuring that it has recorded all trades. |
limit |
Integer | (Optional) Returns no more than a specific number of trades in a response. |
Response Format
A successful response must be a JSON array of objects, one for each trade. The parameter field names are examples. You can use other names. Your endpoint doesn't have to provide the optional parameters, but they are useful.
| Field | Type | Description |
|---|---|---|
price |
String or Number | Exchange rate of the trade. |
amount |
String or Number | Amount of XRP bought or sold. |
timestamp |
String | Time at which the trade was executed in ISO 8601 date-time format or Unix time format. |
tid |
Integer | (Optional) Unique identifier of the trade. Ideally, make this a sequential integer. |
type |
String | (Optional) Type of trade. For example, valid values can include buy and sell. |
size |
String or Number | (Optional) Amount of counter currency traded. |
count |
Integer | (Optional) Number of trade objects returned in the response. |
Examples
Example Request
GET https://api.example.com/v1/trades?market=xrp_btc&last_tid=75208825&limit=500
Example Response
{
"trades":[
{
"tid":75209326,
"type":"buy",
"price":"0.57201",
"amount":"4954.0744",
"size":"2833.7801",
"timestamp":"2018-10-01T12:35:11.000Z"
},
...
{
"tid":75208826,
"type":"sell",
"price":"0.57201",
"amount":"4954.0744",
"size":"2833.7801",
"timestamp":"2018-10-01T12:31:16.000Z"
}
],
"count":"500"
}
Provide a Current Order Book Endpoint
Provide a RESTful API endpoint that returns data about the current order book in a particular market.
XRP Charts will query this endpoint about every 30 seconds.
Request Format
Provide a request format like the following:
GET {api_base_url}/v1/orderbook
Authentication
XRP Charts prefers to work with a publicly accessible endpoint.
Parameter
Provide the following parameter. The parameter field name is an example. You can use another name.
Field |
Type | Description |
|---|---|---|
market |
String | Returns the current order book in which XRP is either the base or counter currency. Use a suggested format of <basecurrency>_<countercurrency> to provide valid values like xrp_btc, btc_xrp, xrp_usd, or usd_xrp, for example. |
Response Format
A successful response must be a JSON object that includes a timestamp and arrays of current bids and asks. The response does not need to provide the entire order book, but provides enough data to provide a good idea of the current XRP liquidity available in the market. The parameter field names are examples. You can use other names.
| Field | Type | Description |
|---|---|---|
timestamp |
String | Time at which the response was sent in ISO 8601 date-time format or Unix time format. |
bids |
Array of objects | Bids in the order book. Each object in the array must provide the offered price and amount available at that price. |
asks |
Array of objects | Asks in the order book. Each object in the array must provide the offered price and amount available at that price. |
Examples
Example Request
GET https://api.example.com/v1/orderbook?market=xrp_btc
Example Response
{
"timestamp":"2018-10-01T12:41:16.000Z",
"bids":[
{
"price":0.00007103,
"amount":140
},
{
"price":0.000071,
"amount":135
},
{
"price":0.00007092,
"amount":5266
}
],
"asks":[
{
"price":0.00007108,
"amount":140
},
{
"price":0.00007109,
"amount":84
},
{
"price":0.0000711,
"amount":10650
}
]
}
Send an Exchange Listing Request to XRP Charts
Contact xrpcharts_support@ripple.com to request that your exchange be listed on XRP Charts. Be sure to include a link to your API documentation.
See Also
- Concepts:
- Tutorials:
- References: