Navigation Menu

Skip to content

otcbtc/otcbtc-exchange-api-doc

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits

CHANGELOG.md

CHANGELOG.md

 
 

README.md

README.md

 
 

WEB_SOCKET_API.md

WEB_SOCKET_API.md

 
 

Repository files navigation

OTCBTC Official API Documentation

Beta Warning

Please be kindly noticed that currently this version is in BETA and we may keep developing. Some changes would be expected in later versions.

Get Notified of API Update Info

Please check the custom header field Deprecation-Warning in each response. If any endpoint will get updated or deprecated, we will add deprecation information to this field in the response header.

Important Announcement

2018-08-17: All auth endpoints will require nonce as one additional parameter except for access_key and signature. Before 2018-09-30 nonce is not mandatory for all auth endpoints requests, but after 2018-09-30 it is mandatory and error response would be expected without it. For detailed information please check Auth API part.

Web Socket API document

The web socket API document can be found here: https://github.com/otcbtc/otcbtc-exchange-api-doc/blob/master/WEB_SOCKET_API.md

Index

End Point

The base API endpoint is https://bb.otcbtc.com. An alternative is https://bb.otcbtc.io.

Error Message

If API request failed, the response will return HTTP status code, e.g. 400, 401, 404 etc., and detailed error message in JSON format.

  {
    "error": {
      "code": custom_error_message_code, // Not HTTP status code
      "message": detailed_error_message  // Detailed error message
    }
  }

Rate Limiting

For ALL API v2 endpoints, the maximum access rate is 200 requests per minute, any clients initiates more requests will be throttled with status code 429.

Public API

markets

  • URL /api/v2/markets

  • Description Get all available markets.

  • Method: GET

  • Success Response:

    • Code: 200
    • Response Body:
    [
  {
    "id": "btceth",         // Unique marked id.
    "ticker_id": "btc_eth", // Unique ticker id.
    "name": "BTC/ETH"       // market name
    "trading_rule": {
        "min_amount": 0.001,       // Order minimum amount.
        "min_price": 0.000001,     // Order minimum price.
        "min_order_volume": 0.0001 // Order minimum total volume.
    }
  },
  {
    "id": "otbeth",
    "ticker_id": "otb_eth",
    "name": "OTB/ETH"
  },
  {
    "id": "eoseth",
    "ticker_id": "eos_eth",
    "name": "EOS/ETH"
  },
  {
    "id": "bcheth",
    "ticker_id": "bch_eth",
    "name": "BCH/ETH"
  },
  ...
]

tickers

  • URL /api/v2/tickers

  • Description Get ticker of all markets.

  • Method: GET

  • Success Response:

    • Code: 200
    • Response Body:
    {
  "btc_eth": {
    "at": 1517833531,        // An integer represents the seconds elapsed since Unix epoch.
    "ticker": {
      "buy": "9.0000008",    // Latest bid price
      "sell": "9.78949997",  // Latest ask price
      "low": "8.65100033",   // Lowest price within last 24 hours
      "high": "9.79999439",  // Highest Price within last 24 hours
      "last": "9.0000008",   // Last trade's price
      "vol": "13.37148291".  // Trade volume within last 24 hours
    }
  },
  "otb_eth": {
    "at": 1517833531,
    "ticker": {
      "buy": "0.0011599",
      "sell": "0.00116",
      "low": "0.00109301",
      "high": "0.00116",
      "last": "0.00116",
      "vol": "71236.11349855"
    }
  },
  ...
}

tickers{market}

  • URL /api/v2/tickers/{market_id}

  • Description Get ticker of specific market.

  • Method: GET

  • Example Request:

    • Request: GET /api/v2/tickers/otbeth

    • Success Response:

      • Code: 200
      • Content:
      {
  "at": 1517833531,           // An integer represents the seconds elapsed since Unix epoch.
  "ticker": {
    "buy": "0.0011599",       // Latest bid price
    "sell": "0.00116",        // Latest ask price
    "low": "0.00109301",      // Lowest price within last 24 hours
    "high": "0.00116",        // Highest Price within last 24 hours
    "last": "0.00116",        // Last trade's price
    "vol": "71236.11349855"   // Trade volume within last 24 hours
  }
}

