websocket api 2.1.778

Operations

• PUB login

  Operation IDpublish

  • #ALL

  Accepts the following message:

  login

  A message to login

  Message IDlogin

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string",
    "op": "string"
  }
  

  This example has been generated automatically.

• PUB logout

  Operation IDpublish

  • #ALL

  Accepts the following message:

  logout

  A message to logout

  Message IDlogout

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string",
    "op": "string"
  }
  

  This example has been generated automatically.

• PUB ping

  Operation IDpublish

  • #ALL

  Accepts the following message:

  ping

  Optional message to check connection and prolong token. Frame 'pong' will come in response from server. Can only be sent after login.

  Message IDping

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string",
    "op": "string"
  }
  

  This example has been generated automatically.

• PUB pong

  Operation IDpublish

  • #ALL

  Accepts the following message:

  pong

  Mandatory response to server on his 'ping' message.

  Message IDpong

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string",
    "op": "string"
  }
  

  This example has been generated automatically.

• PUB subscribe

  Operation IDpublish

  • #ALL

  Accepts the following message:

  subscribe

  A message to subscribe on topic by name

  Message IDsubscribe

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  mode

  string

  Mode (SnapshotOnline, Snapshot), for GW_MM_POLL Snapshot ONLY

  Allowed values:
  • "SnapshotOnline"
  • "Snapshot"

  market

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string",
    "op": "string",
    "topic": "string",
    "mode": "SnapshotOnline",
    "market": "string"
  }
  

  This example has been generated automatically.

• PUB unsubscribe

  Operation IDpublish

  • #ALL

  Accepts the following message:

  unsubscribe

  A message to unsubscribe from topic by name

  Message IDunsubscribe

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string",
    "op": "string",
    "topic": "string",
    "market": "string"
  }
  

  This example has been generated automatically.

• SUB transfers

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  transfers

  A message to inform about transfers (for logged in users)

  Message IDtransfers

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  credit_address

  string

  Credit address

  debit_address

  string

  Debit address

  client_status

  string

  Status of transfer (NA, PROCESSING, WAIT_OPERATOR_ACCEPT, WAIT_INCLUSION_IN_BLOCK, WAIT_PAYMENT_ACCEPT, SUCCESS, FAIL, ERROR)

  Allowed values:
  • "NA"
  • "PROCESSING"
  • "WAIT_OPERATOR_ACCEPT"
  • "WAIT_INCLUSION_IN_BLOCK"
  • "WAIT_PAYMENT_ACCEPT"
  • "SUCCESS"
  • "FAIL"
  • "ERROR"

  asset

  string

  Asset

  credit_account

  string

  Credit account

  debit_account

  string

  Debit account

  type

  string

  Type (NA, WITHDRAW, INPUT)

  Allowed values:
  • "NA"
  • "WITHDRAW"
  • "INPUT"

  transfer_id

  string

  Translation ID

  amount

  number

  format: double

  Amount

  clorder_id

  string

  Customer transaction number

  payment_system

  string

  Payment system (BTC, OPEN)

  Allowed values:
  • "BTC"
  • "OPEN"

  comment

  string

  Comment from ricom

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
  }
  

  This example has been generated automatically.

• SUB transfers/{account_code}

  Operation IDsubscribe

  Parameters

  Expand all

  object

  account_code

  required

  string

  The account code of the Person for filtering.

  • #GW-PF

  Accepts the following message:

  transfers

  A message to inform about transfers (for logged in users)

  Message IDtransfers

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  credit_address

  string

  Credit address

  debit_address

  string

  Debit address

  client_status

  string

  Status of transfer (NA, PROCESSING, WAIT_OPERATOR_ACCEPT, WAIT_INCLUSION_IN_BLOCK, WAIT_PAYMENT_ACCEPT, SUCCESS, FAIL, ERROR)

  Allowed values:
  • "NA"
  • "PROCESSING"
  • "WAIT_OPERATOR_ACCEPT"
  • "WAIT_INCLUSION_IN_BLOCK"
  • "WAIT_PAYMENT_ACCEPT"
  • "SUCCESS"
  • "FAIL"
  • "ERROR"

  asset

  string

  Asset

  credit_account

  string

  Credit account

  debit_account

  string

  Debit account

  type

  string

  Type (NA, WITHDRAW, INPUT)

  Allowed values:
  • "NA"
  • "WITHDRAW"
  • "INPUT"

  transfer_id

  string

  Translation ID

  amount

  number

  format: double

  Amount

  clorder_id

  string

  Customer transaction number

  payment_system

  string

  Payment system (BTC, OPEN)

  Allowed values:
  • "BTC"
  • "OPEN"

  comment

  string

  Comment from ricom

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
  }
  

  This example has been generated automatically.

