API Documentation

Build powerful applications with the BCC nitro API

https://api.BCCnitro.com/v1 REST API v1.0.0

Quickstart

Get started with the BCC nitro API in seconds. All API requests require authentication via API key.

cURL

cURL
curl -H "X-API-Key: your-api-key" \
  https://api.BCCnitro.com/v1/markets

Python

Python
import requests

headers = {"X-API-Key": "your-api-key"}
response = requests.get(
    "https://api.BCCnitro.com/v1/markets",
    headers=headers
)
print(response.json())

JavaScript

JavaScript
const response = await fetch('https://api.BCCnitro.com/v1/markets', {
    headers: { 'X-API-Key': 'your-api-key' }
});
const data = await response.json();
console.log(data);

Authentication

All API requests require an API key passed in the X-API-Key header.

Request Header

Header
X-API-Key: your-api-key

Rate Limits

Limit Type Limit Window
Requests 1000 Per minute
Orders 100 Per minute
WebSocket Connections 10 Per connection

Getting an API Key

Log in to your dashboard and navigate to Settings > API Keys to generate your API key.

Error Codes

The API returns standard HTTP status codes to indicate success or failure.

Code Description Meaning
400Bad RequestThe request was malformed or contains invalid parameters
401UnauthorizedMissing or invalid API key
403ForbiddenYou do not have permission to access this resource
404Not FoundThe requested resource does not exist
429Too Many RequestsRate limit exceeded. Please wait and retry
500Internal Server ErrorSomething went wrong on our end
GET /api/markets List all available markets

Returns a list of all trading pairs available on the platform.

Response

JSON
[
  {
    "symbol": "BTCUSDT",
    "baseAsset": "BTC",
    "quoteAsset": "USDT",
    "price": "67432.50",
    "change": "+2.34",
    "volume": "1250000000"
  },
  {
    "symbol": "ETHUSDT",
    "baseAsset": "ETH",
    "quoteAsset": "USDT",
    "price": "3521.80",
    "change": "+1.89",
    "volume": "850000000"
  }
]
GET /api/markets/{pair}/ticker Get the current ticker for a specific trading pair

Get the current ticker for a specific trading pair.

Parameters

Parameter Type Required Description
pair string Required Trading pair symbol (e.g., BTCUSDT)

Response

JSON
{
  "symbol": "BTCUSDT",
  "price": "67432.50",
  "high": "68100.00",
  "low": "67050.00",
  "volume": "1250000000",
  "change": "+2.34"
}
GET /api/markets/{pair}/orderbook Get the current order book for a trading pair

Get the current order book for a trading pair.

Parameters

Parameter Type Required Description
pair string Required Trading pair symbol (e.g., BTCUSDT)
depth integer Optional Number of orders to return (default: 100)

Response

JSON
{
  "symbol": "BTCUSDT",
  "bids": [
    ["67432.50", "1.500"],
    ["67431.00", "2.300"]
  ],
  "asks": [
    ["67433.00", "0.800"],
    ["67435.00", "1.200"]
  ]
}
POST /api/orders Create a new order

Create a new trading order on the platform.

Request Body

Parameter Type Required Description
pair string Required Trading pair symbol
side string Required "buy" or "sell"
type string Required "market" or "limit"
amount number Required Order amount in base currency
price number Optional Required for limit orders
JSON
{
  "pair": "BTCUSDT",
  "side": "buy",
  "type": "limit",
  "amount": "0.5",
  "price": "67000.00"
}
GET /api/orders List your orders

Retrieve a list of your orders with optional filters.

Query Parameters

Parameter Type Required Description
status string Optional Filter by status: open, filled, cancelled
pair string Optional Filter by trading pair
limit integer Optional Number of orders to return (default: 50)
offset integer Optional Number of orders to skip
GET /api/orders/{id} Get order details

Retrieve the details of a specific order by ID.

Parameters

Parameter Type Required Description
id string Required Order ID
DELETE /api/orders/{id} Cancel an order

Cancel a specific open order by ID.

Parameters

Parameter Type Required Description
id string Required Order ID
GET /api/swap/quote Get a swap quote

Get a quote for swapping one asset to another.

Parameters

Parameter Type Required Description
from string Required Source asset symbol
to string Required Target asset symbol
amount number Required Amount to swap
slippage number Optional Max slippage percentage (default: 0.5)

Response

JSON
{
  "from": "USDT",
  "to": "BTC",
  "fromAmount": "1000.00",
  "toAmount": "0.0148",
  "rate": "67432.50",
  "slippage": "0.5",
  "estimatedGas": "0.002",
  "expiresAt": "2026-05-28T12:30:00Z"
}
POST /api/swap/execute Execute a swap

