NAV
bash javascript

Introduction

Thank you for your interest in the BUZZEX API. The API was designed to cover the basic aspects of BUZZEX objects and allow you to get started writing custom applications quickly.

Public API and Trade API are useful device for communicating with the third party software stock exchange.

Public API

Info

Provides information for each pairs. A pair contains the following details:

Hidden pairs are not shown in the list at Stock Exchange home page, but exchange transactions continue. In case if any pair is disabled it disappears from the list.

Example request:

curl -X GET "https://api.buzzex.io/api/v1/info" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/info",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "server_time": 1536120989,
    "pairs": [
        {
            "btc_eth": {
                "decimal_places": 8,
                "min_price": 1.0e-8,
                "max_price": 10000,
                "min_amount": 1.0e-5,
                "min_total": 1.0e-8,
                "hidden": 0,
                "fee": 0.1,
                "fee_buyer": 0.1,
                "fee_seller": 0.1
            }
        },
        {
            "btc_etc": {
                "decimal_places": 8,
                "min_price": 1.0e-8,
                "max_price": 10000,
                "min_amount": 1.0e-5,
                "min_total": 1.0e-8,
                "hidden": 0,
                "fee": 0.1,
                "fee_buyer": 0.1,
                "fee_seller": 0.1
            }
        },
        {
            "adz_etc": {
                "decimal_places": 8,
                "min_price": 1.0e-8,
                "max_price": 10000,
                "min_amount": 1,
                "min_total": 1.0e-8,
                "hidden": 0,
                "fee": 0.1,
                "fee_buyer": 0.1,
                "fee_seller": 0.1
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1849,
            "count": 100,
            "per_page": 100,
            "current_page": 1,
            "total_pages": 19,
            "links": {
                "next": "http:\/\/localhost\/api\/v1\/info?page=2"
            }
        }
    }
}

HTTP Request

GET api/v1/info

HEAD api/v1/info

Ticker

Provides statistic data for the last 24 hours.

Example request:

curl -X GET "https://api.buzzex.io/api/v1/ticker/BTC_ETH" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/ticker/BTC_ETH",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

[
    {
        "btc_eth": {
            "pair_id": 10,
            "last": 0,
            "lowest_ask": 0.02637884,
            "highest_bid": 0.02571638,
            "price_24h": 0,
            "base_volume": 0,
            "quote_volume": 0,
            "is_frozen": 0,
            "high_24hr": 0,
            "low_24hr": 0,
            "percent_change": 0,
            "updated": 1545105303
        }
    }
]

HTTP Request

GET api/v1/ticker/{pairName?}

HEAD api/v1/ticker/{pairName?}

depth

Returns information about lists of active orders for selected pairs.

Example request:

curl -X GET "https://api.buzzex.io/api/v1/depth/USD_ADZAC" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/depth/USD_ADZAC",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

[
    {
        "usd_adzac": {
            "asks": [
                [
                    0,
                    148807.70988252
                ],
                [
                    0.1,
                    40
                ]
            ],
            "bids": [
                [
                    0,
                    5206.25193207
                ],
                [
                    1e-8,
                    165
                ]
            ]
        }
    }
]

HTTP Request

GET api/v1/depth/{pairName}

HEAD api/v1/depth/{pairName}

trades

Returns information about the last transactions of selected pairs.

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trades/USD_ADZAC" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trades/USD_ADZAC",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "usd_adzac": [
        {
            "type": "ask",
            "price": 0,
            "amount": 100,
            "tid": 1,
            "timestamp": 1506591842
        },
        {
            "type": "ask",
            "price": 0,
            "amount": 40,
            "tid": 2,
            "timestamp": 1506611092
        },
        {
            "type": "ask",
            "price": 0,
            "amount": 10,
            "tid": 3,
            "timestamp": 1506611859
        },
        {
            "type": "ask",
            "price": 0,
            "amount": 50,
            "tid": 4,
            "timestamp": 1506613725
        },
        {
            "type": "ask",
            "price": 0,
            "amount": 1,
            "tid": 5,
            "timestamp": 1506616605
        },
        {
            "type": "ask",
            "price": 0,
            "amount": 100,
            "tid": 6,
            "timestamp": 1506616924
        },
        {
            "type": "ask",
            "price": 0,
            "amount": 140,
            "tid": 7,
            "timestamp": 1506620561
        }
    ]
}

HTTP Request

GET api/v1/trades/{pairName}

HEAD api/v1/trades/{pairName}

Trading API

GetInfo

Provides information about user's balances and priviledges of API-key as well as server time.

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trading/getinfo" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/getinfo",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "funds": [],
    "funds_incl_orders": [],
    "server_time": 1546918826
}

HTTP Request

GET api/v1/trading/getinfo

HEAD api/v1/trading/getinfo

Trade

Method that allows creating new orders for stock exchange trading

Form Data Parameters:

Data Returned

Example request:

curl -X POST "https://api.buzzex.io/api/v1/trading/trade" \
-H "Accept: application/json" \
    -d "pair"="quaerat" \
    -d "type"="sell" \
    -d "rate"="559176210" \
    -d "amount"="559176210" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/trade",
    "method": "POST",
    "data": {
        "pair": "quaerat",
        "type": "sell",
        "rate": 559176210,
        "amount": 559176210
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/trading/trade

Parameters

Parameter Type Status Description
pair string required
type string required buy, sell, BUY or SELL
rate numeric required Minimum: 0.00000001
amount numeric required Minimum: 0.00000001

Active Orders

Method returns list of user's active orders

Parameters:

Return

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trading/active-orders/BTC_ETH" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/active-orders/BTC_ETH",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "success": true,
    "orders": [
        {
            "10501": {
                "pair": "btc_eth",
                "type": "buy",
                "amount": 0.098,
                "rate": 0.021319,
                "timestamp_created": 1546585968
            }
        },
        {
            "10502": {
                "pair": "btc_eth",
                "type": "buy",
                "amount": 2.729,
                "rate": 0.021297,
                "timestamp_created": 1546585968
            }
        },
        {
            "10503": {
                "pair": "btc_eth",
                "type": "buy",
                "amount": 4.029,
                "rate": 0.021296,
                "timestamp_created": 1546585968
            }
        },
        {
            "10504": {
                "pair": "btc_eth",
                "type": "buy",
                "amount": 31,
                "rate": 0.021294,
                "timestamp_created": 1546585968
            }
        },
        {
            "10505": {
                "pair": "btc_eth",
                "type": "buy",
                "amount": 0.978,
                "rate": 0.021281,
                "timestamp_created": 1546585968
            }
        },
        {
            "10506": {
                "pair": "btc_eth",
                "type": "sell",
                "amount": 0.637,
                "rate": 0.021338,
                "timestamp_created": 1546585968
            }
        }
    ]
}

HTTP Request

GET api/v1/trading/active-orders/{pairName}

HEAD api/v1/trading/active-orders/{pairName}

Order Info

Method returns detailed information about the chosen order

Parameters:

order_id: order ID (value: numeral)

Return

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trading/order-info/11188" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/order-info/11188",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "success": true,
    "orderInfo": [
        {
            "11188": {
                "pair": "btc_cmt",
                "type": "buy",
                "amount": 82,
                "rate": 0.00000662,
                "timestamp_created": 1546586036
            }
        }
    ]
}

HTTP Request

GET api/v1/trading/order-info/{orderId}

HEAD api/v1/trading/order-info/{orderId}

Cancel Order

Method cancells the chosen order

Parameters:

order_id: order ID (value: numeral)

Return

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trading/cancel-order/11188" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/cancel-order/11188",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "success": true,
    "data": {
        "order_id": 11188,
        "funds": []
    }
}

HTTP Request

GET api/v1/trading/cancel-order/{orderId}

HEAD api/v1/trading/cancel-order/{orderId}

GetDepositAddress

Method returns deposit address.

Parameters:

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trading/get-deposit-address/ADZ" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/get-deposit-address/ADZ",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "success": true,
    "address": "97mGWyQrbkzuaY2vBqAh4AcvTFkDxvpsBg",
    "server_time": 1546920246
}

HTTP Request

GET api/v1/trading/get-deposit-address/{ticker}/{needNew?}

HEAD api/v1/trading/get-deposit-address/{ticker}/{needNew?}

Withdraw

Method creates withdrawal request.

Parameters:

Example request:

curl -X POST "https://api.buzzex.io/api/v1/trading/withdraw" \
-H "Accept: application/json" \
    -d "coinName"="mollitia" \
    -d "amount"="1282432413" \
    -d "address"="mollitia" \
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/withdraw",
    "method": "POST",
    "data": {
        "coinName": "mollitia",
        "amount": 1282432413,
        "address": "mollitia"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/v1/trading/withdraw

Parameters

Parameter Type Status Description
coinName string required
amount numeric required Minimum: 0.00000001
address string required

Trade History

Method returns transaction history.

Parameters:

While using parameters since or end parameter order automatically takes the value ASC.

While using parameters since the earliest date available to get transaction history is one week ago.

Example request:

curl -X GET "https://api.buzzex.io/api/v1/trading/trade/history" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.buzzex.io/api/v1/trading/trade/history",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "success": true,
    "data": [
        {
            "pair": "BTC_DOGE",
            "type": "buy",
            "amount": 312559.81791074,
            "rate": 6e-7,
            "order_id": 11541,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "buy",
            "amount": 148235.33322032,
            "rate": 5.9e-7,
            "order_id": 11542,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "buy",
            "amount": 111534.97921034,
            "rate": 5.8e-7,
            "order_id": 11543,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "buy",
            "amount": 26433.40350877,
            "rate": 5.7e-7,
            "order_id": 11544,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "buy",
            "amount": 9966.37411315,
            "rate": 5.6e-7,
            "order_id": 11545,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "sell",
            "amount": 10485.44048348,
            "rate": 6.1e-7,
            "order_id": 11546,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "sell",
            "amount": 271979.07519142,
            "rate": 6.2e-7,
            "order_id": 11547,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "sell",
            "amount": 323292.34153834,
            "rate": 6.3e-7,
            "order_id": 11548,
            "is_your_order": 1,
            "timestamp": 1546586113
        },
        {
            "pair": "BTC_DOGE",
            "type": "sell",
            "amount": 137823.72651094,
            "rate": 6.4e-7,
            "order_id": 11549,
            "is_your_order": 1,
            "timestamp": 1546586113
        }
    ]
}

HTTP Request

GET api/v1/trading/trade/history

HEAD api/v1/trading/trade/history