| Field | Type | Description |
|---|---|---|
| filter (optional) | string | Unique symbol identifier, e.g. "BTC" |
| Field | Type | Description |
|---|---|---|
| symbol | string | Unique identifier of the currency, e.g. "BTC" |
| name | string | Currency name, e.g. "Bitcoin" |
| isFiat | boolean | Reports whether the currency is fiat |
| canDeposit | boolean | Contains the value false if deposits for the currency are not accepted at the moment |
| depositConfirmationCount | int | The number of blockchain confirmations the deposit is required to receive before the funds are credited to the account (for cryptocurrencies only; in case of fiat currency, the field contains the value null) |
| minDeposit | decimal | Minimum deposit threshold (for cryptocurrencies only; in case of fiat currency, the field contains the value null) |
| canWithdraw | boolean | Contains the value false if withdrawals are not currently available for the currency |
| minWithdrawal | decimal | Minimum withdrawal amount (for cryptocurrencies only; in case of fiat currency, the field contains the value null) |
| maxWithdrawal | decimal | Maximum withdrawal amount (for cryptocurrencies only; in case of fiat currency, the field contains the value null). If a currency doesn’t have an upper withdrawal limit, the field contains the value null |
| lastUpdateTimestamp | datetime | The currency was last updated. |
| The data returned is in JSON format. | ||
GET /api/public/currencies
The above request returns JSON structured like
[
{
"symbol": "XVG",
"name": "Verge",
"isFiat": false,
"canDeposit": true,
"depositConfirmationCount": 8,
"minDeposit": 0.0,
"canWithdraw": true,
"minWithdrawal": 4.0,
"maxWithdrawal": null,
"lastUpdateTimestamp": "2018-06-01T14:01:52Z"
},
...
]
GET /api/public/currencies?filter=ETH
The above request returns JSON structured like
[
{
"symbol": "ETH",
"name": "Ethereum",
"isFiat": false,
"canDeposit": true,
"depositConfirmationCount": 12,
"minDeposit": 0.01,
"canWithdraw": true,
"minWithdrawal": 0.01,
"maxWithdrawal": 5000.0,
"lastUpdateTimestamp": "2018-06-01T14:01:52Z"
}
]
| Field | Type | Description |
|---|---|---|
| filter (optional) | string | Unique ticker identifier, e.g. "LTC_BTC" |
| Field | Type | Description |
|---|---|---|
| tradingPairs | string | Unique ticker identifier, e.g. "LTC_BTC" |
| LastPrice | decimal | Last price. If this information is not available, the field contains the value null |
| percentChange | decimal | Percentage change of the price over the last 24 hours. If this information is not available, the field contains the value null |
| lowDay | decimal | Lowest price over the last 24 hours. If this information is not available, the field contains the value null |
| highDay | decimal | Highest price over the last 24 hours. If this information is not available, the field contains the value null |
| baseVolumeDay | decimal | Total trading volume of the instrument over the last 24 hours, expressed in base currency |
| quoteVolumeDay | decimal | Total trading volume of the instrument over the last 24 hours, expressed in quote currency |
| lowestAsk | decimal | Best ask price. If there are no active selling orders, the field contains the value null |
| highestBid | decimal | Best bid price. If there are no active buying orders at the moment, the field contains the value null |
| lastUpdateTimestamp | datetime | Date and time when the ticker was updated |
| tradesEnabled | boolean | Indicates whether the status is active or passive. true - working in a normal mode; false - trading is passive; |
| The data returned is in JSON format. | ||
GET /api/public/tickers
The above request returns JSON structured like this:
[
{
"tradingPairs": "XVG_BTC",
"LastPrice": 0.0000005,
"percentChange": 8.6957,
"lowDay": 0.00000046,
"highDay": 0.0000005,
"baseVolumeDay": 144.855144855145,
"quoteVolumeDay": 0.0000724275724275725,
"lowestAsk": 0.0000005,
"highestBid": 0.00000046,
"lastUpdateTimestamp": "2018-05-31T12:48:56Z"
"tradesEnabled": true
},
...
]
GET /api/public/tickers?filter=ETH_BTC
The above request returns JSON structured like this:
[
{
"tradingPairs": "ETH_BTC",
"LastPrice": 0.07699474,
"percentChange": 8.4433,
"lowh": 0.07099998,
"highh": 0.07787616,
"baseVolumeDay": 34.0474,
"quoteVolumeDay": 2.5673,
"lowestAsk": 0.0771,
"highestBid": 0.07699474,
"lastUpdateTimestamp": "2018-06-01T14:01:52Z",
"tradesEnabled": true
}
]
| Field | Type | Description |
|---|---|---|
| filter | string | Unique ticker identifier, e.g. "LTC_BTC" |
| limit (optional) | integer | Limit the number of results |
| Field | Type | Description |
|---|---|---|
| tradeID | int | The ID unique only to this currency pair associated with this trade. |
| price | decimal | Price for which the base currency was bought or sold |
| baseVolume | decimal | Total trading volume of the instrument over the expressed in base currency |
| quoteVolume | decimal | Total trading volume of the instrument over the expressed in quote currency |
| type | string | Trade direction, can have either of the two values: "buy" or "sell" |
| time | datetime | Date and time when the trade took place |
| isBuyerMaker | boolean | If isBuyerMaker is true then that means a seller fulfilled a buy order. |
| The data returned is in JSON format. | ||
GET /api/public/recentTrades?filter=LTC_BTC
The above request returns JSON structured like this:
[
{
"tradeID ": 58144,
"price": 0.0159019,
"baseVolume": 0.043717,
"quoteVolume ": 2.043717,
"type": "buy",
"time": "2018-05-31T10:08:53Z"
"isBuyerMaker": true
},
{
"tradeID ": 58145,
"price": 0.0159019,
"baseVolume": 0.043717,
"quoteVolume ": 2.043717,
"type": "buy",
"time": "2018-05-31T10:08:53Z"
"isBuyerMaker": true
},
]
GET /api/public/recentTrades?filter=LTC_BTC&limit=1
The above request returns JSON structured like this:
[
{
"tradeID ": 58146,
"price": 0.0159019,
"baseVolume": 0.043717,
"quoteVolume ": 2.043717,
"type": "buy",
"time": "2018-05-31T10:08:53Z"
"isBuyerMaker": true
},
...
]
| Field | Type | Description |
|---|---|---|
| filter | string | Unique ticker identifier, e.g. "LTC_BTC" |
| limit (optional) | integer | Limit the number of results |
| Field | Type | Description |
|---|---|---|
| bids | An array of price levels for buying orders, sorted by price from highest to lowest | |
| asks | An array of price levels for selling orders, sorted by price from lowest to highest | |
| LastUpdateTimestamp | datetime | The UTC date and time of the trade execution. |
| The data returned is in JSON format. | ||
GET /api/public/orderBook?filter=LTC_BTC
The above request returns JSON structured like this:
{
"LastUpdateTimestamp": 1568085495
"bids": [
[
"0.01573481",
0.032,
]
],
"asks": [
[
"0.01593",
0.059355644356,
]
]
}
GET /api/public/orderBook?filter=LTC_BTC&limit=2
The above request returns JSON structured like this:
{
"LastUpdateTimestamp": 1568085495
"bids": [
[
"0.01573481",
0.032,
],
[
"0.01500001",
0.75,
]
],
"asks": [
[
"0.01593000",
0.059355644356,
],
[
"0.01594994",
0.3,
]
]
}
| Field | Description | |
|---|---|---|
| Api key | You can create it from the account page. | |
| Secret key | You can create it from the account page. | |
GET /api/account/...
Send the Api Key and Api Secret Key in Headers
apiKey = "Api Key";
apiSecret = "Api Secret Key";
| Field | Type | Description |
|---|---|---|
| symbol | string | Unique identifier of the currency, e.g. "BTC" |
| The data returned is in JSON format. | ||
GET /api/account/userBalance?symbol=BTC
The above request returns JSON structured like this:
{"0.00000000"}
| Field | Type | Description |
|---|---|---|
| symbol | string | Currency symbol. |
| limit (optional) | integer | Limit the number of results |
| Field | Type | Description |
|---|---|---|
| orderID | string | Order ID of open order. |
| price | double | Price of open order. |
| amount | double | Amount of open order. |
| type | string | Type of open order. |
| symbol | string | Currency symbol. |
| time | string | Time of open order. |
| The data returned is in JSON format. | ||
GET /api/account/userOrder
The above request returns JSON structured like this:
[
{
"orderID": "order ID",
"price": 0.0000005,
"amount": 8.6957,
"type": sell,
"symbol": ETH_BTC,
"time": 162587412565,
},
...
]
GET /api/account/userOrder?symbol=LTC_BTC&limit=5
The above request returns JSON structured like this:
[
{
"orderID": "order ID",
"price": 0.0000005,
"amount": 8.6957,
"type": sell,
"symbol": LTC_BTC,
"time": 162587412565,
},
...
]
| Field | Type | Description |
|---|---|---|
| orderID | string | ID of the order |
| The data returned is in JSON format. | ||
GET /api/account/userOrderCancel?orderID=OrderId
The above request returns JSON structured like this:
[
{
"The order has been canceled."
},
...
]
| Field | Type | Description |
|---|---|---|
| symbol | string | Currency symbol. |
| limit (optional) | integer | Limit the number of results |
| Field | Type | Description |
|---|---|---|
| tradeID | string | Order ID of open order. |
| price | double | Price of open order. |
| amount | double | Amount of open order. |
| type | string | Type of open order. |
| symbol | string | Currency symbol. |
| time | string | Time of open order. |
| The data returned is in JSON format. | ||
GET /api/account/userOrderHistory
The above request returns JSON structured like this:
[
{
"tradeID": "trade ID",
"price": 0.0000005,
"amount": 8.6957,
"type": sell,
"symbol": ETH_BTC,
"time": 162587412565,
},
...
]
GET /api/account/userOrderHistory?symbol=LTC_BTC
The above request returns JSON structured like this:
[
{
"tradeID": "trade ID",
"price": 0.0000005,
"amount": 8.6957,
"type": sell,
"symbol": LTC_BTC,
"time": 162587412565,
},
...
]
| Field | Type | Description |
|---|---|---|
| price | double | Price of open order. |
| amount | double | Amount of open order. |
| direction | string | Direction of open order. |
| symbol | string | Currency symbol. |
GET /api/account/userTrade?symbol=LTC_BTC&price=0.033546&amount=0.012&direction=BUY
The above request returns JSON structured like this:
[
{
"The order has been successfully created."
},
...
]