• SUB pos

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  pos

  A message to inform about positions (for logged in users)

  Message IDpos

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  asset

  string

  Asset

  account

  string

  Account

  amount

  number

  format: double

  Amount

  open_price

  number

  format: double

  Average price at which the position was opened. Only for margined instruments.

  amount_beg

  number

  format: double

  Amount at the beginning of the trading session.

  net_trades

  number

  format: double

  Net amount of all trades during the current trading session.

  net_transfers

  number

  format: double

  Net amount of all transfers during the current trading session.

  margin_value

  number

  format: double

  Total value of all assets margined in the position's underlying currency based on the last MarketPrice.

  profit

  number

  format: double

  Cumulative position value

  settle_date

  string

  Settlement date. Timestamp in ms.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  is_call

  string

  Allowed values:
  • "CALL"
  • "PUT"

  strike_price

  number

  format: double

  Price

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB pos/{account_code}

  Operation IDsubscribe

  Parameters

  Expand all

  object

  account_code

  required

  string

  The account code of the Person for filtering.

  • #GW-PF

  Accepts the following message:

  pos

  A message to inform about positions (for logged in users)

  Message IDpos

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  asset

  string

  Asset

  account

  string

  Account

  amount

  number

  format: double

  Amount

  open_price

  number

  format: double

  Average price at which the position was opened. Only for margined instruments.

  amount_beg

  number

  format: double

  Amount at the beginning of the trading session.

  net_trades

  number

  format: double

  Net amount of all trades during the current trading session.

  net_transfers

  number

  format: double

  Net amount of all transfers during the current trading session.

  margin_value

  number

  format: double

  Total value of all assets margined in the position's underlying currency based on the last MarketPrice.

  profit

  number

  format: double

  Cumulative position value

  settle_date

  string

  Settlement date. Timestamp in ms.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  is_call

  string

  Allowed values:
  • "CALL"
  • "PUT"

  strike_price

  number

  format: double

  Price

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB money

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  money

  A message to inform about money (for logged in users)

  Message IDmoney

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  account

  string

  Account

  value

  number

  format: double

  Total assest value in trading system main currency.

  im

  number

  format: double

  Initial margin needed to be allowed to open new positions.

  mm

  number

  format: double

  Maintenance margin needed to maintain opened positions. It accounts postitions and orders assuming smaller basic requirement compared to Initial margin.

  free_im

  number

  format: double

  Free funds eligible to cover new orders which increase risks.

  free_mm

  number

  format: double

  Free funds to maintain opened positions. Once get negative an automatic closing procedure is triggered.

  leverage

  number

  format: double

  Leverage.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB money/{account_code}

  Operation IDsubscribe

  Parameters

  Expand all

  object

  account_code

  required

  string

  The account code of the Person for filtering.

  • #GW-PF

  Accepts the following message:

  money

  A message to inform about money (for logged in users)

  Message IDmoney

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  account

  string

  Account

  value

  number

  format: double

  Total assest value in trading system main currency.

  im

  number

  format: double

  Initial margin needed to be allowed to open new positions.

  mm

  number

  format: double

  Maintenance margin needed to maintain opened positions. It accounts postitions and orders assuming smaller basic requirement compared to Initial margin.

  free_im

  number

  format: double

  Free funds eligible to cover new orders which increase risks.

  free_mm

  number

  format: double

  Free funds to maintain opened positions. Once get negative an automatic closing procedure is triggered.

  leverage

  number

  format: double

  Leverage.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB assets

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  assets

  A message to inform about assets (for logged in users)

  Message IDassets

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  account

  string

  Account

  asset

  string

  Asset

  total_assets

  number

  format: double

  Total number of assets.

  total_plan_assets

  number

  format: double

  Planned number of assets.

  trades_assets

  number

  format: double

  Available number of assets for sale.

  withdrawal_assets

  number

  format: double

  Available number of assets for withdrawal.

  open_price

  number

  format: double

  Average price at which the position was opened.

  profit

  number

  format: double

  Cumulative position value.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  is_call

  string

  Allowed values:
  • "CALL"
  • "PUT"

  strike_price

  number

  format: double

  Price

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB assets/{account_code}

  Operation IDsubscribe

  Parameters

  Expand all

  object

  account_code

  required

  string

  The account code of the Person for filtering.

  • #GW-PF

  Accepts the following message:

  assets

  A message to inform about assets (for logged in users)

  Message IDassets

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  account

  string

  Account

  asset

  string

  Asset

  total_assets

  number

  format: double

  Total number of assets.

  total_plan_assets

  number

  format: double

  Planned number of assets.

  trades_assets

  number

  format: double

  Available number of assets for sale.

  withdrawal_assets

  number

  format: double

  Available number of assets for withdrawal.

  open_price

  number

  format: double

  Average price at which the position was opened.

  profit

  number

  format: double

  Cumulative position value.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  is_call

  string

  Allowed values:
  • "CALL"
  • "PUT"

  strike_price

  number

  format: double

  Price

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• PUB update-option-expiration-pub

  Operation IDpublish

  • #GW-PF

  Accepts the following message:

  updateOptionExpirationReq

  A message to inform about update option expiration (for logged in users)

  Message IDupdateOptionExpirationReq

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  clorder_id

  string

  Customer transaction number

  account

  string

  Account

  asset

  string

  Asset

  expiration_moment

  string

  Expiration moment. String in ISO format.

  strike_price

  number

  format: double

  Price

  execution_call_mode

  string

  ExecutionMode (Client, Auto, All, None)

  Allowed values:
  • "CLIENT"
  • "AUTO"
  • "ALL"
  • "NONE"

  executing_call_amount

  number

  format: double

  Amount

  unexecuting_call_amount

  number

  format: double

  Amount

  execution_put_mode

  string

  ExecutionMode (Client, Auto, All, None)

  Allowed values:
  • "CLIENT"
  • "AUTO"
  • "ALL"
  • "NONE"

  executing_put_amount

  number

  format: double

  Amount

  unexecuting_put_amount

  number

  format: double

  Amount

  executing_combined_amount

  number

  format: double

  Amount

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB update-option-expiration

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  updateOptionExpiration

  Request for UpdateOptionExpiration (for logged in users)

  Message IDupdateOptionExpiration

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  clorder_id

  string

  Customer transaction number

  account

  string

  Account

  asset

  string

  Asset

  expiration_moment

  string

  Expiration moment. String in ISO format.

  strike_price

  number

  format: double

  Price

  call_amount

  number

  format: double

  Amount

  put_amount

  number

  format: double

  Amount

  execution_call_mode

  string

  ExecutionMode (Client, Auto, All, None)

  Allowed values:
  • "CLIENT"
  • "AUTO"
  • "ALL"
  • "NONE"

  executing_call_amount

  number

  format: double

  Amount

  unexecuting_call_amount

  number

  format: double

  Amount

  autoexecuting_call_amount

  number

  format: double

  Amount

  execution_put_mode

  string

  ExecutionMode (Client, Auto, All, None)

  Allowed values:
  • "CLIENT"
  • "AUTO"
  • "ALL"
  • "NONE"

  executing_put_amount

  number

  format: double

  Amount

  unexecuting_put_amount

  number

  format: double

  Amount

  autoexecuting_put_amount

  number

  format: double

  Amount

  executing_combined_amount

  number

  format: double

  Amount

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB option-assets

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  optionAssets

  A message to inform about option assets (for logged in users)

  Message IDoptionAssets

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  account

  string

  Account

  asset

  string

  Asset

  expiration_moment

  string

  Expiration moment. String in ISO format.

  strike_price

  number

  format: double

  Price

  call_amount

  number

  format: double

  Amount

  put_amount

  number

  format: double

  Amount

  execution_call_mode

  string

  ExecutionMode (Client, Auto, All, None)

  Allowed values:
  • "CLIENT"
  • "AUTO"
  • "ALL"
  • "NONE"

  executing_call_amount

  number

  format: double

  Amount

  unexecuting_call_amount

  number

  format: double

  Amount

  autoexecuting_call_amount

  number

  format: double

  Amount

  execution_put_mode

  string

  ExecutionMode (Client, Auto, All, None)

  Allowed values:
  • "CLIENT"
  • "AUTO"
  • "ALL"
  • "NONE"

  executing_put_amount

  number

  format: double

  Amount

  unexecuting_put_amount

  number

  format: double

  Amount

  autoexecuting_put_amount

  number

  format: double

  Amount

  executing_combined_amount

  number

  format: double

  Amount

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
  }
  

  This example has been generated automatically.

