roq-bitget#

Important

PLACEHOLDER! This gateway is in early development.

Purpose#

  • Maintain network connectivity with the Bitget 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#

$ mamba install \
  --channel https://roq-trading.com/conda/stable \
  roq-bitget
$ cp $CONDA_PREFIX/share/roq-bitget/config.toml $CONFIG_FILE_PATH

# Then modify $CONFIG_FILE_PATH to match your specific configuration
$ roq-bitget \
      --name "bitget" \
      --config_file "$CONFIG_FILE_PATH" \
      --client_listen_address "$UNIX_SOCKET_PATH" \
      --service_listen_address "$TCP_LISTEN_PORT" \
      --flagfile "$FLAG_FILE"

Config#

Flags#

$ roq-bitget --help
--exchange (bitget)

exchange identifier (string)

--request_limit (80)

request limit per interval

--request_limit_interval (10s)

request limit monitor interval

--self_trade_prevention (CN)

self-trade prevention: CN, CO, CB, DC

--encode_buffer_size (1048576)

encode buffer size

--decode_buffer_size (10485760)

decode buffer size

--mbp_allow_price_inversion (false)

allow price inversion?

--rest_uri (https://capi.bitget.com)

REST end-point (URI)

--rest_proxy

proxy end-point (URI)

--rest_ping_freq (5s)

ping frequency

--rest_ping_path (/api/spot/v1/public/time)

URI path used for REST connection keep-alive messages

--rest_request_timeout (30s)

request: timeout

--rest_download_orders_page_size (500)

page size used when downloading orders

--rest_download_orders_begin (24h)

download orders since (now - begin)

--rest_download_only_active_orders (false)

download only active orders?

--rest_download_fills_page_size (500)

page size used when downloading fills

--rest_download_fills_begin (24h)

download fills since (now - begin)

--rest_token_refresh_freq (8h)

token refresh frequency

--ws_uri (wss://ws.bitget.com/spot/v1/stream)

WS end-point (URI)

--ws_ping_freq (5s)

ping frequency

--ws_request_timeout (15s)

request: timeout

--ws_max_subscriptions_per_stream (100)

max symbols per connection (count)

--ws_mbp_request_delay (500ms)

request delay

--ws_mbp_request_max_retries (3)

request max retries

Environments#

$ $CONDA_PREFIX/share/roq-bitget/flags
# flagfile for the roq-bitget gateway

--rest_uri=https://capi.bitget.com
--ws_uri=wss://ws.bitget.com/spot/v1/stream

Market Data#

Event

Stream

Messages

Comments

roq::ReferenceData

roq::MarketStatus

roq::TopOfBook

MarketData

ticker

roq::MarketByPriceUpdate

MarketData

books

roq::MarketByOrderUpdate

roq::TradeSummary

MarketData

trade

roq::StatisticsUpdate

MarketData

ticker

Event

Stream

Messages

Comments

roq::ReferenceData

Rest

/api/spot/v1/public/currencies, /api/spot/v1/public/products

roq::MarketStatus

roq::TopOfBook

roq::MarketByPriceUpdate

roq::MarketByOrderUpdate

roq::TradeSummary

roq::StatisticsUpdate

Statistics#

Type

Comments

OPEN_PRICE

(ticker) open24h

HIGHEST_TRADED_PRICE

(ticker) high24h

LOWEST_TRADED_PRICE

(ticker) low24h

TRADE_VOLUME

(ticker) quoteVolume

Order Management#

Event

Stream

Messages

Comments

roq::OrderUpdate

roq::TradeUpdate

Event

Stream

Messages

Comments

roq::OrderUpdate

roq::TradeUpdate

Event

Stream

Messages

Comments

roq::OrderAck

Order Types#

TBD

Time in Force#

TBD

Position Effect#

TBD

Execution Instructions#

TBD

Account Management#

Event

Stream

Messages

Comments

roq::PositionUpdate

roq::FundsUpdate

Event

Stream

Messages

Comments

roq::PositionUpdate

roq::FundsUpdate

Streams#

Type

Comments

REST

Primary purpose

  • discover the full list of symbols

Type

Comments

WebSocket

Primary purpose

  • live market data

Each connection

  • supports a slice of the symbols

Constraints#

Comments#

  • Missing from market data:

    • Depth requires custom parser due to nested arrays

    • Depth should validate checksum