Skip to content

Interface_Documentation

Quick Start

Restful API

Public Interface

User Interface

Order Interface

WebSocket API

WebSocket Introduction

Public Interface

User Interface

Order Interface

Preparing for Access

If you need to use the API, please login to complete the application of the API key and the configuration, and then develop and trade according to the details of this document.

You can click here to create an API key.

Please make sure to remember the following information after you have successfully created the API Key:

  • APIKey: Identity for API transactions, generated by random algorithm.
  • SecretKey: private key, randomly generated by the system, used for signature generation.

Risks: These two keys are closely related to the security of your account, please keep in mind that do not disclose them to others at any time. Any leakage of these two keys may cause loss of your assets. If you find any leakage of APIKey, please delete the APIKey as soon as possible.

Interface Type

  • Public
  • Private Interface
Public Interface

Public interface can be used to obtain configuration information and market data. Public requests can be invoked without authentication.

private interface

Private interface can be used for order management and account management. Each private request must be [signed] ( sign.md) using a canonical form of authentication. The private interface requires authentication using your APIKey.

API domain name

You can do this yourself using the Rest API access method.

Domain Name REST API
Primary Domain https://openapi.bitunix.com

API Validation

The header of all REST requests must contain the following keys:

  • api-key: api-key of the request
  • nonce: random string, 32-bit, generated by the caller
  • timestamp: current timestamp, milliseconds
  • sign: signature string (see signature description)
  • Content-Type: Uniformly set to application/json.

Interaction Request

All requests are based on the Https protocol, the Content-Type in the POST request header should be set to: ' application/json'.

Description of Interaction Request
  • Request parameter: encapsulate the parameter according to the request parameter of the interface.
  • Submit request parameters: submit the encapsulated request parameters to the server via GET/POST.
  • Server Response: The server first performs parameter security verification on the user request data and returns the response data in JSON format to the user according to the business logic after passing the verification.
  • Data Processing: Process the response data from the server.
Success

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

Common Error Codes
  • 400 Bad Request - Invalid request format
  • 403 Forbidden - You do not have access to the requested resource.
  • 404 Not Found No request found
  • 500 Internal Server Error - We had a problem with our server Server internal error; if failed body with error description message
  • See Error Code for more details.

standardized specification

Timestamp

The timestamp in the request signature is in milliseconds and is standardized to UTC time. The timestamp of the request must be within 60 seconds of the API service time, otherwise the request will be considered expired and rejected.

Request Formats

Currently there are only two request formats: GET and POST.

  • GET: Parameters are transferred to the server via queryString in the path.
  • POST: Parameters are transferred to the server by sending body in json format.