• SUB margin-settlement

  Operation IDsubscribe

  • #GW-PF

  Accepts the following message:

  margin-settlement

  A message to inform about margin settlement (for logged in users)

  Message IDmargin-settlement

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  date_t0

  number

  format: int

  Дата T0 в секундах

  payment_t0

  number

  format: decimal

  Плата за перенос в T0

  date_t1

  number

  format: int

  Дата T1 в секундах

  payment_t1

  number

  format: decimal

  Плата за перенос в T1

  account

  string

  Account

  Additional properties are allowed.

  Examples

  Payload

  {
    "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,
    "account": "string"
  }
  

  This example has been generated automatically.

• PUB new-order

  Operation IDpublish

  • #GW-TN

  Accepts the following message:

  newOrder

  A message to create a new order (for logged in users)

  Message IDnewOrder

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  market

  string

  extra_code

  string

  Extra code

  symbol

  string

  Symbol

  account

  string

  Account

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  ord_type

  string

  Order type (MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, PEND_ORDER)

  Allowed values:
  • "MARKET"
  • "LIMIT"
  • "STOP"
  • "STOP_LIMIT"
  • "TRAILING_STOP"
  • "PEND_ORDER"

  time_in_force

  string

  DAY, GTC, IOC, FOK (default = DAY)

  Allowed values:
  • "DAY"
  • "GTC"
  • "IOC"
  • "FOK"

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  clord_id

  string

  Customer transaction number

  expired_moment

  string

  format: date-time

  Optional field for algo. Cancellation time. Timestamp in us.

  stop_price

  number

  format: double

  Optional field for algo. Stop price for stop order

  trail

  number

  format: double

  Optional field for algo. Trail for stop order, in percents

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "FnX6vX6oTyLO772j",
    "op": "new-order",
    "market": "BEX",
    "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"
  }
  

  This example has been generated automatically.

