BiKi Exchange API Documentation: A Complete Guide for Developers

ยท

Welcome to the comprehensive guide for BiKi Exchange's API integration. This document provides detailed instructions on accessing market data, executing trades, and managing orders programmatically through BiKi's robust API system.

Getting Started with BiKi API

BiKi Exchange offers a powerful yet user-friendly API interface that enables developers to:

Creating Your API Keys

To begin using BiKi's API services:

  1. Register an account on BiKi Exchange
  2. Navigate to User Center โ†’ API Management
  3. Generate your unique API Key and Secret Key combination

Security Notice:

  • Each account can create up to 5 API keys
  • Never share your API Key or Secret Key with anyone
  • For enhanced security, bind your API keys to specific IP addresses (maximum 5 IPs per key)

API Connection Methods

BiKi supports two primary connection protocols:

1. REST API

2. WebSocket API

๐Ÿ‘‰ Learn more about WebSocket connections

Server Locations and Performance

BiKi's servers are located in Tokyo. For optimal performance:

REST API Specifications

Base URLs

Primary endpoints for REST API access:

Request Headers

All REST API requests must include:

Content-Type: application/x-www-form-urlencoded

Status Codes Reference

CodeDescriptionNotes
0Success
5Order failedCheck price/quantity precision
6Quantity below minimum
7Quantity above maximum
8Cancel order failed
9Trading frozen
13System error
19Insufficient balance
22Order not found
23Missing quantity parameter
24Missing price parameter
10034Insufficient balance
10062Precision exceeds limit
10063Quantity below minimum
10064Price/amount below minimum
10067Price beyond daily limit
10068Order size exceeds limit
10069Order frequency too high
10071Market orders not allowed
100001System exception
100002System maintenance
100004Invalid parameters
100005Signature error
100007Unauthorized IP
110004Withdrawal frozen
110025Account locked
110041API rate limit exceeded

Authentication Process

All private API requests require digital signature authentication:

  1. Sort parameters alphabetically by name
  2. Concatenate parameter names and values
  3. Append Secret Key to the concatenated string
  4. Generate MD5 hash (32-bit, lowercase)
  5. Include signature in request parameters

Example signature generation:

MD5(api_key0816016bb06417f50327e2b557d39aaatime156200607ab5bba291b8e1cabd8009c2ce6aabdb3)

Resulting in:

sign = 5fcf02e226a4bb2fb180be2aaa6fe541

๐Ÿ‘‰ See detailed authentication examples

Complete REST API Reference

Public Endpoints (No Authentication Required)

EndpointDescriptionRate Limit
GET /open/api/common/symbolsList all trading pairs10/sec
GET /open/api/get_alltickerMarket tickers10/sec
GET /open/api/marketLatest prices10/sec
GET /open/api/get_tickerSpecific pair data10/sec
GET /open/api/get_tradesTrade history10/sec
GET /open/api/get_recordsK-line data10/sec
GET /open/api/market_deptOrder book depth10/sec

Private Endpoints (Require Authentication)

EndpointDescriptionRate Limit
GET /open/api/user/accountAccount balance10/sec
GET /open/api/v2/new_orderCurrent orders10/sec
GET /open/api/v2/all_orderAll orders10/sec
GET /open/api/all_tradeTrade history10/sec
GET /open/api/order_infoOrder details10/sec
POST /open/api/create_orderCreate order100/10sec
POST /open/api/cancel_orderCancel order100/10sec
POST /open/api/cancel_order_allCancel all orders100/10sec
POST /open/api/mass_replaceV2Batch order operations100/10sec

Frequently Asked Questions

Q: How do I handle API rate limits?
A: BiKi implements strict rate limits to ensure system stability. Monitor your request frequency and implement proper throttling in your application.

Q: What's the recommended way to get real-time data?
A: For real-time updates, use WebSocket API instead of polling REST endpoints. This provides instant updates and reduces API calls.

Q: How secure are API keys?
A: API keys provide full access to your account. Always store them securely, enable IP restrictions, and rotate keys periodically.

Q: What should I do if I get an authentication error?
A: Double-check your signature generation process, timestamp synchronization, and parameter ordering. Ensure your Secret Key hasn't been compromised.

Q: Is there a sandbox/test environment?
A: Currently, BiKi doesn't offer a public sandbox environment. Test with small amounts in live trading.

Q: How do I handle decimal precision?
A: Always respect the precision values returned by the /common/symbols endpoint to avoid order rejection.