depth

  • URL /api/v2/depth

  • Description Get the depth information of specified market.

  • Method: GET

  • Parameters

    • market(required): Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets.

    • limit: Limit the number of returned price levels. Default to 300, minimum value: 1, maximum value: 1000.

  • Example Request:

    • Request: GET /api/v2/depth?market=otbeth&limit=2

    • Success Response:

      • Code: 200
      • Content:
      {
    "timestamp": 1528722917,  // Unix timestamp
    "asks": [
        [
            "0.00072214",     // Price
            "507.64233312"    // Volume
        ],
        [
            "0.00072213",
            "635.99314234"
        ]
    ],
    "bids": [
        [
            "0.0007013",
            "3709.62342791"
        ],
        [
            "0.00070117",
            "144.23891495"
        ]
    ]
}

trades

  • URL /api/v2/trades

  • Description Get recent trades on market, each trade is included only once. Trades are sorted in reverse creation order.

  • Method: GET

  • Parameters

    • market(required): Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets.

    • limit: Limit the number of returned price levels. Default to 50.

    • timestamp: An integer represents the seconds elapsed since Unix epoch. If set, only trades executed before the time will be returned.

    • from: Trade id. If set, only trades created after the trade will be returned.

    • to: Trade id. If set, only trades created before the trade will be returned.

    • order_by: If set, returned trades will be sorted in specific order, default to 'desc’.

  • Example Request:

    • Request: GET /api/v2/trades?market=otbeth&limit=1&order_by=desc

    • Success Response:

      • Code: 200
      • Content:
      [
  {
    "id": 25073,                               // Unique trade id
    "price": "0.00116",                        // Trade's price
    "volume": "473.3586",                      // Trade's volume
    "funds": "0.549095976",                    // Trade's funds, calculated by price * volume
    "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
    "created_at": "2018-02-05T20:45:22+08:00", // Order create time in iso8601 format.
    "at": 1517834722,                          // An integer represents the seconds elapsed since Unix epoch.
    "side": "up"                               // Trade's side, 'up' means the price is higher than the previous one, 'down' is lower than the previous one
  }
]

timestamp

  • URL /api/v2/timestamp

  • Description Get server current time, in seconds since Unix epoch.

  • Method: GET

  • Example Request:

    • Request: GET /api/v2/timestamp

    • Success Response:

      • Code: 200
      • Content:
      1517740381

klines

  • URL /api/v2/klines

  • Description Get OHLC(k line) of specific market.

  • Method: GET

  • Parameters

    • market(required): Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets.

    • limit: Limit the number of returned price levels. Default to 30.

    • period: Time period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080. Default value : 1

    • timestamp: An integer represents the seconds elapsed since Unix epoch. If set, only k-line data after that time will be returned.

  • Example Request:

    • Request: GET /api/v2/klines?market=otbeth&limit=2&period=1

    • Success Response:

      • Code: 200
      • Content:
      [
  [
    1517833860, // An integer represents the seconds elapsed since Unix epoch.
    0.001159,   // K line open price
    0.001162,   // K line highest price
    0.001157,   // K line lowest price
    0.001158,   // K line close price
    1000        // K line volume
  ],
  [
    1517833920,
    0.001142,
    0.001160,
    0.001142,
    0.001159,
    500
  ]
]

klines_with_pending_trades

  • URL /api/v2/klines_with_pending_trades

  • Description Get K data with pending trades, which are the trades not included in K data yet, because there’s delay between trade generated and processed by K data generator.

  • Method: GET

  • Parameters

    • market(required): Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets.

    • trade_id(required): The trade id of the first trade you received.

    • limit: Limit the number of returned price levels. Default to 30.

    • period: Time period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080. Default value : 1

    • timestamp: An integer represents the seconds elapsed since Unix epoch. If set, only k-line data after that time will be returned.

  • Example Request:

    • Request: GET /api/v2/klines_with_pending_trades?market=otbeth&trade_id=1&period=1

    • Success Response:

      • Code: 200
      • Content:
      {
  "k": [
    [
      1517833860,
      0.001159,   // K line open price
      0.001162,   // K line highest price
      0.001157,   // K line lowest price
      0.001158,   // K line close price
      1000        // K line volume
    ]
  ],
  "trades": [
    {
      "id": 25073,                               // Unique trade id
      "price": "0.00116",                        // Trade's price
      "volume": "473.3586",                      // Trade's volume
      "funds": "0.549095976",                    // Trade's funds, calculated by price * volume
      "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
      "created_at": "2018-02-05T20:45:22+08:00", // Order create time in iso8601 format.
      "at": 1517834722,                          // An integer represents the seconds elapsed since Unix epoch till the trade create time.
      "side": "up"                               // Trade's side, 'up' means the price is higher than the previous one, 'down' is lower than the previous one
    }
  ]
}

