Giters

cobain / apidoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bione-official-api-docs

Official Documentation for the BIONE

Introduction

Welcome to BIONE API document for developers.

This document provides instructions on how to use APIs related to account management, market information, trading functions among others in spot trading.

Market API provides market data that are accessible to the public. Account APIs and trading APIs, which provide functions such as order placement, order cancellation, order inquiry and account information, need identity authentication.

Getting Started

REST, a.k.a Respresntational State Transfer, is an architectural style that defines a set of constraints and properties based on HTTP. REST is known for its clear structure, readability, standardization and scalability. Its advantages are as follows:

  • Each URL represents one web resource in RESTful architecture;
  • Acting as a representation of resources between client and server;
  • Client is enabled to operate server-side resources with 4 HTTP requests - representational state transfer.

Developers are recommended to use REST API to proceed spot trading and withdrawals.

Encrypted Verification of API

Generate an API Key

Before signing any request, you must apply an access key via BIONE’s official Email ceo@bione.cc. BIONE officials will send the access key and secret after auditing.
After gotten the key, there are two things you must bear in mind:

  • Access Key

  • Secret Key

API access Key and Secret are randomly generated and provided. Please make sure not send secret key to anybody.

Signature

User submitted parameters must be signed except for sign. First, the string to be signed is ordered according to the parameter name (first compare the first letter of all parameter names, in alphabetic order, if you encounter the same first letter, then you move to the second letter, and so on).

sign process

  1. sort all parameters with alphabet order；
  2. join all parameters like this，key1value1key2value2key3value3...keyNvalueN；
  3. use app secret as prefix and suffix like appsecret + keyvalue_result + appsecret
  4. hmac with sha256, like hash_hmac('sha256', message, appSecret, true);
  5. get the sign string with md5(appSecret + hmac_hash_value + appSecret)

Request Process

  The root URL for REST access：https://www.bione.cc

Request

All requests are based on Https protocol. It is required to append accessKey=xxx&sign=xxx for the api required authentication.

Request Process Descriptions

  1. Request parameter: parameter encapsulation based on the port request.

  2. Submitting request parameter: submit the encapsulated parameter request to the server via POST/GET/ or other methods.

  3. Server response: the server will first perform a security validation, then send back the requested data to the client in JSON format.

  4. Data processing: processing server response data.

Success

HTTP status code 200 indicates a successful response and may contain content. If the response contains content, it will appear in the corresponding returned content.

all the response content will be a json text like below.

{
    "code": 1,
    "msg": "success",
    "data": xxx,
}

Common Error Code

  • 1, success

  • 0 or others, failed

if failed, your can get the error message from field "msg"

Pagination

use pagenumber and pagesize.

For example:

GET /orders?pagenumber=1&pagesize=20

Standards and Specification

Timestamp

Unless otherwise specified, all timestamps in APIs are returned in microseconds.

The ACCESS-TIMESTAMP header must be the number of seconds since UTC's time [Unix Epoch][]. Decimal values are allowed. Your timestamp must be within 30 seconds of the API service time, otherwise your request will be considered expired and rejected. If you think there is a large time difference between your server and the API server, then we recommend that you use the time point to check the API server time.

For example,

1524801032573

Numbers

In order to maintain the accuracy of cross-platform, decimal numbers are returned as strings. We suggest that you might be better to convert the number to string when issuing the request to avoid truncation and precision errors. Integers (such as transaction number and sequence) do not need quotation marks.

Rate Limits

When a rate limit is exceeded, a status of 429 Too Many Requests will be returned.

REST API

  • Public interface: We limit the invocation of public interface via IP: up to 6 requests every 2s.

  • Private interface: We limit the invocation of private interface via user ID: up to 6 requests every 2s.

  • Special restrictions on specified interfaces are specified.

Spot API Reference

Spot Market API

1. Access the list of all trading pairs

HTTP Request

    # Request
    GET /api/v2/markets
    # Response
    [
        {
            "market": "eth_usdt",
            "coin_pre": "eth",
            "coin_suf": "usdt",
            "vol": "1417.64830900",
            "change": "4.86000000",
            "quotePrecision": 6,
            "buy_min": "",
            "buy_max": "",
            "sell_min": "",
            "sell_max": ""
        },
        {
            "market": "bcd_usdt",
            "coin_pre": "bcd",
            "coin_suf": "usdt",
            "vol": "388.82555700",
            "change": "1.46000000",
            "quotePrecision": 6,
            "buy_min": "",
            "buy_max": "",
            "sell_min": "",
            "sell_max": ""
        },
        ...
    ]

Response Details

Field Descirption
market Trading pair code
coin_suf Base currency
coin_pre Quote currency
vol Volume
change 24h change value
quotePrecision Quote Precision
buy_min Minimum buy Volume
buy_max Maximum buy Volume
sell_min Minimum sell Volume
sell_max Maximum max Volume

