HitBTC¶
roq-hitbtc
Environments¶
Production¶
Option |
Value |
Type |
Comment(s) |
---|---|---|---|
|
|
REST |
|
|
|
WebSocket |
Test¶
Warning
Does not exist.
Installation¶
Conda¶
Install
conda install -y roq-hitbtc
Configuration
cp $CONDA_PREFIX/share/roq-hitbtc/config.toml $CONFIG_FILE_PATH
# then modify $CONFIG_FILE_PATH to match your specific configuration
Using
roq-hitbtc \
--name "hitbtc" \
--config-file "$CONFIG_FILE_PATH" \
--client-listen-address "$UNIX_SOCKET_PATH" \
--metrics-listen-address "$TCP_LISTEN_PORT" \
--rest-uri "$REST_URI" \
--ws-uri "$WS_URI"
Flags¶
Only notable flags are mentioned here.
Please refer to roq-hitbtc --help
for all flags.
Implementation¶
Restrictions¶
Incoming Events¶
Event |
Connection |
Message(s) |
Comment(s) |
---|---|---|---|
ReferenceData |
WS |
getSymbols |
Polling |
MarketStatus |
Not available |
||
TopOfBook |
WS |
ticker |
|
MarketByPrice |
WS |
snapshotOrderbook, updateOrderbook |
|
MarketByOrder |
Not available |
||
TradeSummary |
WS |
snapshotTrades, updateTrades |
|
SessionStatistics |
Not available |
||
DailyStatistics |
Not available |
||
OrderAck |
WS |
result, error |
|
OrderUpdate |
WS |
getOrders, activeOrders, report |
|
TradeUpdate |
WS |
report |
|
PositionUpdate |
Not available |
||
FundsUpdate |
WS |
getTradingBalance |
Polling |
Outgoing Events¶
Event |
Connection |
Message(s) |
Comment(s) |
---|---|---|---|
CreateOrder |
WS |
newOrder |
|
ModifyOrder |
WS |
cancelReplaceOrder |
|
CancelOrder |
WS |
cancelOrder |