API Overview

Download OpenAPI Spec

Complete OpenAPI 3.0 specification. Import into Postman, generate client SDKs, or browse the schema directly.

API Structure

Is divided into three main sections:

Market Data

Public, Read-onlyReal-time and historical market data. No authentication required.

Account Queries

Public, UnsignedQuery account state without signatures.

Trading

Authenticated, SignedState-mutating operations requiring Ed25519 signatures. Use bulk-keychain (Node, browser, Python, Rust) for signing.

Base URLs

https://mainnet-api1.bulk.trade/api/v1

wss://mainnet-ws1.bulk.trade

https://exchange-api.bulk.trade/api/v1

wss://exchange-ws1.bulk.trade

Mainnet and testnet are separate networks. Signed transactions must use the matching signature domain.

Quick Start

Query Market Data

No authentication required - start exploring immediately.

curl https://mainnet-api1.bulk.trade/api/v1/exchangeInfo

Check Your Account

Query your positions and orders (no signature needed).

curl -X POST https://mainnet-api1.bulk.trade/api/v1/account \
  -H "Content-Type: application/json" \
  -d '{"type":"fullAccount","user":"FuueqefENiGEW6uMqZQgmwjzgpnb85EgUcZa5Em4PQh7"}'

Get Testnet Funds

Request testnet funds through the testnet endpoint. The faucet is not available on mainnet. See Request Faucet for details.

Place Your First Order

Sign and submit a transaction with the official bulk-keychain library (Node, browser, Python, Rust) or see Transaction Signing for the protocol details.

Field Notation

Bulk uses compact field names to minimize bandwidth :

Short	Full Name	Description
`s`	symbol	Market symbol (e.g., BTC-USD)
`c`	coin	Market symbol in orders
`px`	price	Price level
`sz`	size	Order/position size
`b`	is_buy	Buy/sell direction (true=buy)
`r`	reduce_only	Order only reduces position
`t`	type	Order type object
`oid`	order_id	Order identifier
`tif`	time_in_force	Order lifetime (GTC/IOC/ALO)
`d`	direction	Trigger direction (true=above)
`tr`	trigger	Trigger threshold price
`lim`	limit	Post-trigger limit price
`mk`	maker	Maker/resting flag
`of`	on_fill	On-fill consequent actions

Order Types

Type	Tag	Description	Use Case
Limit	`l`	Resting limit order	Standard GTC/IOC/ALO order
Market	`m`	Immediate execution	Market order at best price
Stop	`st`	Conditional stop	Trigger sell/buy on price break
Take Profit	`tp`	Conditional take-profit	Exit position at target price
Range / OCO	`rng`	One-cancels-other pair	Combined stop + take-profit
Trigger Basket	`trig`	Conditional action list	Execute multiple actions on trigger
Trailing Stop	`trl`	Trailing conditional	Adjusts with favorable price
On-Fill	`of`	Fill-triggered actions	Attach stop/TP after entry fills

Timestamp Format

All timestamps are in milliseconds since Unix epoch (int64) for both HTTP and WebSocket APIs.

Nonce for Signed Transactions: Use nanoseconds for the nonce field: BigInt(Date.now()) * 1_000_000n

Getting Started

Market Data (HTTP)

Account (HTTP - Unsigned)

Trading (HTTP - Signed)

Testnet

WebSocket API

Download OpenAPI Spec

API Structure

Market Data

Account Queries

Trading

Base URLs

Quick Start

Field Notation

Order Types

Timestamp Format

Resources

API Changelog

bulk-keychain

Download OpenAPI Spec

​API Structure

Market Data

Account Queries

Trading

​Base URLs

​Quick Start

​Field Notation

​Order Types

​Timestamp Format

​Resources

API Changelog

bulk-keychain

API Structure

Base URLs

Quick Start

Field Notation

Order Types

Timestamp Format

Resources