Execute a swap between two assets.

Request Body

Parameter Type Required Description
from string Required Source asset symbol
to string Required Target asset symbol
amount number Required Amount to swap
slippage number Optional Max slippage percentage (default: 0.5)
walletAddress string Required Destination wallet address

Response

JSON
{
  "status": "completed",
  "fromAmount": "1000.00",
  "toAmount": "0.0148",
  "transactionHash": "0xabc123...def456",
  "explorerUrl": "https://etherscan.io/tx/0xabc123...def456"
}
GET /api/swap/pairs Get supported swap pairs

Get a list of all supported swap pairs.

Response

JSON
[
  {
    "from": "USDT",
    "to": "BTC",
    "minAmount": "10",
    "maxAmount": "100000"
  },
  {
    "from": "USDT",
    "to": "ETH",
    "minAmount": "10",
    "maxAmount": "50000"
  },
  {
    "from": "BTC",
    "to": "ETH",
    "minAmount": "0.001",
    "maxAmount": "100"
  }
]
GET /api/bots List all trading bots

Retrieve a list of all your trading bots.

POST /api/bots Create a new trading bot

Create a new automated trading bot.

Request Body

Parameter Type Required Description
name string Required Bot name
type string Required Bot strategy type (grid, dca, arbitrage)
config object Required Bot configuration parameters
pair string Required Trading pair symbol
amount number Required Investment amount
PUT /api/bots/{id} Update a trading bot

Update the configuration of an existing trading bot.

Parameters

Parameter Type Required Description
id string Required Bot ID
DELETE /api/bots/{id} Delete a trading bot

Delete an existing trading bot.

Parameters

Parameter Type Required Description
id string Required Bot ID
GET /api/portfolio Get portfolio overview

Get an overview of your portfolio including total value, available balance, locked funds, and PnL.

Response

JSON
{
  "totalValue": "32450.00",
  "available": "15000.00",
  "locked": "17450.00",
  "pnl": "+5420.30"
}
GET /api/portfolio/holdings Get portfolio holdings

Get detailed holdings across all your connected wallets.

Response

JSON
[
  {
    "symbol": "BTC",
    "name": "Bitcoin",
    "amount": "0.25",
    "value": "16858.13",
    "chain": "bitcoin"
  },
  {
    "symbol": "ETH",
    "name": "Ethereum",
    "amount": "5.50",
    "value": "19369.90",
    "chain": "ethereum"
  }
]
POST /api/wallet/connect Connect a wallet

Connect a new wallet to your account.

Request Body

Parameter Type Required Description
walletType string Required Type of wallet (trust_wallet, metamask, binance)
address string Required Wallet address
chain string Required Blockchain network
GET /api/wallets List connected wallets

Retrieve a list of all wallets connected to your account.

DELETE /api/wallets/{id} Disconnect a wallet

Disconnect a wallet from your account.

Parameters

Parameter Type Required Description
id string Required Wallet ID
GET /api/auth/me Get user profile

Retrieve the authenticated user's profile information.

POST /api/auth/login Login

Authenticate with email and password to receive an API token.

Request Body

Parameter Type Required Description
email string Required User email address
password string Required User password

WebSocket Streams

Connect to our WebSocket endpoint for real-time market data and order updates.

JavaScript
const ws = new WebSocket('wss://api.BCCnitro.com/ws?apiKey=your-api-key');

Available Streams

Stream Type Description
markets array of strings Subscribe to ticker updates for specific pairs
orders boolean Subscribe to your order updates
portfolio boolean Subscribe to portfolio updates

Example

JavaScript
const ws = new WebSocket('wss://api.BCCnitro.com/ws?apiKey=your-api-key');

ws.onopen = () => {
    ws.send(JSON.stringify({
        type: "subscribe",
        streams: {
            markets: ["BTCUSDT", "ETHUSDT"],
            orders: true,
            portfolio: true
        }
    }));
};

ws.onmessage = (event) => {
    const data = JSON.parse(event.data);
    console.log("Update:", data);
};

Client SDKs

We provide official client SDKs for the most popular programming languages. Use them to integrate with the BCC nitro API in minutes.

Python

Python
pip install BCC-nitro-sdk

JavaScript / TypeScript

npm
npm install @BCCnitro/sdk

Rust

Cargo
cargo add BCC-nitro-sdk

Go

Go
go get github.com/BCCnitro/sdk-go