Rest API

This service is dedicated to client-side integration. If you prefer server-side integration, please go to the SOAP WebService dedicated page.

Description

Endpoint : https://api.xrpcommunity.pw/v1

API Methods

Get the supported exchanges list
Method Endpoint
GET /exchanges
Result
Field name Description Data type
icon Icon address (if any) string
label Commercial name string
name Exchange name string
url Public Exchange address string
Get pairs for an exchange
Method Endpoint
GET /exchanges/{exchangeName}
Result
Field name Description Data type
exchange\name Exchange name string
exchange\url Public Exchange address string
pairs\c1 Base currency code string
pairs\c1Name Base currency name string
pairs\c2 Other currency code string
pairs\c2Name Other currency name string
pairs\pairName Pait name string
Get all pair details
Method Endpoint
GET /pairs
Result
Field name Description Data type
c1 Base currency code string
c1Name Base currency name string
c2 Other currency code string
c2Name Other currency name string
pairName Pait name string
Get pairs by base currency
Method Endpoint
GET /pairs/{symbol}
Result
Field name Description Data type
c1 Base currency code string
c1Name Base currency name string
c2 Other currency code string
c2Name Other currency name string
pairName Pait name string
Get ticker for particular pair (and exchange as option)
Method Endpoint
GET tickers?period=last&pairName={pairName}&exchangeName={exchangeName}
Field name Description Data type
pairName Pair name string
exchangeName Exchange name (optional) string
Result
Field name Description Data type
ask Ask price long
bid Bid price long
last Last price observed long
high Highest price (if available) long
last Last price observed long
low Lowest price (if available) long
volume 24h Volume long
exchange Exchange string
lastUpdateDiffSec Number of seconds elapsed since last update int
pair Pair name string
spreadPct Difference in % between Ask and Bid int
utcLastUpdatedOn Time in millisecond elapsed since last update (UTC time) Date
utcLastUpdatedStr Last date of update (UTC time) String
exchange Last date of update (UTC time) String
List all currencies exposed by the API
Method Endpoint
GET /currencies?type={currencyType}
Field name Description Data type
currencyType Supported values :
full : returns ALL currencies
fiat : returns FIAT currencies
crypto : returns CRYPTO currencies
string
Result
Field name Description Data type
fiat Indicate wheter the currency is a FIAT currency or not boolean
name Currency name string
symbol Currency symbol string
Retrieve aggregated Data
Method Endpoint
GET /kpi?period={period}&pairName={pairName}&exchangeName={exchangeName}
Field name Description Data type
period Supported values :
1m : Data at 1 minute interval for last 1 hour
5m : Data at 5 minute interval for last 2 hours
15m : Data at 15 minute interval for last 12 hours
30m : Data at 30 minute interval for last 24 hours
1h : Data at 1 hour interval for the last 24 hours
2h : Data at 2 hour interval for the last 48 hours
4h : Data at 4 hour interval for the last 72 hours
string
pairName Pair name to query string
exchangeName Exchange to request data from string
Result
Field name Description Data type
ask Average Ask price during the time interval long
bid Average Bid price during the time interval long
last Average price during the time interval long
high Average highest price during the time interval long
low Average lowest price during the time interval long
date Right edge of the time interval (end of period) : UTC time datetime
epoch Unix epoch time in milliseconds : UTC time long
strDate Interval date part string
strHour Interval hour part string