roq-upbit#

Important

This gateway needs sponsorship to complete certain features.

Links#

Purpose#

Maintain network connectivity with the UPbit exchange
Route exchange updates to connected clients
Route client requests to the relevant exchange accounts
Stream all messages to an event-log

Overview#

Products

Spot	✓
Futures
Options

Market Data

Reference Data
Market Status	✓
Top of Book
Market by Price (L2)	✓
Market by Order (L3)
Trade Summary	✓
Statistics	✓

Order Management

Create	✓
Modify
Cancel	✓
Cancel All
Auto Cancellation

Account Management

Positions
Funds	✓

Data center located in: TBD

Conda#

Using Conda

Install

$ mamba install \
  --channel https://roq-trading.com/conda/stable \
  roq-upbit

Configure

$ cp $CONDA_PREFIX/share/roq-upbit/config.toml $CONFIG_FILE_PATH

# Then modify $CONFIG_FILE_PATH to match your specific configuration

Run

$ roq-upbit \
      --name "upbit" \
      --config_file "$CONFIG_FILE_PATH" \
      --client_listen_address "$UNIX_SOCKET_PATH" \
      --service_listen_address "$TCP_LISTEN_PORT" \
      --flagfile "$FLAG_FILE"

Config#

Common Config

Flags#

CLI

$ roq-upbit --help

Environments#

Prod

# flagfile

--rest_uri=https://api.upbit.com
--ws_public_uri=wss://api.upbit.com/websocket/v1

Market Data#

Live

Event	Stream	Messages
`roq::ReferenceData`
`roq::MarketStatus`	MarketData	ticker
`roq::TopOfBook`
`roq::MarketByPriceUpdate`	MarketData	orderbook
`roq::MarketByOrderUpdate`
`roq::TradeSummary`	MarketData	trade
`roq::StatisticsUpdate`	MarketData	ticker

Download

Event	Stream	Messages
`roq::ReferenceData`	Rest	/v1/market/all
`roq::MarketStatus`
`roq::TopOfBook`
`roq::MarketByPriceUpdate`
`roq::MarketByOrderUpdate`
`roq::TradeSummary`
`roq::StatisticsUpdate`

Statistics#

Type	Comments
`OPEN_PRICE`	(ticker) `opening-price`
`HIGHEST_TRADED_PRICE`	(ticker) `high_price`
`LOWEST_TRADED_PRICE`	(ticker) `low_price`
`CLOSE_PRICE`	(ticker) `trade_price`
`TRADE_VOLUME`	(ticker) `trade_volume`

Order Management#

Live

Event	Stream	Messages	Comments
`roq::OrderUpdate`
`roq::TradeUpdate`

Download

Event	Stream	Messages	Comments
`roq::OrderUpdate`
`roq::TradeUpdate`

Request

Event	Stream	Messages	Comments
`roq::CreateOrder`
`roq::ModifyOrder`
`roq::CancelOrder`
`roq::CancelAllOrders`

Response

Event	Stream	Messages	Comments
`roq::OrderAck`

Order Types#

Time in Force#

Position Effect#

Execution Instructions#

Account Management#

Live

Event	Stream	Messages	Comments
`roq::PositionUpdate`
`roq::FundsUpdate`

Download

Event	Stream	Messages	Comments
`roq::PositionUpdate`
`roq::FundsUpdate`

Streams#

Rest

Type	Comments
REST	Primary purpose discover the full list of symbols

MarketData

Type	Comments
WebSocket	Primary purpose live market data Each connection supports a slice of the symbols

Type

Comments

WebSocket

Primary purpose

live market data

Each connection

supports a slice of the symbols

Constraints#

We are not currently using WebSocket compression negotiation

Comments#

All orderbook updates are full snapshot. We need to translate into incremental update.