• PUB cancel-order

  Operation IDpublish

  • #GW-TN

  Accepts the following message:

  cancelOrder

  A message to cancel order (for logged in users)

  Message IDcancelOrder

  Payload

  Expand all

  object

  token

  string

  Token

  op

  string

  Command name

  extra_code

  string

  Extra code

  symbol

  string

  Symbol

  account

  string

  Account

  orig_clord_id

  string

  clord_id of the original order

  cancel_reason

  string

  cancel_reason of the original order

  Allowed values:
  • "USER_CANCEL"
  • "EXPIRED"
  • "EXPIRED_NOTRADES"
  • "EXPIRED_CROSSTRADE"
  • "EXPIRED_ORDERBOOK_CROSS"
  • "FILLED"
  • "EXT_REJECTED"
  • "ERROR_NEWORDER"
  • "USER_MOVE"

  ord_type

  string

  Order type (MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, PEND_ORDER)

  Allowed values:
  • "MARKET"
  • "LIMIT"
  • "STOP"
  • "STOP_LIMIT"
  • "TRAILING_STOP"
  • "PEND_ORDER"

  time_in_force

  string

  DAY, GTC, IOC, FOK (default = DAY)

  Allowed values:
  • "DAY"
  • "GTC"
  • "IOC"
  • "FOK"

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  clord_id

  string

  Customer transaction number

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
  }
  

  This example has been generated automatically.