2. Access the depth table of trading pairs

HTTP Request

    # Request
    GET /api/v2/depth?market=xxxx
    # Response
    {
        "asks":[
            [
                "10463.3399",
                "0.0025"
            ],
            ...
        ],
        "bids":[
            [
                "7300.2456",
                "0.0022"
            ],
            ...
        ]
    }

Response Details

Field Description
asks depth of sellers
bids depth of buyers

Request Paramters

Name Type Requited Description
market String Y Trading Pair, e.g. ltc_btc

3. Access the ticker of a trading pair

HTTP Request

The snapshot of the latest price, the highest bid price, the lowest ask price and 24-hour trading volume.

    # Request
    GET /api/v2/ticker/:market
    # Response
    [
        "symbol": "eth_usdt",
        "buy": "0.00000000",
        "sell": "0.00000000",
        "high": "145.01000000",
        "low": "129.19000000",
        "last": "145.01000000",
        "vol": "1418.15673100",
        "change": "4.87000000"
    ]

Response Details (from the top down)

Field Description
symbol trade pair
buy buy
sell sell
high 24hr Highest
low 24hr Lowest
last latest price
vol 24h Vol
change 24h change

Request Parameter

Name Type Required Description
market String Y Trading Pair, e.g. btc_usdt

4. Access the market trading records of a trading pair

The request supports pagination.

HTTP Request

    # Request
    GET /api/v2/deal/:market?pagenumber=1&pagesize=10
    # Response
    [
        [
           "amount": "0.11590600",
           "date": 1550544363,
           "price": "145.00000000",
           "type": 1
        ],
        [
            "amount": "0.11590600",
            "date": 1550544363,
            "price": "145.00000000",
            "type": 2
        ]
    ]

Response Description (In order)

Field Description
amount volume
date timstamp
price Execution Price
type maker side(1:buy, 2:sell)

Request Paramters

Name Type Required Description
market String Y Trading pair, e.g. btc_usdt 
**Explanation**

+ Side indicates that the direction of the order the maker places. Maker refers to a trader who places orders in the market, a marker is a passive transaction party

+ Buy suggests price fall, because the maker places a buy order and the order is executed, the price falls; in contrary, sell suggests price rise, because the maker places a sell order and the order is executed, the price rises.

5. Access Candlestick chart

HTTP Request

    # Request
    GET  /api/v2/kline/:market?type=1min&start=start_time&end=end_time
    # Response
    {
        [ 1550504940000, 0.888547, 138.23, 138.24, 138.23, 138.24 ]
        ...
    }

Response Details (in order)

Field Description
Start timestamp 1415398768
volume 0.888547
Opening price 138.23
The lowest price 138.23
The highest price 138.24
Closing price 138.24

Request parameters

Name Type Required Description
market String Y Trading pair, e.g.eth_usdt
type String Y Candlestick chart period type, e.g.1min/15min/30min/1hour/1day/1week
start String Y timestamp
end String Y timestamp

6. Access Server Time

Access API server time. This interface does not require ID authentication.

HTTP Request

    # Request
    
    GET /api/v2/public/time
    # Reponse

    {
        "timestamp": 1524801032
    }

Response Description

Field Description
timestamp server time expressed in millisecond

It is an API for accessing all the available trading pairs and their trading parameters.

Spot Account API

1. Access account information

Access the list of balance, inquiry of coin balances, freezing status and available fund in spot account.

HTTP Request

    # Request
    GET /api/v2/account/assets

    # Response
    [
        {
            "coin": "btc",
            "available": "0.02809200",
            "freeze": "0.00000000",
            "balance": 0.028092
        },
        {
           "coin": "ltc",
           "available": "0.00000000",
           "freeze": "0.00000000",
           "balance": 0
        }
    ]

Response Details

Field Description
coin Coin symbol
available Avaliable Fund
freeze Frozen fund
balance Number of coins in balance

2. Order Placement

create order for market.

HTTP Request

    # Request

    POST /api/v2/order/create?accessKey=your_access_key&sign=your_sign_str&market=fund_usdt&unitPrice=0.000300&type=1&number=100

    # Response

    {
        "orderSn": "HB1234567",
        "order_id": 123456
    }

   Response Details

+ order_id: Order ID
+ orderSn: Order Sn number

Request Paramters

Name Type Required Description
market String Y Trading pair, e.g.btc_usdt
type String N 1 or 2（1:buy, 2:sell)
number String N delivered when a limit order or selling market order if placed,representing the number of coins for trading
unitPrice String N delivered when a limit order is placed, representing the price of the pair

3. Cancel all orders

Cancel multi unfilled orders of the target trading pair.