Auth API

auth endpoints requires 3 extra authentication parameters:

  • access_key: your api key
  • nonce(required): Current timestamp to milisecond (13 digits). For example in Javascript you can get it by calling + new Date(), and have 1532422489533 as the result for nonce. Server will only accept nonce within time window of ± 30 seconds.
  • signature: can be generated by HMAC-SHA256(payload, your_api_secret).to_hex

    • payload is a string represents this request, combiled with HTTP method, request URI and request parameters:

      • HTTP method: e.g. "GET", "POST", etc
      • request URI: such as "/users/me", or "trades/my"
      • request parameters: parameters concated with "&", MUST BE IN ALPHABETICAL ORDER by parameters' name.

      Then concat the above 3 strings with |, you get the payload.

For example:

if your api key is xxx, and your api secret is yyy, then the payload is GET|/api/v2/users/me|access_key=xxx&nonce=1532422489533.

The signature is then calculated: 2ef04a000121ec67ad712b8437a5b3970bb713dd6a534890e7500ffda7848ba7

And you can make the request:

GET /api/v2/users/me?access_key=xxx&nonce=1532422489533&signature=2ef04a000121ec67ad712b8437a5b3970bb713dd6a534890e7500ffda7848ba7

The following endpoints requires these 3 authentication parameters.

users

  • URL /api/v2/users/me

  • Description Get your profile and accounts info.

  • Method: GET

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

  • Example Request:

    • Request: Please refer to the above example.

    • Success Response:

      • Code: 200
      • Response Body:
      {
  "user_name": "u1513250056",             // your user name
  "email": "u1513250056@gmail.com",       // your email
  "icon": "/images/user_default_pic.png", // your icon image path
  "otb_fee_enabled": true,                // whether use OTB to pay for fees or not
  "accounts": [                           // your account information
    {
      "currency": "btc",                  // your BTC account
      "balance": "0.01",                  // your current BTC balance amount
      "locked": "0.001",                  // your current BTC locked amount
      "saving": "0.0"                     // your current BTC saving amount
    },
    {
      "currency": "otb",
      "balance": "1000.0",
      "locked": "200.0",
      "saving": "0.0"
    },
    ...
  ]
}

account

  • URL /api/v2/account

  • Description Get one of your specific accounts information.

  • Method: GET

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • currency(required): The account currency.

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: GET|/api/v2/account|access_key=xxx&currency=btc&nonce=1532422489533

    • Calculated signature: cd9afcb8a0167afc02274efcb23affef4f981b8262c709b9a1414e50b02061f3

    • Example Request: GET https://bb.otcbtc.com/api/v2/account?access_key=xxx&currency=btc&nonce=1532422489533&signature=cd9afcb8a0167afc02274efcb23affef4f981b8262c709b9a1414e50b02061f3

    • Success Response:

      • Code: 200
      • Response Body:
      {
  "currency": "btc",             // your BTC account
  "balance": "0.01",             // your current BTC balance amount
  "locked": "0.001",             // your current BTC locked amount
  "saving": "0.0"                // your current BTC saving amount
}

