roq-gate¶

Unstable

$ conda install \
      --channel https://roq-trading.com/conda/unstable \
      roq-gate

Stable

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

Supports¶

Products

`Spot`	✅
`Futures`	❌
`Swap`	❌
`Option`	❌

Market Data

`ReferenceData`	✅	❶
`MarketStatus`	❌
`TopOfBook`	✅
`MarketByPrice`	✅
`MarketByOrder`	❌
`TradeSummary`	✅
`Statistics`	✅
`TimeSeries`	❌

Orders & Quotes

`CreateOrder`	❎
`ModifyOrder`	❌
`CancelOrder`	❎
`CancelAllOrders`	❎
`MassQuote`	❌
`CancelQuotes`	❌

Account

`Funds`	❎
`Position`	❌

Note

✅ = Available.

❎ = Not implemented.

❌ = Unavailable.

❶ The exchange protocol does not support streaming updates for reference data and market status.

Using¶

$ roq-gate [FLAGS]

Flags¶

$ roq-gate --help

Flags

--exchange (gate): Exchange identifier

REST

--rest_uri (https://api.gateio.ws/api/v4): Exchange end-point
--rest_proxy: Proxy end-point
--rest_ping_freq (5s): Ping frequency
--rest_ping_path (/): Ping path
--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://api.gateio.ws/ws/v4/): Exchange end-point
--ws_ping_freq (5s): Ping frequency
--ws_request_timeout (15s): Request timeout
--ws_max_subscriptions_per_stream (256): Maximum number of symbols per connection
--ws_mbp_request_delay (500ms): Request delay
--ws_mbp_request_max_retries (3): Request max retries

Misc

--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 (true): Allow price inversion?
--order_book_depth (100): Order book depth
--order_book_freq (100ms): Order book frequency

Environments¶

Prod

$ $CONDA_PREFIX/share/roq-gate/flags/prod/flags.cfg

# flagfile for the roq-gate gateway

--rest_uri=https://api.gateio.ws/api/v4
--ws_uri=wss://api.gateio.ws/ws/v4/

Configuration¶

$ $CONDA_PREFIX/share/roq-gate/config.toml

Important

This template will be replaced when the software is upgraded. Make a copy and modify to your own needs.

# config template for the roq-gate gateway

symbols = [
  "^BTC_USD[A-Z]?$",
  "^ETH_USD[A-Z]?$"
]

[accounts]

  [accounts.A1]
  master = true
  login = "YOUR_GATE_API_KEY_GOES_HERE"
  secret = "YOUR_GATE_SECRET_GOES_HERE"
  symbols = [ ".*" ]

[users]

  [users.test]
  password = "1234"
  symbols = ".*"

  [users.trader]
  password = "secret"
  accounts = [ "A1" ]
  symbols = [ ".*BTC.*", ".*ETH.*" ]

[rate_limits]

  [rate_limits.global]
    type = "ORDER_ACTION"
    aggregate = true
    request_limit = 100
    monitor_period = "10s"
    ban_period = "5m"

Market Data¶

Inbound¶

StatisticsType

Channel	Field
`spot.tickers`	`quote_volume`	⇒	`TRADE_VOLUME`

roq-gate¶

Supports¶

Using¶

Flags¶

Environments¶

Configuration¶

Market Data¶

Inbound¶

Order Management¶

Inbound¶

Outbound¶

Comments¶

References¶

Common¶

Exchange¶