XRP/BTC
0.00002943
0.00000013 (0.44%)
0.00002886  0.00003015
52963.09526357 XRP
ETH/EUR
286.000
4.958 (1.73%)
281.042  286.000
25.26673681 ETH
DASH/BTC
0.05769523
0.00127740 (2.21%)
0.05769523  0.05910445
15.00533561 DASH
XRP/BCH
0.00019000
0.00001912 (10.06%)
0.00017088  0.00020252
13218.43926357 XRP
ETH/BTC
0.04412825
0.00132801 (3.00%)
0.04279101  0.04472154
8.91573609 ETH
BCH/EUR
1020.000
60.426 (5.92%)
1020.000  1080.427
1.90521482 BCH

API Documentation

Bitsane API allows you to use all the features that Bitsane platform offers. You will be easily able to integrate exchange engine in your app or display statistics on your website. Documentation presented below describes functions and methods you will need to create your very own superior applications.

Please don't hesitate to contact us with any questions or comments you may have.

/api/public

Public API does not require authentication.

All public API calls use GET requests.

Ticker
GET
/api/public/ticker

Description

Ticker

Result:

{
    "BTC_USD": {
        "last": "last price",
        "lowestAsk": "lowest ask price",
        "highestBid": "highest bid price",
        "percentChange": "daily percentage price change",
        "baseVolume": "base currency daily volume",
        "quoteVolume": "quote currency daily volume",
        "high24hr": "highest daily price",
        "low24hr": "lowest daily price",
        "euroEquivalent": "daily volume in EUR equivalent",
        "bitcoinEquivalent": "daily volume in BTC equivalent"
    }
}
Orders Book
GET
/api/public/orderbook

Description

Orders Book

Parameter Value Data type Description
pair * String Orders pair
limit_bids Integer Limit bids to return. Default 50 min 1
limit_asks Integer Limit asks to return. Default 50 min 1

Result:

{
    "bids": [
        {
            "price": "order price",
            "amount": "order amount",
            "timestamp": "order create time"
        }
    ],
    "asks": [
        {
            "price": "order price",
            "amount": "order amount",
            "timestamp": "order create time"
        }
    ]
}
Trades
GET
/api/public/trades

Description

Trades

Parameter Value Data type Description
pair * String Trades pair
since Integer Limit trades created at or after this timestamp
limit Integer Limit trades to return. Default 50 min 1 max 1000

Result:

[
    {
        "tid": "trade id",
        "timestamp": "time when trade has been created",
        "price": "trade price",
        "amount": "trade amount"
    }
]
/api/private

Private API requires authentication.


All private API calls use POST requests and must contain "nonce" integer parameter (always must be greater than last one).

POST body - request parameters object encoded to JSON then to base64


To authenticate your account "X‑BS‑APIKEY", "X‑BS‑PAYLOAD", "X‑BS‑SIGNATURE" headers should be sent.


X-BS-APIKEY - your API key. You can obtain it in your Profile

X-BS-PAYLOAD - request parameters object encoded to JSON then to base64 (same as POST body)

X-BS-SIGNATURE - X‑BS‑PAYLOAD hashed with HMAC‑SHA384 using your API secret as HMAC‑key


Result contains "statusCode" and "statusText" to ease API usage.

Status Codes
Status Code Status Text
0 Success
1 Error
2 Wrong http method
3 X-BS-APIKEY header was not sent
4 X-BS-PAYLOAD header was not sent
5 X-BS-SIGNATURE header was not sent
6 nonce field not found
7 Could not find a key matching the given X-BS-APIKEY
8 The nonce should be greater than the previous
9 X-BS-SIGNATURE header does not match encoded data
10 Api key does not have permissions for this action
11 Ip address is not valid
12 Invalid parameters
13 Temporary disabled
Api Key*
Private Key*
Nonce*
Funds
POST
/api/private/balances

Description

Balances

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "currency": "currency code (EUR, USD, BTC, etc.)",
            "amount": "amount"
        }
    ]
}
POST
/api/private/deposit/address

Description

Deposit address

Parameter Value Data type Description
currency * String Deposit currency

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": {
        "currency": "currency code (EUR, USD, BTC, etc.)",
        "address": "address of currency"
    }
}
POST
/api/private/transactions/history

Description

Get transactions history