HTTP Request

    # Request
    DELETE /api/v2/order/batchcancel?market=eth_usdt&orderids=1,2,3&accessKey=your_access_key&sign=your_sign_str

    # Response

    { ...}

Request Paramters

Name Paramters Type Description
market String Y Trading pairs, e.g. btc_usdt
orderids String Y all order id，separate with comma

4. Cancel a specified order

Cancel a specified order by order ID

HTTP Request

    # Request
    GET /api/v2/order/cancel
    # Response
    {...}

Request Paramters

Name Type Required Description
market String Y Trading Pair, e.g. btc_usdt
orderid String Y The ID of an unfilled order specified need to be cancelled

5. Search orders

Check all the orders by order status.

HTTP Request The request supports pagination. You can refre to the Pagination above.

    # Request
    GET /api/v2/orders?market=fund_usdt&status=xxx&accessKey=your_access_key&sign=your_sign_str
    # Response
    {
        "id": 6188977,
        "userid": 12,
        "order_number": "I218573604654579",
        "market": "fund_usdt",
        "market_type": 1,
        "type": 1,
        "price": "0.00030000",
        "num": "100.00000000",
        "deal": "0.00000000",
        "mum": "0.03000000",
        "fee": null,
        "nature": "",
        "sort": null,
        "addtime": 1550457360,
        "endtime": null,
        "status": 3
    }

Response Details

Field Description
id Order ID
userid User ID
order_number order sn number
market Trading pair, e.g.btc_usdt
market_type ignore this field currently. keep for future.
type maker side(1:buy, 2:sell)
price Price set for the order
num Volume of coins in the order placed
deal deal volume of the order
mum total amount
addtime create time for the order
status Order Status(1: wait for deal, 2: already deal. 3: canceled

Request Paramters

Name Type Required Description
market String Y Trading pair, e.g.btc_usdt
status String Y Order Status(1: wait for deal, 2: already deal. 3: canceled

6. Order inquiry by Order ID

Inquiry of a specified order by order ID

HTTP Request

    # Request
    GET /api/v2/order/query?orderid=your_order_id&market=your_market&accessKey=your_access_key&sign=your_sign_str
    # Response 
    {
       "id": 6188675,
       "userid": 12,
       "order_number": "I218564861103484",
       "market": "fund_usdt",
       "market_type": 1,
       "type": 1,
       "price": "0.00030000",
       "num": "100.00000000",
       "deal": "0.00000000",
       "mum": "0.03000000",
       "fee": null,
       "nature": "",
       "sort": null,
       "addtime": 1550456486,
       "endtime": null,
       "status": 3
    }

Response Details

Field Description
averagePrice average price for the filled orders; 0 for the unfilled orders
market Trading pair, e.g.btc_usdt
createDate Timestamp upon the placement of the order
filledVolume the volume of the filled orders
funds the amount of the filled
orderId Order ID
price Price set for the order
side Order direction
status Order Status
volume Volume of coins in the order placed

Request Paramters

Name Type Required Description
market String Y Trading pair, e.g.btc_usdt
orderid String Y Order Id

7. Access the account statement

Access the statement of a spot account

HTTP Request

    # Request
    GET /api/v2/account/bill/:currencyCode?accessKey=your_access_key&sign=your_sign_str
    # Response
    {
       "id": 19010805,
       "userid": 12,
       "order_number": "I111863328528718",
       "market": "cjz_eth",
       "operation": 2,
       "type": 2,
       "currency_abbr": "eth",
       "currency_total": "0.01490000",
       "c_before_normal": "2.41457859",
       "c_before_bfreeze": "0.00000000",
       "c_before_total": "2.41457859",
       "c_after_normal": "2.39967859",
       "c_after_bfreeze": "0.01490000",
       "c_after_total": "2.41457859",
       "fee": "0.00000000",
       "log_id": "4996256",
       "move": "",
       "addtime": 1547186332,
       "status": 1
    }

Response Details

Field Description
id Statement ID
userid User ID
currency_total Volume of coins traded on the statement
c_before_normal Statement balance
createdDate Timestamp on the statement taking place
details Statement Details
order_number Order SN
productId Product ID
type Transaction Type

Request Paramters

Name Type Required Description
code String Y Trading pair, e.g.btc_usdt

8. Withdrawal

Withdraw to your wallet address.

HTTP Request

    # Request
    GET /api/v2/account/withdraw?coin=your_coin_name&num=your_withdraw_num&addr=your_coin_address&accessKey=your_access_key&sign=your_sign_str
    # Response
    { ... }

Request Parameters

Name Type Required Description
coin String Y Name of coin to be withdrawn, e.g.BTC
num String Y Withdraw amount
addr String Y Withdraw address

About

License:Apache License 2.0