list_orders

  • URL /api/v2/orders

  • Description Get your orders, results is paginated.

  • Method: GET

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • market: Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets. If left blank, the api will return your orders of all markets.

    • state: Filter order by state, default to ‘wait’ (active orders). Other options:‘cancel’, ‘done’

    • limit: Limit the number of returned price levels. Default to 100.

    • page: Specify the page of paginated results. Default value: 1

    • order_by: If set, returned trades will be sorted in specific order, default to 'asc’.

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: GET|/api/v2/orders|access_key=xxx&market=otbeth&nonce=1532422489533

    • Calculated signature: f56ae68d3296972f87f03fc5915325fee2cc5eae6198aa8e0147cd8dc3a1eb19

    • Example Request: GET https://bb.otcbtc.com/api/v2/orders?access_key=xxx&market=otbeth&nonce=1532422489533&signature=f56ae68d3296972f87f03fc5915325fee2cc5eae6198aa8e0147cd8dc3a1eb19

    • Success Response:

      • Code: 200
      • Response Body:
      [
  {
    "id": 1,                                   // Unique order id.
    "side": "buy",                             // Either 'sell' or 'buy'.
    "ord_type": "limit",                       // Type of order, now only 'limit'.
    "price": "0.002",                          // Price for each unit. e.g. If you sell/buy 1 OTB at 0.002 ETH, the price is '0.002'
    "avg_price": "0.0",                        // Average execution price, average of price in trades.
    "state": "wait",                           // One of 'wait', 'done', or 'cancel'. An order in 'wait' is an active order, waiting fullfillment; a 'done' order is an order fullfilled; 'cancel' means the order has been cancelled.
    "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
    "created_at": "2017-02-01T00:00:00+08:00", // Order create time in iso8601 format.
    "volume": "100.0",                         // The amount user want to sell/buy. An order could be partially executed, e.g. an order sell 100 otb can be matched with a buy 60 otb order, left 40 otb to be sold; in this case the order's volume would be '100.0', its remaining_volume would be '40.0', its executed volume is '60.0'.
    "remaining_volume": "100.0",               // The remaining volume
    "executed_volume": "0.0",                  // The executed volume
    "trades_count": 1                          // Counts of trades under this order
  },
  {
    "id": 3,
    "side": "sell",
    "ord_type": "limit",
    "price": "0.003",
    "avg_price": "0.0",
    "state": "wait",
    "market": "otbeth",
    "created_at": "2017-02-01T00:00:00+08:00",
    "volume": "100.0",
    "remaining_volume": "100.0",
    "executed_volume": "0.0",
    "trades_count": 0
  }
]

list_order

  • URL /api/v2/order

  • Description Get information of specified order.

  • Method: GET

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • id(required): Unique order id.

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: GET|/api/v2/order|access_key=xxx&id=1&nonce=1532422489533

    • Calculated signature: 9bdacb1fbd0c86cbea2aa86edfa067abd01705254c6440f6d04e7d0c84cf3e24

    • Example Request: GET https://bb.otcbtc.com/api/v2/order?access_key=xxx&id=1&nonce=1532422489533&signature=9bdacb1fbd0c86cbea2aa86edfa067abd01705254c6440f6d04e7d0c84cf3e24

    • Success Response:

      • Code: 200
      • Response Body:
      {
  "id": 1,                                   // Unique order id.
  "side": "buy",                             // Either 'sell' or 'buy'.
  "ord_type": "limit",                       // Type of order, now only 'limit'.
  "price": "0.002",                          // Price for each unit. e.g. If you sell/buy 1 OTB at 0.002 ETH, the price is '0.002'
  "avg_price": "0.0",                        // Average execution price, average of price in trades.
  "state": "wait",                           // One of 'wait', 'done', or 'cancel'. An order in 'wait' is an active order, waiting fullfillment; a 'done' order is an order fullfilled; 'cancel' means the order has been cancelled.
  "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
  "created_at": "2017-02-01T00:00:00+08:00", // Order create time in iso8601 format.
  "volume": "100.0",                         // The amount user want to sell/buy. An order could be partially executed, e.g. an order sell 100 otb can be matched with a buy 60 otb order, left 40 otb to be sold; in this case the order's volume would be '100.0', its remaining_volume would be '40.0', its executed volume is '60.0'.
  "remaining_volume": "100.0",               // The remaining volume
  "executed_volume": "0.0",                  // The executed volume
  "trades_count": 1                          // Number of trades under this order
}

