API Reference

REST API for trading, market data, and strategy management.

Quick Start

Start the API server:

openmm serve --port 3000

Base URL:http://localhost:3000/api/v1

Swagger UI:http://localhost:3000/docs

Full Docs:docs.openmm.io

Supported Exchanges

mexcgateiobitgetkraken

Market Data

Real-time market data from supported exchanges

GET/api/v1/ticker

Get ticker data (price, bid/ask, spread, volume)

exchangesymbol

GET/api/v1/orderbook

Get order book with bids and asks

exchangesymbollimit?

GET/api/v1/trades

Get recent trades with summary stats

exchangesymbollimit?

Account

Account balances and portfolio data

GET/api/v1/balance

Get account balances

exchangeasset?

Orders

Order management (list, create, cancel)

GET/api/v1/orders

List open orders

exchangesymbol?

GET/api/v1/orders/:id

Get order by ID

exchangesymbol

POST/api/v1/orders

Create new order

exchangesymbolsidetypeamountprice?

DELETE/api/v1/orders/:id

Cancel order

exchangesymbol

DELETE/api/v1/orders

Cancel all orders

exchangesymbol?

Grid Strategy

Automated grid trading strategy

POST/api/v1/strategy/grid

Start grid strategy

exchangesymbollowerPriceupperPricegridLevelsorderSize

DELETE/api/v1/strategy/grid

Stop grid strategy

idcancelOrders?

GET/api/v1/strategy/grid/status

Get strategy status

id?

GET/api/v1/strategy/grid/list

List active strategies

Cardano DEX

Cardano token prices and pool discovery via Iris Protocol

GET/api/v1/cardano/price/:symbol

Get Cardano token price in USDT

symbol

GET/api/v1/cardano/pools/:symbol

Discover liquidity pools

symbolminLiquidity?limit?

Price Comparison

Cross-exchange price comparison for arbitrage

GET/api/v1/price/compare

Compare prices across exchanges

symbolexchanges?

Example Request

Get BTC/USDT ticker from MEXC

curl "http://localhost:3000/api/v1/ticker?exchange=mexc&symbol=BTC/USDT"

Response

{
  "exchange": "mexc",
  "symbol": "BTC/USDT",
  "last": 42150.50,
  "bid": 42148.00,
  "ask": 42152.00,
  "spread": 4.00,
  "spreadPercent": 0.0095,
  "baseVolume": 1234.56,
  "timestamp": 1710000000000
}

Full API Documentation GitHub Repository