Introduction
Welcome to the BigONE Developer API — a comprehensive suite of REST APIs for integrating BigONE's trading services into your applications.
API Services
BigONE provides four main API services:
| Service | Description | Base URL |
|---|---|---|
| Spot Trading | Order Management, Market Data, Account Balance | https://api.big.one/api/v3 |
| Wallet | Deposits, withdrawals, transfers | https://api.big.one/api/v3 |
| Convert | Instant asset conversion (flash swap) | https://api.big.one/sapi/v1/convert |
| Contract | Contract and derivatives trading | https://api.big.one/api/contract/v2 |
Key Features
- RESTful Design: Clean, predictable API endpoints following standard HTTP conventions
- JWT Authentication: Secure token-based authentication for private endpoints
- Real-time Data: WebSocket streams for market data and order updates
- Comprehensive Market Data: Asset pairs, tickers, order books, trades, and candles
Getting Started
New to the BigONE API? Follow this path:
- Getting Started — Learn the basics in 5 minutes
- API Key Setup — Create your API credentials
- Authentication — Implement JWT authentication
- General Information — Understand rate limits and response formats
Quick Example
Here's a simple example to fetch the current BTC-USDT ticker:
curl "https://api.big.one/api/v3/asset_pairs/BTC-USDT/ticker"
# Response
{
"code": 0,
"data": {
"asset_pair_name": "BTC-USDT",
"bid": {
"price": "87811.79",
"order_count": 1,
"quantity": "0.001429"
},
"ask": {
"price": "87820.58",
"order_count": 1,
"quantity": "0.001844"
},
"open": "87968.1",
"high": "90349.99",
"low": "86818.2",
"close": "87792.67",
"volume": "2175.974168",
"daily_change": "-175.43"
}
}
Support
If you encounter issues while using the API:
- Telegram Group: Join @bigapi for real-time support and community discussions
- Documentation: Browse the API Reference for detailed endpoint documentation
- Error Codes: See Error Codes for troubleshooting
Best Practice
Place your servers in Hong Kong or Tokyo regions for the most stable connection and lowest latency to BigONE's API infrastructure.