Documentation is divided into blocks that belong to different gateways. ALL - Common calls, GW-MD - MarkerData, GW-PF - Portfolio, GW-TN - Transactional, GW-MD-BOARD - MarkerData Board.
Accepts the following message:
A message to login
{
"token": "string",
"op": "string"
}
Accepts the following message:
A message to logout
{
"token": "string",
"op": "string"
}
Accepts the following message:
Optional message to check connection and prolong token. Frame 'pong' will come in response from server. Can only be sent after login.
{
"token": "string",
"op": "string"
}
Accepts the following message:
Mandatory response to server on his 'ping' message.
{
"token": "string",
"op": "string"
}
Accepts the following message:
A message to subscribe on topic by name
{
"token": "string",
"op": "string",
"topic": "string",
"mode": "SnapshotOnline",
"market": "string"
}
Accepts the following message:
A message to unsubscribe from topic by name
{
"token": "string",
"op": "string",
"topic": "string",
"market": "string"
}
Accepts the following message:
A message to inform about transfers (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"credit_address": "string",
"debit_address": "string",
"client_status": "NA",
"asset": "string",
"credit_account": "string",
"debit_account": "string",
"type": "NA",
"transfer_id": "string",
"amount": 0.1,
"clorder_id": "string",
"payment_system": "BTC",
"comment": "string"
}
Accepts the following message:
A message to inform about positions (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"asset": "string",
"account": "string",
"amount": 0.1,
"open_price": 0.1,
"amount_beg": 0.1,
"net_trades": 0.1,
"net_transfers": 0.1,
"margin_value": 0.1,
"profit": 0.1,
"settle_date": "string",
"expiration_moment": "string",
"is_call": "CALL",
"strike_price": 0.1
}
Accepts the following message:
A message to inform about money (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"account": "string",
"value": 0.1,
"im": 0.1,
"mm": 0.1,
"free_im": 0.1,
"free_mm": 0.1,
"leverage": 0.1
}
Accepts the following message:
A message to inform about assets (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"account": "string",
"asset": "string",
"total_assets": 0.1,
"total_plan_assets": 0.1,
"trades_assets": 0.1,
"withdrawal_assets": 0.1,
"open_price": 0.1,
"profit": 0.1,
"expiration_moment": "string",
"is_call": "CALL",
"strike_price": 0.1
}
Accepts the following message:
A message to inform about update option expiration (for logged in users)
{
"token": "string",
"op": "string",
"clorder_id": "string",
"account": "string",
"asset": "string",
"expiration_moment": "string",
"strike_price": 0.1,
"execution_call_mode": "CLIENT",
"executing_call_amount": 0.1,
"unexecuting_call_amount": 0.1,
"execution_put_mode": "CLIENT",
"executing_put_amount": 0.1,
"unexecuting_put_amount": 0.1,
"executing_combined_amount": 0.1
}
Accepts the following message:
Request for UpdateOptionExpiration (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"clorder_id": "string",
"account": "string",
"asset": "string",
"expiration_moment": "string",
"strike_price": 0.1,
"call_amount": 0.1,
"put_amount": 0.1,
"execution_call_mode": "CLIENT",
"executing_call_amount": 0.1,
"unexecuting_call_amount": 0.1,
"autoexecuting_call_amount": 0.1,
"execution_put_mode": "CLIENT",
"executing_put_amount": 0.1,
"unexecuting_put_amount": 0.1,
"autoexecuting_put_amount": 0.1,
"executing_combined_amount": 0.1
}
Accepts the following message:
A message to inform about option assets (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"account": "string",
"asset": "string",
"expiration_moment": "string",
"strike_price": 0.1,
"call_amount": 0.1,
"put_amount": 0.1,
"execution_call_mode": "CLIENT",
"executing_call_amount": 0.1,
"unexecuting_call_amount": 0.1,
"autoexecuting_call_amount": 0.1,
"execution_put_mode": "CLIENT",
"executing_put_amount": 0.1,
"unexecuting_put_amount": 0.1,
"autoexecuting_put_amount": 0.1,
"executing_combined_amount": 0.1
}
Accepts the following message:
A message to inform about margin settlement (for logged in users)
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"date_t0": 0,
"payment_t0": 0,
"date_t1": 0,
"payment_t1": 0,
"trades_amount": 0,
"account": "string",
"withdrawal_amount": 0
}
Accepts the following message:
A message to create a new order (for logged in users)
{
"token": "FnX6vX6oTyLO772j",
"op": "new-order",
"market": "BEX",
"target_market": "SPB",
"extra_code": "ORAS150823~-100.00~0.0",
"symbol": "GAZP",
"account": "account76467",
"price": "104",
"qty": "10",
"ord_type": "LIMIT",
"time_in_force": "DAY",
"side": "SELL",
"clord_id": "order18",
"expired_moment": "2023-04-03T17:14:51Z"
}
Accepts the following message:
A message to cancel order (for logged in users)
{
"token": "FnX6vX6oTyLO772j",
"op": "cancel-order",
"extra_code": "ORAS150823~-100.00~0.0",
"symbol": "GAZP",
"account": "account76467",
"orig_clord_id": "order18",
"cancel_reason": "USER_CANCEL",
"ord_type": "LIMIT",
"time_in_force": "DAY",
"side": "SELL",
"clord_id": "order19"
}
Accepts the following message:
{
"status": 0,
"message": "accepted",
"timestamp": "2023-04-03T15:56:01.727Z",
"op": "data",
"topic": "trading",
"exec_type": "new",
"order_no": "110",
"market": "BEX",
"target_market": "SPB",
"symbol": "GAZP",
"extra_code": "ORAS150823~-100.00~0.0",
"account": "acc65",
"price": 107,
"qty": 10,
"leaves_qty": 0,
"time_in_force": "DAY",
"ord_type": "LIMIT",
"side": "BUY",
"clord_id": "order79",
"total_exec_value": 0,
"amt_initial": 0,
"expiration_date": "2023-04-03T00:00:000Z",
"expired_moment": "2023-04-03T17:14:51Z"
}
Accepts the following message:
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"seq": 0,
"topic": "string",
"market": "string",
"entries": [
{
"update_action": "CLEAR",
"symbol": "BTCUSD"
},
{
"update_action": "NEW",
"update_type": "BUY",
"price": 100.01,
"symbol": "BTCUSD",
"qty": 32
},
{
"update_action": "NEW",
"update_type": "SELL",
"price": 103.01,
"symbol": "BTCUSD",
"qty": 16
}
]
}
Accepts the following message:
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"market": "string",
"seq": 0,
"entries": [
{
"update_action": "CLEAR",
"symbol": "BTCUSD"
},
{
"update_action": "NEW",
"update_type": "BUY",
"price": 100.01,
"symbol": "BTCUSD",
"qty": 32
},
{
"update_action": "NEW",
"update_type": "SELL",
"price": 103.01,
"symbol": "BTCUSD",
"qty": 16
}
]
}
Accepts the following message:
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string"
}
Accepts the following message:
{
"status": 0,
"message": "string",
"details": "string",
"timestamp": "2019-08-24T14:15:22Z",
"op": "string",
"topic": "string",
"market": "string",
"seq": 0,
"entries": [
{
"update_action": "CLEAR",
"symbol": "BTCUSD"
},
{
"update_action": "NEW",
"update_type": "CENTRAL_PRICE_INSTRUMENT",
"price": 100.01,
"symbol": "BTCUSD"
}
]
}
A message to login
A message to logout
Optional message to check connection and prolong token. Frame 'pong' will come in response from server. Can only be sent after login.
Mandatory response to server on his 'ping' message.
A message to subscribe on topic by name
A message to unsubscribe from topic by name
A message to inform about transfers (for logged in users)
A message to inform about transactions (for logged in users)
A message to inform about positions (for logged in users)
A message to inform about money (for logged in users)
A message to inform about assets (for logged in users)
A message to inform about update option expiration (for logged in users)
Request for UpdateOptionExpiration (for logged in users)
A message to inform about option assets (for logged in users)
A message to inform about margin settlement (for logged in users)
A message to create a new order (for logged in users)
A message to cancel order (for logged in users)
Token
Mode (SnapshotOnline, Snapshot), for GW_MM_POLL Snapshot ONLY
Result code
Text description of the status
Text description of the status
Extra status description in case status != 0
Date and time when the message was sent. Timestamp in us.
Date and time when the entry was created or modified. ts and timestamp may be different in case of requesting historical transactions, when transactions are received online or when the status of instruments or quotes changes. Timestamp in us.
Command name
Topic name. Can contain parameters, e.g., 'pos/acc123'.
Topic (new, cancel, trade)
ID order
Credit address
Debit address
Status of transfer (NA, PROCESSING, WAIT_OPERATOR_ACCEPT, WAIT_INCLUSION_IN_BLOCK, WAIT_PAYMENT_ACCEPT, SUCCESS, FAIL, ERROR)
Amount
Asset
Credit account
Debit account
Account
Type (NA, WITHDRAW, INPUT)
Translation ID
Customer transaction number
Payment system (BTC, OPEN)
Comment from ricom
Optional field for algo. Cancellation time. Timestamp in us.
Optional field for algo. Initial stop price for stop order
Optional field for algo. Stop price for stop order
Optional field for algo. Trail for stop order, in percents
Optional field for algo. Status of stop order (ACTIVE, EXECUTING, PENDING_CANCEL, PENDING_RESERVE)
Sum of the order's executed part in price currency
Initial amount in new-order
Initial amount in cash qty
Price
Yield
Quantity
Leaves quantity
Cash quantity
Symbol
Extra code
Order type (MARKET, MARKET_BY_SUM, LIMIT, LIMIT_BY_SUM, STOP, STOP_LIMIT, TRAILING_STOP, PEND_ORDER, PEND_LIMIT etc)
DAY, GTC, IOC, FOK (default = DAY)
Side (BUY, SELL)
clord_id of the original order
cancel_reason of the original order
(CLEAR, NEW, MODIFY, DELETE)
Expiration moment. String in ISO format.
ExecutionMode (Client, Auto, All, None)