• SUB trading

  Operation IDsubscribe

  • #GW-TN

  Accepts the following message:

  trading

  Message IDtrading

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  exec_type

  string

  Topic (new, cancel, trade)

  order_no

  string

  ID order

  market

  string

  symbol

  string

  Symbol

  extra_code

  string

  Extra code

  account

  string

  Account

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  leaves_qty

  number

  format: double

  Leaves quantity

  time_in_force

  string

  DAY, GTC, IOC, FOK (default = DAY)

  Allowed values:
  • "DAY"
  • "GTC"
  • "IOC"
  • "FOK"

  ord_type

  string

  Order type (MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, PEND_ORDER)

  Allowed values:
  • "MARKET"
  • "LIMIT"
  • "STOP"
  • "STOP_LIMIT"
  • "TRAILING_STOP"
  • "PEND_ORDER"

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  clord_id

  string

  Customer transaction number

  total_exec_value

  number

  format: double

  Sum of the order's executed part in price currency

  amt_initial

  number

  format: double

  Initial amount in new-order

  expiration_date

  string

  format: date-time

  Optional field. Expiration date - timestamp in us

  expired_moment

  string

  format: date-time

  Optional field for algo. Cancellation time. Timestamp in us.

  stop_price_initial

  number

  format: double

  Optional field for algo. Initial stop price for stop order

  stop_price

  number

  format: double

  Optional field for algo. Stop price for stop order

  trail

  number

  format: double

  Optional field for algo. Trail for stop order, in percents

  algo_status

  string

  Optional field for algo. Status of stop order (ACTIVE, EXECUTING, PENDING_CANCEL, PENDING_RESERVE)

  Allowed values:
  • "ACTIVE"
  • "EXECUTING"
  • "PENDING_CANCEL"
  • "PENDING_RESERVE"

  multileg

  Expand all

  array<object>

  object

  symbol

  string

  Symbol

  settle_date

  string

  Settlement date. String in ISO format.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  type

  string

  PUT or CALL.

  strike_price

  number

  amount

  number

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  exec_type

  string

  Topic (new, cancel, trade)

  order_no

  string

  ID order

  market

  string

  symbol

  string

  Symbol

  extra_code

  string

  Extra code

  account

  string

  Account

  price

  number

  format: double

  Price

  leaves_qty

  number

  format: double

  Leaves quantity

  time_in_force

  string

  DAY, GTC, IOC, FOK (default = DAY)

  Allowed values:
  • "DAY"
  • "GTC"
  • "IOC"
  • "FOK"

  ord_type

  string

  Order type (MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, PEND_ORDER)

  Allowed values:
  • "MARKET"
  • "LIMIT"
  • "STOP"
  • "STOP_LIMIT"
  • "TRAILING_STOP"
  • "PEND_ORDER"

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  clord_id

  string

  Customer transaction number

  orig_clord_id

  string

  clord_id of the original order

  cancel_reason

  string

  cancel_reason of the original order

  Allowed values:
  • "USER_CANCEL"
  • "EXPIRED"
  • "EXPIRED_NOTRADES"
  • "EXPIRED_CROSSTRADE"
  • "EXPIRED_ORDERBOOK_CROSS"
  • "FILLED"
  • "EXT_REJECTED"
  • "ERROR_NEWORDER"
  • "USER_MOVE"

  amt_initial

  number

  format: double

  Initial amount in new-order

  expiration_date

  string

  format: date-time

  Optional field. Expiration date - timestamp in us

  expired_moment

  string

  format: date-time

  Optional field for algo. Cancellation time. Timestamp in us.

  stop_price_initial

  number

  format: double

  Optional field for algo. Initial stop price for stop order

  stop_price

  number

  format: double

  Optional field for algo. Stop price for stop order

  trail

  number

  format: double

  Optional field for algo. Trail for stop order, in percents

  multileg

  Expand all

  array<object>

  object

  symbol

  string

  Symbol

  settle_date

  string

  Settlement date. String in ISO format.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  type

  string

  PUT or CALL.

  strike_price

  number

  amount

  number

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  exec_type

  string

  Topic (new, cancel, trade)

  order_no

  string

  ID order

  market

  string

  exec_market

  string

  symbol

  string

  Symbol

  extra_code

  string

  Extra code

  account

  string

  Account

  price

  number

  format: double

  Price

  trade_qty

  number

  format: double

  Optional filed. Not for algo. Trade quantity.

  trade_price

  number

  format: double

  Optional filed. Not for algo. Trade price

  leaves_qty

  number

  format: double

  Leaves quantity

  time_in_force

  string

  DAY, GTC, IOC, FOK (default = DAY)

  Allowed values:
  • "DAY"
  • "GTC"
  • "IOC"
  • "FOK"

  ord_type

  string

  Order type (MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, PEND_ORDER)

  Allowed values:
  • "MARKET"
  • "LIMIT"
  • "STOP"
  • "STOP_LIMIT"
  • "TRAILING_STOP"
  • "PEND_ORDER"

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  clord_id

  string

  Customer transaction number

  total_exec_value

  number

  format: double

  Sum of the order's executed part in price currency

  amt_initial

  number

  format: double

  Initial amount in new-order

  trade_no

  string

  ID execution

  child_order_no

  string

  Optional field

  expiration_date

  string

  format: date-time

  Optional field. Expiration date - timestamp in us

  expired_moment

  string

  format: date-time

  Optional field for algo. Cancellation time. Timestamp in us.

  stop_price_initial

  number

  format: double

  Optional field for algo. Initial stop price for stop order

  stop_price

  number

  format: double

  Optional field for algo. Stop price for stop order

  trail

  number

  format: double

  Optional field for algo. Trail for stop order, in percents

  algo_status

  string

  Optional field for algo. Status of stop order (ACTIVE, EXECUTING, PENDING_CANCEL, PENDING_RESERVE)

  Allowed values:
  • "ACTIVE"
  • "EXECUTING"
  • "PENDING_CANCEL"
  • "PENDING_RESERVE"

  multileg

  Expand all

  array<object>

  object

  symbol

  string

  Symbol

  settle_date

  string

  Settlement date. String in ISO format.

  expiration_moment

  string

  Expiration moment. String in ISO format.

  type

  string

  PUT or CALL.

  strike_price

  number

  amount

  number

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "accepted",
    "timestamp": "2023-04-03T15:56:01.727Z",
    "op": "data",
    "topic": "trading",
    "exec_type": "new",
    "order_no": "110",
    "market": "BEX",
    "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"
  }
  

  This example has been generated automatically.

