Lists all markets
Field | Description |
---|---|
Array of [Market entry] | |
[Market entry] (Array) | |
Index 0 | Listing currency code |
Index 1 | Reference currency code |
Lists all markets
Field | Description |
---|---|
Array of [Market entry] | |
[Market entry] (Array) | |
Index 0 | Listing currency code |
Index 1 | Reference currency code |
Index 2 | Market ID |
Gets price of a given market
Field | Description |
---|---|
Bid | Highest buy order |
Ask | Lowest sell order |
Last | Last price |
Variation24Hr | Last 24 hours last price variation |
Volume24Hr | Last 24 hours volume |
Lists prices of all markets
Field | Description |
---|---|
Array of [Price entry] | |
[Price entry] | |
Market | Market name |
Bid | Highest buy order |
Ask | Lowest sell order |
Last | Last price |
Variation24Hr | Last 24 hours last price variation |
Volume24Hr | Last 24 hours volume |
Lists order book of a given market
Field | Description |
---|---|
BuyOrders | Buy orders. Array of [Order entry] |
SellOrders | Sell orders. Array of [Order entry] |
[Order entry] | |
Index | Incremental value for each book entry |
Amount | Book entry total amount |
Price | Book entry price |
Lists latest trades in a given market
Field | Description |
---|---|
Array of [Trade entry] | |
[Trade entry] | |
At | Execution time in Unix standard format (UTC) |
Amount | Amount in listing currency |
Price | Price in reference currency |
Type | Possible values: buy, sell |
List market history between two dates
Parameters | |
---|---|
Field | Description |
listingCurrencyCode | Market listing currency |
referenceCurrencyCode | Market reference currency |
start | Start date in milliseconds from January 1, 1970 |
end | End date in milliseconds from January 1, 1970 |
periods | Number of periods to get (Optional: defaults to 100) |
Result | |
---|---|
Array of [History Entry] | |
[History Entry] | |
Date | Start date of the period |
PriceHigh | Highest price of the period |
PriceLow | Lowest price of the period |
PriceOpen | First price of the period |
PriceClose | Last price of the period |
Volume | Volume of the period |
Parameters | |
---|---|
Field | Description |
key | API Key |
nonce | Positive numerical value greater than the one used in the previous call |
Hash (HTTP header) | HMAC-SHA512 of the request body signed with the secret value |
Places an order in a given market. Permission required: Place Order
Parameters | |
---|---|
Field | Description |
listingCurrency | Market listing currency |
referenceCurrency | Market reference currency |
type | Order type. Possible values: buy, sell |
amount | Order amount in listing currency |
limitPrice | Optional price in reference currency. If null then order is executed at market price |
Result |
---|
Order code |
Cancels a given order. Permission required: Cancel Order
Parameters | |
---|---|
Field | Description |
orderCode | Order code to cancel |
Cancels all orders in a given market. Permission required: Cancel Order
Parameters | |
---|---|
Field | Description |
listingCurrency | Market listing currency |
referenceCurrency | Market reference currency |
Lists all pending orders. Permission required: List Orders
Parameters |
---|
None |
Result | |
---|---|
Field | Description |
Array of [Order entry] | |
[Order entry] | |
Code | Order code |
Type | Order type. Possible values: buy, sell |
Amount | Pending amount in listing currency |
OriginalAmount | Original amount in listing currency |
LimitPrice | Order price in reference currency |
ListingCurrency | Market listing currency |
ReferenceCurrency | Market reference currency |
Generates a new address for a given cryptocurrency. Permission required: Generate New Address
Parameters | |
---|---|
Field | Description |
currency | Currency for which a new address will be generated |
Result |
---|
Address |
Withdraws to a given address. Permission required: Withdraw
Parameters | |
---|---|
Field | Description |
currency | Currency code to withdraw |
address | Destination address |
amount | Amount to withdraw. Destination address will receive this amount minus fees |
Result | |
---|---|
Field | Description |
Status |
Possible values: ok: withdrawal request succees holdsNotSatisfied: cannot withdraw due to hold in your account limitReached: cannot withdraw due to withdrawal limit |
Max | The remaining withdrawal limit |
MaxDaily | The daily withdrawal limit |
MovementId | ID of this withdrawal |
Lists balances for all currencies. Permission required: List Balances
Parameters |
---|
None |
Result | |
---|---|
Field | Description |
Array of [Balance entry] | |
[Balance entry] | |
Currency | Currency code |
Deposited | Total amount deposited for this currency code |
Available | Total amount that is not committed in orders |
Unconfirmed | Total amount unconfirmed in pending deposits |
List all transactions. Permission required: List Balances
Parameters | Description |
---|---|
Currency | Currency code |
TransactionType | Transaction type. Possible values: transactions, deposits, withdrawals, depositswithdrawals (Optional: defaults to transactions) |
PageIndex | Page index |
PageSize | Page size. Maximum: 50 |
SortField | Sort field |
Descending | If [SortField] is descending |
Result | |
---|---|
Field | Description |
Array of [Transaction Entry] | |
[Transaction Entry] | |
Date | Date of the transaction |
CurrencyCode | The currency code of the transaction. Delisted coins shown as '?' |
Amount | Amount of the transaction |
TotalBalance | Total balance after this transaction |
Type | Possible values: trade, trade fee, deposit, withdraw, etc |
Status | Possible values: pending, confirmed, processed, etc |
Address | Deposit or withdraw address |
Hash | Deposit or withdraw chain transaction hash |
Price | Trade price |
OtherAmount | Trade amount of the other currency |
OtherCurrency | The other trade currency. Delisted coins shown as '?' |
OrderCode | Trade order code |
TradeId | The ID of the trade |
MovementId | Deposit or withdrawal ID |
Generates a new Lightning Network invoice for a given cryptocurrency. Permission required: Generate New Address
Parameters | Description |
---|---|
currency | Currency code for which the invoice will be generated. Possible values: BTC, LTC |
amount | Invoice amount |
Result |
---|
Payment request (invoice) |
Loading