create_order

  • URL /api/v2/orders

  • Description Create a Sell/Buy order.

  • Method: POST

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • market(required): Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets.

    • side(required): Either ‘sell’ or 'buy’.

    • volume(required): The amount user want to sell/buy. An order could be partially executed, e.g. an order sell 100 otb can be matched with a buy 60 otb order, left 40 otb to be sold; in this case the order’s volume would be '100.0’, its remaining_volume would be '40.0’, its executed volume is '60.0’.

    • price: Price for each unit. e.g. If you want to sell/buy 1 otb at 0.002 ETH, the price is ‘0.002’.

    • ord_type: Type of order, now only 'limit'.

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: POST|/api/v2/orders|access_key=xxx&market=otbeth&nonce=1532422489533&price=0.002&side=sell&volume=100

    • Calculated signature: ceecb86aff743874ec5e40751b133459e78831e6000b6fb48b6b9d38b9360a96

    • Example Request: POST https://bb.otcbtc.com/api/v2/orders

    • Example Request Body (form-data):

        "market": "otbeth",
  "nonce": "1532422489533",
  "side": "sell",
  "volume": "100",
  "price": "0.002",
  "access_key": "xxx",
  "signature": "ceecb86aff743874ec5e40751b133459e78831e6000b6fb48b6b9d38b9360a96"

    • Success Response:

      • Code: 200
      • Response Body:
      {  
   "id": 1,                                   // Unique order id. 
   "side": "sell",                            // Either 'sell' or 'buy'.
   "ord_type": "limit",                       // Type of order, now only 'limit'.
   "price": "0.002",                          // Price for each unit. e.g. If you sell/buy 100 OTB at 0.002 ETH, the price is '0.002'.
   "avg_price": "0.0",                        // Average execution price, average of price in trades.
   "state": "wait",                           // One of 'wait', 'done', or 'cancel'. An order in 'wait' is an active order, waiting fullfillment; a 'done' order is an order fullfilled; 'cancel' means the order has been cancelled.
   "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
   "created_at": "2017-02-01T00:00:00+08:00", // Trade create time in iso8601 format.
   "volume": "100.0",                         // The amount user want to sell/buy. An order could be partially executed, e.g. an order sell 100 otb can be matched with a buy 60 otb order, left 40 otb to be sold; in this case the order's volume would be '100.0', its remaining_volume would be '40.0', its executed volume is '60.0'.
   "remaining_volume": "100.0",               // The remaining volume
   "executed_volume": "0.0",                  // The executed volume
   "trades_count": 0                          // Number of trades under this order
}

cancel_order

  • URL /api/v2/order/delete

  • Description Cancel an order.

  • Method: POST

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • id(required): Unique order id.

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: POST|/api/v2/order/delete|access_key=xxx&id=1&nonce=1532422489533

    • Calculated signature: 9bc87002bd76354c3f70c22b17118100686d19357fdb84df6d310afc80cd9c98

    • Example Request: POST https://bb.otcbtc.com/api/v2/order/delete

    • Example Request Body (form-data):

        "id": "1",
  "access_key": "xxx",
  "nonce": "1532422489533"
  "signature": "9bc87002bd76354c3f70c22b17118100686d19357fdb84df6d310afc80cd9c98"

    • Success Response:

      • Code: 200
      • Response Body:
      {  
   "id": 1,                                   // Unique order id. 
   "side": "buy",                             // Either 'sell' or 'buy'.
   "ord_type": "limit",                       // Type of order, now only 'limit'.
   "price": "0.002",                          // Price for each unit. e.g. If you sell/buy 100 OTB at 0.002 ETH, the price is '0.002'.
   "avg_price": "0.0",                        // Average execution price, average of price in trades.
   "state": "wait",                           // One of 'wait', 'done', or 'cancel'. An order in 'wait' is an active order, waiting fullfillment; a 'done' order is an order fullfilled; 'cancel' means the order has been cancelled.
   "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
   "created_at": "2017-02-01T00:00:00+08:00", // Trade create time in iso8601 format.
   "volume": "100.0",                         // The amount user want to sell/buy. An order could be partially executed, e.g. an order sell 100 otb can be matched with a buy 60 otb order, left 40 otb to be sold; in this case the order's volume would be '100.0', its remaining_volume would be '40.0', its executed volume is '60.0'.
   "remaining_volume": "100.0",               // The remaining volume
   "executed_volume": "0.0",                  // The executed volume
   "trades_count": 0                          // Number of trades under this order
}