• SUB tob

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  tob

  Message IDtob

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  seq

  integer

  format: int64

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB tob.{market}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  tob

  Message IDtob

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  seq

  integer

  format: int64

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB stat

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  stat

  Message IDstat

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL, TRADE, OPEN_PRICE, CLOSE_PRICE, SETTLEMENT_PRICE, HIGH_PRICE, LOW_PRICE, VWAP_PRICE, IMBALANCE, TRADE_VOLUME, OPEN_INTEREST, INDEX, HIGH24_PRICE, LOW24_PRICE, VOLUME, VOLUME24, LIQUIDITY_STATUS, LIQUIDITY_FLAG, ENABLE_BEX_FLAG)

  Allowed values:
  • "BUY"
  • "SELL"
  • "TRADE"
  • "OPEN_PRICE"
  • "CLOSE_PRICE"
  • "SETTLEMENT_PRICE"
  • "HIGH_PRICE"
  • "LOW_PRICE"
  • "VWAP_PRICE"
  • "IMBALANCE"
  • "TRADE_VOLUME"
  • "OPEN_INTEREST"
  • "INDEX"
  • "HIGH24_PRICE"
  • "LOW24_PRICE"
  • "VOLUME"
  • "VOLUME24"
  • "LIQUIDITY_STATUS"
  • "LIQUIDITY_FLAG"
  • "ENABLE_BEX_FLAG"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB stat/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  stat

  Message IDstat

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL, TRADE, OPEN_PRICE, CLOSE_PRICE, SETTLEMENT_PRICE, HIGH_PRICE, LOW_PRICE, VWAP_PRICE, IMBALANCE, TRADE_VOLUME, OPEN_INTEREST, INDEX, HIGH24_PRICE, LOW24_PRICE, VOLUME, VOLUME24, LIQUIDITY_STATUS, LIQUIDITY_FLAG, ENABLE_BEX_FLAG)

  Allowed values:
  • "BUY"
  • "SELL"
  • "TRADE"
  • "OPEN_PRICE"
  • "CLOSE_PRICE"
  • "SETTLEMENT_PRICE"
  • "HIGH_PRICE"
  • "LOW_PRICE"
  • "VWAP_PRICE"
  • "IMBALANCE"
  • "TRADE_VOLUME"
  • "OPEN_INTEREST"
  • "INDEX"
  • "HIGH24_PRICE"
  • "LOW24_PRICE"
  • "VOLUME"
  • "VOLUME24"
  • "LIQUIDITY_STATUS"
  • "LIQUIDITY_FLAG"
  • "ENABLE_BEX_FLAG"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB stat.{market}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  stat

  Message IDstat

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL, TRADE, OPEN_PRICE, CLOSE_PRICE, SETTLEMENT_PRICE, HIGH_PRICE, LOW_PRICE, VWAP_PRICE, IMBALANCE, TRADE_VOLUME, OPEN_INTEREST, INDEX, HIGH24_PRICE, LOW24_PRICE, VOLUME, VOLUME24, LIQUIDITY_STATUS, LIQUIDITY_FLAG, ENABLE_BEX_FLAG)

  Allowed values:
  • "BUY"
  • "SELL"
  • "TRADE"
  • "OPEN_PRICE"
  • "CLOSE_PRICE"
  • "SETTLEMENT_PRICE"
  • "HIGH_PRICE"
  • "LOW_PRICE"
  • "VWAP_PRICE"
  • "IMBALANCE"
  • "TRADE_VOLUME"
  • "OPEN_INTEREST"
  • "INDEX"
  • "HIGH24_PRICE"
  • "LOW24_PRICE"
  • "VOLUME"
  • "VOLUME24"
  • "LIQUIDITY_STATUS"
  • "LIQUIDITY_FLAG"
  • "ENABLE_BEX_FLAG"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB stat.{market}/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  stat

  Message IDstat

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL, TRADE, OPEN_PRICE, CLOSE_PRICE, SETTLEMENT_PRICE, HIGH_PRICE, LOW_PRICE, VWAP_PRICE, IMBALANCE, TRADE_VOLUME, OPEN_INTEREST, INDEX, HIGH24_PRICE, LOW24_PRICE, VOLUME, VOLUME24, LIQUIDITY_STATUS, LIQUIDITY_FLAG, ENABLE_BEX_FLAG)

  Allowed values:
  • "BUY"
  • "SELL"
  • "TRADE"
  • "OPEN_PRICE"
  • "CLOSE_PRICE"
  • "SETTLEMENT_PRICE"
  • "HIGH_PRICE"
  • "LOW_PRICE"
  • "VWAP_PRICE"
  • "IMBALANCE"
  • "TRADE_VOLUME"
  • "OPEN_INTEREST"
  • "INDEX"
  • "HIGH24_PRICE"
  • "LOW24_PRICE"
  • "VOLUME"
  • "VOLUME24"
  • "LIQUIDITY_STATUS"
  • "LIQUIDITY_FLAG"
  • "ENABLE_BEX_FLAG"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB dom/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  dom

  Message IDdom

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "string",
    "details": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "op": "string",
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB dom.{market}/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  dom

  Message IDdom

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "string",
    "details": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "op": "string",
    "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
      }
    ]
  }
  

  This example has been generated automatically.