Parameter Value Data type Description
currency * String Transactions currency
since * Integer Return only the history after this timestamp.
until Integer Return only the history before this timestamp.
limit Integer Limit the number of entries to return.

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "currency": "currency code (EUR, USD, BTC, etc.)",
            "amount": "amount",
            "type": "operation type",
            "new_balance": "balance after transaction",
            "timestamp": "transaction time (timestamp)",
            "description": "description"
        }
    ]
}
POST
/api/private/vouchers

Description

Vouchers list

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "currency": "currency code (EUR, USD, BTC, etc.)",
            "amount": "amount",
            "voucher": "voucher code"
        }
    ]
}
POST
/api/private/vouchers/create

Description

Create voucher

Parameter Value Data type Description
currency * String Voucher currency
amount * Float Voucher amount
pin * String Voucher PIN (4 digits)

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": {
        "currency": "currency code (EUR, USD, BTC, etc.)",
        "amount": "amount",
        "voucher": "voucher code"
    }
}
POST
/api/private/vouchers/redeem

Description

Redeem voucher

Parameter Value Data type Description
voucher * String Voucher code
pin * String Voucher PIN (4 digits)

Result:

{
    "statusCode": "status code",
    "statusText": "status text"
}
POST
/api/private/withdraw

Description

Withdraw

Parameter Value Data type Description
currency * String Withdrawal currency
amount * Float Withdrawal amount
address * String Withdrawal address

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": {
        "withdrawal_id": "withdrawal ID"
    }
}
POST
/api/private/withdrawal/status

Description

Withdrawal status

Parameter Value Data type Description
withdrawal_id * String Withdrawal ID

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": {
        "currency": "withdrawal currency",
        "amount": "withdrawal amount",
        "address": "withdrawal address",
        "status": "withdrawal status",
        "txid": "withdrawal transaction id"
    }
}
Orders and Trades
POST
/api/private/order/cancel

Description

Order cancel

Parameter Value Data type Description
order_id * String Order ID

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "id": "order ID",
            "pair": "pair of order",
            "price": "price of order",
            "side": "order side (buy, sell)",
            "type": "type of order",
            "timestamp": "creation time (timestamp)",
            "is closed": "is order closed",
            "is_cancelled": "is order canceled",
            "is_hidden": "is order hidden",
            "executed_amount": "executed amount",
            "remaining_amount": "remaining amount",
            "original_amount": "original amount"
        }
    ]
}
POST
/api/private/order/new

Description

New order creation

Parameter Value Data type Description
pair * String Order pair
amount * Float Order amount
price * Float Order prices
side * String buy or sell
type String order type (default: "limit")
hidden Boolean "1" or "true" if the order should be hidden

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": {
        "order_id": "order ID"
    }
}
POST
/api/private/order/status

Description

Order status

Parameter Value Data type Description
order_id * String Order ID

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "id": "order ID",
            "pair": "pair of order",
            "price": "price of order",
            "side": "order side (buy, sell)",
            "type": "type of order",
            "timestamp": "creation time (timestamp)",
            "is closed": "is order closed",
            "is_cancelled": "is order canceled",
            "is_hidden": "is order hidden",
            "executed_amount": "executed amount",
            "remaining_amount": "remaining amount",
            "original_amount": "original amount"
        }
    ]
}
POST
/api/private/orders

Description

Get active orders

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "id": "order ID",
            "pair": "pair of order",
            "price": "price of order",
            "side": "order side (buy, sell)",
            "type": "type of order",
            "timestamp": "creation time (timestamp)",
            "is_alive": "is order alive",
            "is_cancelled": "is order canceled",
            "is_hidden": "is order hidden",
            "executed_amount": "executed amount",
            "remaining_amount": "remaining amount",
            "original_amount": "original amount"
        }
    ]
}
POST
/api/private/orders/history

Description

Get orders history

Parameter Value Data type Description
pair * String Orders pair
since * Integer Return only the history after this timestamp.
until Integer Return only the history before this timestamp.
limit Integer Limit the number of entries to return.
reverse Boolean Return trades in reverse order (the oldest comes first). Default is returning newest trades first.

Result:

{
    "statusCode": "status code",
    "statusText": "status text",
    "result": [
        {
            "id": "order ID",
            "pair": "pair of order",
            "price": "price of order",
            "side": "order side (buy, sell)",
            "type": "type of order",
            "timestamp": "creation time (timestamp)",
            "is_alive": "is order alive",
            "is_cancelled": "is order canceled",
            "is_hidden": "is order hidden",
            "executed_amount": "executed amount",
            "remaining_amount": "remaining amount",
            "original_amount": "original amount"
        }
    ]
}
Close all