cancel_orders

  • URL /api/v2/orders/clear

  • Description Cancel all your orders.

  • Method: POST

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • side: If present, only sell orders (asks) or buy orders (bids) will be canncelled. Vaules: 'sell', 'buy'

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: POST|/api/v2/orders/clear|access_key=xxx&nonce=1532422489533

    • Calculated signature: a51aae4afa4149abc2894c48c0a54f5cfd7e6e206d63c30a5fd2ffad9bb9afb5

    • Example Request: POST https://bb.otcbtc.com/api/v2/orders/clear

    • Example Request Body (form-data):

        "access_key": "xxx",
  "nonce": "1532422489533",
  "signature": "a51aae4afa4149abc2894c48c0a54f5cfd7e6e206d63c30a5fd2ffad9bb9afb5"

    • Success Response:

      • Code: 200
      • Response Body:
      [  
   {  
      "id": 2,                                       // Unique order id. 
      "side": "buy",                                 // Either 'sell' or 'buy'.
      "ord_type": "limit",                           // Type of order, now only 'limit'.
      "price": "0.0015",                             // Price for each unit. e.g. If you sell/buy 100 OTB at 0.0015 ETH, the price is '0.0015'.         
      "avg_price": "0.0",                            // Average execution price, average of price in trades.
      "state": "wait",                               // One of 'wait', 'done', or 'cancel'. An order in 'wait' is an active order, waiting fullfillment; a 'done' order is an order fullfilled; 'cancel' means the order has been cancelled.
      "market": "otbeth",                            // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
      "created_at": "2017-02-01T00:00:00+08:00",     // Trade create time in iso8601 format.
      "volume": "100.0",                             // The amount user want to sell/buy. An order could be partially executed, e.g. an order sell 100 otb can be matched with a buy 60 otb order, left 40 otb to be sold; in this case the order's volume would be '100.0', its remaining_volume would be '40.0', its executed volume is '60.0'.
      "remaining_volume": "60.0",                    // The remaining volume
      "executed_volume": "40.0",                     // The executed volume
      "trades_count": 1                              // Number of trades under this order
   },
   {  
      "id":1,
      "side":"sell",
      "ord_type":"limit",
      "price":"0.0012",
      "avg_price":"0.0",
      "state":"wait",
      "market":"otbeth",
      "created_at":"2017-02-01T00:00:00+08:00",
      "volume": "100.0",
      "remaining_volume":"100.0",
      "executed_volume":"0.0",
      "trades_count":0
   }
]

My Trades

  • URL /api/v2/trades/my

  • Description Get your executed trades. Trades are sorted in reverse creation order.

  • Method: GET

  • Parameters

    • access_key(required): Access key.

    • nonce(required): Current timestamp to milisecond (13 digits).

    • signature(required): The signature of your request payload, generated using your secret key.

    • market(required): Unique market id. It’s always in the form of xxxyyy, where xxx is the base currency code, yyy is the quote currency code, e.g. 'otbeth’. All available markets can be found at /api/v2/markets.

    • limit: Limit the number of returned trades. Default to 50. Range 1..1000

    • timestamp: An integer represents the seconds elapsed since Unix epoch. If set, only trades executed before the time will be returned.

    • from: Trade id. If set, only trades created after the trade will be returned.

    • to: Trade id. If set, only trades created before the trade will be returned.

    • order_by:If set, returned trades will be sorted in specific order, default to 'desc'. Values: 'asc', 'desc'

  • Example Request:

    • Access Key: xxx

    • Secret Key: yyy

    • payload: GET|/api/v2/trades/my|access_key=xxx&market=otbeth&nonce=1532422489533

    • Calculated signature: 1aaf9c0f311b1706e9f535c034795b2854ff726139ac64a13348f84cbc7ce42d

    • Example Request: GET https://bb.otcbtc.com/api/v2/trades/my?access_key=xxx&market=otbeth&signature=1aaf9c0f311b1706e9f535c034795b2854ff726139ac64a13348f84cbc7ce42d

    • Success Response:

      • Code: 200
      • Response Body:
      [  
   {  
      "id": 2,                                   // Unique trade id. 
      "price": "0.0015",                         // Price for each unit. e.g. If you sell/buy 2 OTB at 0.0015 ETH, the price is '0.0015'.
      "volume": "2.0",                           // The amount of base unit. e.g. If you sell/buy 2 OTB at 0.0015 ETH, the volume is '2.0'.
      "funds": "0.003",                          // The amouut of quote unit. e.g. If you sell/buy 2 OTB at 0.0015 ETH, the funds is '0.003' ETH.
      "market": "otbeth",                        // The market in which the order is placed, e.g. 'otbeth'. All available markets can be found at /api/v2/markets.
      "created_at": "2017-01-31T00:00:00+08:00", // Trade create time in iso8601 format.
      "at": 1485792000,                          // An integer represents the seconds elapsed since Unix epoch.
      "side": "bid",                             // Either 'bid' or 'ask'.
      "order_id": 3                              // Unique order id. 
   },
   {  
      "id": 1,
      "price": "0.0018",
      "volume": "1.0",
      "funds": "0.0018",
      "market": "otbeth",
      "created_at": "2017-01-30T00:00:00+08:00",
      "at": 1485705600,
      "side": "ask",
      "order_id": 1
   }
]

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

117 stars

Watchers

16 watching

Forks

22 forks
Report repository

Releases

No releases published

Packages

No packages published