• SUB trades/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  trades

  Message IDtrades

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (TRADE)

  Allowed values:
  • "TRADE"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "string",
    "details": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "op": "string",
    "topic": "string",
    "market": "string",
    "entries": [
      {
        "update_action": "NEW",
        "update_type": "TRADE",
        "symbol": "BTCUSD",
        "qty": 3,
        "price": 100.02,
        "side": "BUY",
        "ts": "2024-01-01T15:00:00.000Z"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB trades.{market}/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  trades

  Message IDtrades

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  side

  string

  Side (BUY, SELL)

  Allowed values:
  • "BUY"
  • "SELL"

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (TRADE)

  Allowed values:
  • "TRADE"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "string",
    "details": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "op": "string",
    "topic": "string",
    "market": "string",
    "entries": [
      {
        "update_action": "NEW",
        "update_type": "TRADE",
        "symbol": "BTCUSD",
        "qty": 3,
        "price": 100.02,
        "side": "BUY",
        "ts": "2024-01-01T15:00:00.000Z"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB heartbeat

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  heartbeat

  Message IDheartbeat

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "string",
    "details": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "op": "string",
    "topic": "string"
  }
  

  This example has been generated automatically.

• SUB commons

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  commons

  Message IDcommons

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (CENTRAL_PRICE_INSTRUMENT, RATE_IM_UP_INITIAL_RISK_LEVEL, RATE_IM_DOWN_INITIAL_RISK_LEVEL, RATE_IM_UP_STANDARD_RISK_LEVEL, RATE_IM_DOWN_STANDARD_RISK_LEVEL, RATE_IM_UP_INCREASED_RISK_LEVEL, RATE_IM_DOWN_INCREASED_RISK_LEVEL)

  Allowed values:
  • "CENTRAL_PRICE_INSTRUMENT"
  • "RATE_IM_UP_INITIAL_RISK_LEVEL"
  • "RATE_IM_DOWN_INITIAL_RISK_LEVEL"
  • "RATE_IM_UP_STANDARD_RISK_LEVEL"
  • "RATE_IM_DOWN_STANDARD_RISK_LEVEL"
  • "RATE_IM_UP_INCREASED_RISK_LEVEL"
  • "RATE_IM_DOWN_INCREASED_RISK_LEVEL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB commons/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  commons

  Message IDcommons

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (CENTRAL_PRICE_INSTRUMENT, RATE_IM_UP_INITIAL_RISK_LEVEL, RATE_IM_DOWN_INITIAL_RISK_LEVEL, RATE_IM_UP_STANDARD_RISK_LEVEL, RATE_IM_DOWN_STANDARD_RISK_LEVEL, RATE_IM_UP_INCREASED_RISK_LEVEL, RATE_IM_DOWN_INCREASED_RISK_LEVEL)

  Allowed values:
  • "CENTRAL_PRICE_INSTRUMENT"
  • "RATE_IM_UP_INITIAL_RISK_LEVEL"
  • "RATE_IM_DOWN_INITIAL_RISK_LEVEL"
  • "RATE_IM_UP_STANDARD_RISK_LEVEL"
  • "RATE_IM_DOWN_STANDARD_RISK_LEVEL"
  • "RATE_IM_UP_INCREASED_RISK_LEVEL"
  • "RATE_IM_DOWN_INCREASED_RISK_LEVEL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB commons.{market}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  commons

  Message IDcommons

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (CENTRAL_PRICE_INSTRUMENT, RATE_IM_UP_INITIAL_RISK_LEVEL, RATE_IM_DOWN_INITIAL_RISK_LEVEL, RATE_IM_UP_STANDARD_RISK_LEVEL, RATE_IM_DOWN_STANDARD_RISK_LEVEL, RATE_IM_UP_INCREASED_RISK_LEVEL, RATE_IM_DOWN_INCREASED_RISK_LEVEL)

  Allowed values:
  • "CENTRAL_PRICE_INSTRUMENT"
  • "RATE_IM_UP_INITIAL_RISK_LEVEL"
  • "RATE_IM_DOWN_INITIAL_RISK_LEVEL"
  • "RATE_IM_UP_STANDARD_RISK_LEVEL"
  • "RATE_IM_DOWN_STANDARD_RISK_LEVEL"
  • "RATE_IM_UP_INCREASED_RISK_LEVEL"
  • "RATE_IM_DOWN_INCREASED_RISK_LEVEL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB commons.{market}/{symbol}

  Operation IDsubscribe

  • #GW-MD

  Accepts the following message:

  commons

  Message IDcommons

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  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.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  Optional field. (CENTRAL_PRICE_INSTRUMENT, RATE_IM_UP_INITIAL_RISK_LEVEL, RATE_IM_DOWN_INITIAL_RISK_LEVEL, RATE_IM_UP_STANDARD_RISK_LEVEL, RATE_IM_DOWN_STANDARD_RISK_LEVEL, RATE_IM_UP_INCREASED_RISK_LEVEL, RATE_IM_DOWN_INCREASED_RISK_LEVEL)

  Allowed values:
  • "CENTRAL_PRICE_INSTRUMENT"
  • "RATE_IM_UP_INITIAL_RISK_LEVEL"
  • "RATE_IM_DOWN_INITIAL_RISK_LEVEL"
  • "RATE_IM_UP_STANDARD_RISK_LEVEL"
  • "RATE_IM_DOWN_STANDARD_RISK_LEVEL"
  • "RATE_IM_UP_INCREASED_RISK_LEVEL"
  • "RATE_IM_DOWN_INCREASED_RISK_LEVEL"

  update_action

  string

  (CLEAR, NEW, MODIFY, DELETE)

  Allowed values:
  • "CLEAR"
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "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"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB board.{symbol}+{extra_code}

  Operation IDsubscribe

  • #GW-MD-BOARD

  Accepts the following message:

  board

  Message IDboard

  Payload

  Expand all

  object

  status

  integer

  Result code

  message

  string

  Text description of the status

  details

  string

  Extra status description in case status != 0

  timestamp

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  op

  string

  Command name

  topic

  string

  Topic name. Can contain parameters, e.g., 'pos/acc123'.

  market

  string

  seq

  integer

  format: int64

  entries

  Expand all

  array<object>

  object

  ts

  string

  format: date-time

  Date and time when the message was sent. Timestamp in us.

  price

  number

  format: double

  Price

  qty

  number

  format: double

  Quantity

  update_type

  string

  (BUY, SELL, TRADE, OPEN_PRICE, CLOSE_PRICE, SETTLEMENT_PRICE, HIGH_PRICE, LOW_PRICE, VWAP_PRICE, IMBALANCE, TRADE_VOLUME, OPEN_INTEREST, INDEX, HIGH24_PRICE, LOW24_PRICE, VOLUME, VOLUME24, LIQUIDITY_STATUS, LIQUIDITY_FLAG, ENABLE_BEX_FLAG, THEORY_PRICE, DELTA, GAMMA, VOLAT, VEGA, THETA, RHO)

  Allowed values:
  • "BUY"
  • "SELL"
  • "TRADE"
  • "OPEN_PRICE"
  • "CLOSE_PRICE"
  • "SETTLEMENT_PRICE"
  • "HIGH_PRICE"
  • "LOW_PRICE"
  • "VWAP_PRICE"
  • "IMBALANCE"
  • "TRADE_VOLUME"
  • "OPEN_INTEREST"
  • "INDEX"
  • "HIGH24_PRICE"
  • "LOW24_PRICE"
  • "VOLUME"
  • "VOLUME24"
  • "LIQUIDITY_STATUS"
  • "LIQUIDITY_FLAG"
  • "ENABLE_BEX_FLAG"
  • "THEORY_PRICE"
  • "DELTA"
  • "GAMMA"
  • "VOLAT"
  • "VEGA"
  • "THETA"
  • "RHO"

  update_action

  string

  (NEW, MODIFY, DELETE)

  Allowed values:
  • "NEW"
  • "MODIFY"
  • "DELETE"

  symbol

  string

  Symbol

  extra_code

  string

  Extra code

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "status": 0,
    "message": "string",
    "details": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "op": "string",
    "topic": "string",
    "market": "string",
    "seq": 0,
    "entries": [
      {
        "ts": "2019-08-24T14:15:22Z",
        "price": 0.1,
        "qty": 0.1,
        "update_type": "BUY",
        "update_action": "NEW",
        "symbol": "string",
        "extra_code": "string"
      }
    ]
  }
  

  This example has been generated automatically.