Foxbit websocket API 2.0 documentation

Foxbit websocket API 2.0

External Docs

Introduction to WebSocket and how to use

If you want to see the documentation of the other apis, click on the button below:

See all available API's

In the examples described in this documentation, we use NodeJs and ws lib.

• Install the latest stable version of NodeJs on: https://nodejs.org/en/download/

• Open Terminal (Mac), Cmd (Windows) or Bash (Linux) and enter the command:

In the same folder you will save the scripts exemplified below

npm install ws

ref link: https://www.npmjs.com/package/ws

GitHub – WebSocket Example

You can download the example directly from the repository on GitHub:

• https://github.com/foxbit-group/foxbit-api-samples

Connecting Websocket

With NodeJs:

//Instantiate Websocket module
const WebSocket=require('ws');

//WebSocketAPI Address
var wsAddress='wss://api.foxbit.com.br/';

//Setup WebSocket client Address
var ws=new WebSocket(wsAddress);

WS Rate-Limit

The Rate Limit of the WS API is divided into three topics, these being connection, concurrent connection and messages.

#	Common	Partners	Block time
Connections per period	1 connection per second	3 connections per second	1s
Connections concurrent	10 connections concurrent	20 connections concurrent	N/A
Messages per period	750 messages per 60s	2100 messages per 60s	60s

The limits on the WS API are based on the IPs
The block time is the blocking time after reaching the limit
Blocking for concurrent connections is done automatically, i.e. when one connection is closed another one becomes available.

Message Fame example

Object in JSON-formatted format used as a frame to send and receive data:

var messageFrame={
'm': 0, //MessageType (0_Request / 1_Reply / 2_Subscribe / 3_Event / Error)
'i': 0, //SequenceNumber (long integer)
'n': '', //Endpoint (integer)
'o': '' //Payload (string)
}

Payload

Object in JSON-formatted format which contains mandatory (and different) fields for sending data to the triggered endpoint.

Each endpoint has a specific package, see payload format in documentation.

//Example of building the payload for the *getL2Snapshot* endpoint

var payload={

'OMSId': 1,
'InstrumentId': 1;

};

Events

Set the Open event to handle the connection return.

Each endpoint has a specific package, see payload format in documentation.

//Event Open Connection

ws.on('open', function open(){

console.log('Conected');
});

Set event to receive socket message:

//Event Receiving Message

ws.on('message', function incoming(data){

//data contains the response payload
console.log(data);
});

Define event for error handling:

//Event Error Message

ws.on('error', function(){

console.log('Error');
});

Define event handle connection termination:

//Event Close Message

ws.on('close', function close(){

console.log('Connection Closed');
});

Sending Data

To send data to the server you must use the “messageFrame” object described above, use the “n” field to inform the Endpoint to trigger and the “o” field to send the payload.

//Indicate to which endpoint it will be sent.

messageFrame.n='WebAuthenticateUser'

//Add the payload for the indicated endpoint
messageFrame.o=JSON.stringify(payload);

ws.send(JSON.stringify(messageFrame), function ack(error){

//If you find errors, send
console.log(error);

});

Data sent, if no error is returned, the message ends in the message event.

Authentication

Endpoints PRIVATE need authentication to be accessed.

AuthenticateUser authenticates a user in current WebSession using APIKEY previously defined.

You need to call it to use methods that require an active SessionToken.

AuthenticateUser can be called whenever authentication is required.

Request:

{
'APIKey': 'APIKey',
'Signature': 'Signature',
'UserId': 'UserId',
'Nonce': 'Nonce',
}

>>> Obs. 1: Nonce=Date.now();
>>> Obs. 2: Signature=crypto.HmacSHA256(nonce + userId +APIKey, APISecret).toString(crypto.enc.Hex);

Return when authentication succeeds:

{
'Authenticated': true
'SessionToken': 'SessionToken'
'UserId': 123
}

Unsuccessful authentication:

{
'Authenticated': false
}

Operations

SEND AuthenticateUser
PUBLIC - AuthenticateUser
Operation IDAuthenticateUser
- #PUBLIC
Accepts the following message:
AuthenticateUser
application/json
Message IDAuthenticateUser
AuthenticateUser a user using the API Key and signature.

object
Retry example

Additional properties are NOT allowed.
object
object
APIKey
string
The user's assigned API Key.

Nonce
string
The timestamp of the request.

UserId
string
The user's assigned ID.

Signature
string
The hex-encoded signature.

Additional properties are NOT allowed.
object
Authenticated
boolean
A successful authentication returns true. Unsuccessful returns false.

Requires2FA
boolean
Expresses whether the user still needs to complete a second authentication factor.

TwoFAToken
string
2FA token used to enable two-factor-authentication in user account.

TwoFAType
boolean
Type of 2FA code/plataform.

object
UserId
string
The user's assigned ID.

UserName
string
The user's assigned complete name.

Email
string
The user's assigned email.

EmailVerified
boolean
The user's assigned email verification status.

AccountId
string
The user's assigned account ID.

Use2FA
boolean
Tells if the user assigned uses the 2FA.

Additional properties are allowed.
Additional properties are NOT allowed.
#PUBLIC
Examples
{ "Authenticated": false, "Requires2FA": true, "TwoFAToken": null, "TwoFAType": "Google", "User": { "UserId": "1234542342", "UserName": "User Test", "Email": "[email protected]", "EmailVerified": true, "AccountId": "12342332", "Use2FA": true } }

This example has been generated automatically.
SEND CancelAllOrders
PRIVATE - CancelAllOrders
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDCancelAllOrders
- #PRIVATE
Accepts the following message:
CancelAllOrders
application/json
Message IDCancelAllOrders
Cancels all open matching orders for the specified instrument.

object
Reply example

Additional properties are NOT allowed.
object
object
IntrumentId
integer
The instrument for which all orders are being canceled. required.

Additional properties are NOT allowed.
object
The Response is a standard response object.

result
boolean
If the call has been successfully received by the Order Management System, result is true; otherwise it is false.

errormsg
string
A successful receipt of the call returns null. The errormsg key for an unsuccessful call returns one of the following messages:
- Not Authorized (errorcode 20)
- Invalid Response (errorcode 100)
- Operation Failed (errorcode 101)
- Server Error (errorcode 102)
- Resource Not Found (errorcode 104)
- Operation Not Supported (errorcode 106)

errorcode
integer
A successful receipt of the call returns 0. An unsuccessful receipt of the call returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send.

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "result": true, "errormsg": "", "errorcode": 0, "detail": "" }

This example has been generated automatically.
SEND CancelOrder
PRIVATE - CancelOrder
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDCancelOrder
- #PRIVATE
Accepts the following message:
CancelOrder
application/json
Message IDCancelOrder
Cancels an open order that has been placed but has not yet been fully executed.
A user with Trading permission can cancel an order only for an account with which he is associated; a user with Operator permission can cancel an order for any account.

object
Reply example

Additional properties are NOT allowed.
object
object
OMSId
integer
The Order Management System on which the order exists. Required.

AccountId
integer
The ID of the account under which the order was placed. Conditionally optional.

ClOrderId
integer
A user-assigned ID for the order (like a purchase-order number assigned by a company). ClientOrderId defaults to 0. Conditionally optional.

OrderId
integer
The order to be canceled. Conditionally optional.

Additional properties are NOT allowed.
object
The response to CancelOrder verifies that the call was received, not that the order has been canceled successfully. Individual event updates to the user show order cancellation. To verify that an order has been canceled, call GetOrderStatus or GetOpenOrders.

result
boolean
Returns true if the call to cancel the order has been successfully received, otherwise returns false.

errormsg
string
A successful receipt of a call to cancel an order returns null; the errormsg parameter for an unsuccessful call to cancel an order returns one of the following messages:
Not Authorized (errorcode 20)
Invalid Request (errorcode 100)
Operation Failed (errorcode 101)
Server Error (errorcode 102)
Resource Not Found (errorcode 104)
Operation Not Supported (errorcode 106)

errorcode
integer
A successfully received call to cancel an order returns 0. An unsuccessfully received call to cancel an order returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send. The contents of this parameter are usually null.

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "result": true, "errormsg": "", "errorcode": 0, "detail": "" }

This example has been generated automatically.
SEND GetAccountInfo
PRIVATE - GetAccountInfo
Operation IDGetAccountInfo
- #PRIVATE
Accepts the following message:
GetAccountInfo
application/json
Message IDGetAccountInfo
Returns detailed information about one specific account and existing on a specific Order Management System.

object
Reply example

Additional properties are NOT allowed.
object
object
OMSId
number
The ID of the Order Management System on which the account exists.

AccountId
number
The ID of the account on the Order Management System for which information will be returned.

Additional properties are NOT allowed.
object
OMSId
number
The ID of the Order Management System on which the account resides.

AccountId
number
The ID of the account for which information was requested.

AccountName
string
A non-unique name for the account assigned by the user.

AccountHandle
string
accountHandle is a unique user-assigned name that is checked at create time by the Order Management System to assure its uniqueness.

FirmId
string
An arbitrary identifier assigned by a trading venue operator to a trading firm as part of the initial company, user, and account set up process. For example, Smith Financial Partners might have the ID SMFP.

FirmName
string
A longer, non-unique version of the trading firm’s name; for example, Smith Financial Partners.

AccountType
number
The type of the account for which information is being returned. One of:
Asset (0)
Liability (1)
ProfitLoss (2)

FeeGroupID
number
Defines account attributes relating to how fees are calculated and assessed. Set by trading venue operator.

ParentID
number
Reserved for future development.

RiskType
number
One of:
Unkown (0) (an error condition)
Normal (1)
NoRiskCheck (2)
NoTrading (3)

VerificationLevel
number
Verification level limits the amounts of deposits and withdrawals. It is defined by and set by the trading venue operator for each account and is part of the KYC ('Know Your Customer') process, which may be automated or manual. An account can earn a higher Verification Level over time.

FeeProductType
string
One of:
BaseProduct
SingleProduct
Trading fees may be charged by a trading venue operator. (Withdrawal fees may also be charged, but that is a separate setting dependent on product and instrument.) This value shows whether fees for this account’s trades are charged in the product being traded (BaseProduct, for example BitCoin) or whether the account has a preferred fee-paying product (SingleProduct, for example USD) to use in all cases and regardless of product being traded.

FeeProduct
number
The ID of the preferred fee product, if any. Defaults to 0.

RefererId
number
Captures the ID of the entity who referred this account to the trading venue, usually captured for marketing purposes.

LoyaltyProductId
number
The Loyalty Token is a parallel fee structure that replaces the general set of transaction fees. An exchange can promote activity on a specific cryptocurrency token by offering discounted transaction fees denominated in that token to customers who choose that fee structure. This key is the ID of the loyalty product chosen by the Exchange. There can be one Loyalty Token per OMS.

LoyaltyEnabled
boolean
If true, this account has accepted the Loyalty Token fee structure. If false, the account has not accepted it. The default setting is false.

MarginEnabled
boolean
If true, this account can trade on margin. If false, the account cannot trade on margin. The default is false.

LiabilityAccountId
number
The ID of the liability account associated with the account named in the accountId key. A liability account is necessary for this account to trade on margin. Used internally.

LendingAccountId
number
The ID of the lending account associated with the account named in the accountId key. A lending account is necessary for this account to trade on margin. Used internally.

profitLossAccountId
number
The ID of the profit-and-loss account associated with the account named in the accountId key. A profit-and-loss account is necessary for this account to trade on margin. Used internally.

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "omsid": 0, "accountId": 0, "accountName": "", "accountHandle": "", "firmId": "", "firmName": "", "accountType": { "Options": [ "Asset", "Liability", "ProfitLoss" ] }, "feeGroupID": 0, "parentID": 0, "riskType": { "Options": [ "Unknown", "Normal", "NoRiskCheck", "NoTrading" ] }, "verificationLevel": 0, "feeProductType": { "Options": [ "BaseProduct", "SingleProduct" ] }, "feeProduct": 0, "refererId": 0, "loyaltyProductId": 0, "loyaltyEnabled": false, "marginEnabled": false, "liabilityAccountId": 0, "lendingAccountId": 0, "profitLossAccountId": 0 }

This example has been generated automatically.
SEND GetAccountPositions
PRIVATE - GetAccountPositions
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoints for account listing and transaction limits for the latest updates and improvements.
Operation IDGetAccountPositions
- #PRIVATE
Accepts the following message:
GetAccountPositions
application/json
Message IDGetAccountPositions
Retrieves a list of positions (balances) for a specific user account running under a specific Order Management System. The trading day runs from UTC Midnight to UTC Midnight.
Users with Trading or AccountReadOnly permission must specify an account ID with which they're associated on the Order Management System. Users with Operator permission can specify other accounts.

array<any>
Reply example

object
object
AccountId
number
The ID of the authenticated user’s account on the Order Management System for which positions will be returned.

OMSId
number
The ID of the Order Management System to which the user belongs. A user will belong only to one OMS.

Additional properties are NOT allowed.
object
OMSId
integer
The ID of the Order Management System (OMS) to which the user belongs. A user will only ever belong to one Order Management System. Note the change in capitalization from the request.

AccountId
integer
Returns the ID of the user’s account to which the positions belong. Note the change in capitalization from the request.

ProductSymbol
string
The symbol of the product on this account’s side of the trade. For example:
BTC — BitCoin
USD — US Dollar
NZD — New Zealand Dollar

Many other values are possible depending on the nature of the trading venue.

ProductId
integer
The ID of the product being traded. The system assigns product IDs as they are entered into the system. Use GetProduct to return information about the product by its ID.

Amount
number
Unit amount of the product; for example, 10 or 138.5.

Hold
number
Amount of currency held and not available for trade. A pending trade of 100 units at $1 each will reduce the amount in the account available for trading by $100 and produce a $100 hold. Amounts on hold cannot be withdrawn while a trade is pending.

PendingDeposits
number
Deposits accepted but not yet cleared for trade.

PendingWithdraws
number
Withdrawals acknowledged but not yet cleared from the account. Amounts in PendingWithdraws are not available for trade.

TotalDayDeposits
number
Total deposits on today’s date. The trading day runs between UTC Midnight and UTC Midnight.

TotalDayWithdraws
number
Total withdrawals on today’s date. The trading day runs between UTC Midnight and UTC Midnight.

TotalMonthDeposits
number
Total deposits for the month as of today's date.

Additional properties are NOT allowed.
#PRIVATE
Examples
[ { "omsId": 1, "accountId": 4, "productSymbol": "BTC", "productId": 1, "amount": 0, "hold": 0, "pendingDeposits": 0, "pendingWithdraws": 0, "totalDayDeposits": 0, "totalMonthDeposits": 0, "totalYearDeposits": 0, "totalYearDepositNotional": 0, "totalDayWithdraws": 0, "totalMonthWithdraws": 0, "totalYearWithdraws": 0, "totalYearWithdrawNotional": 0, "notionalHoldAmount": 0, "notionalRate": 0, "totalDayDepositNotional": 0, "totalMonthDepositNotional": 0, "totalDayWithdrawNotional": 0, "totalMonthWithdrawNotional": 0 }, { "omsId": 1, "accountId": 4, "productSymbol": "USD", "productId": 2, "amount": 0, "hold": 0, "pendingDeposits": 0, "pendingWithdraws": 0, "totalDayDeposits": 0, "totalMonthDeposits": 0, "totalYearDeposits": 0, "totalYearDepositNotional": 0, "totalDayWithdraws": 0, "totalMonthWithdraws": 0, "totalYearWithdraws": 0, "totalYearWithdrawNotional": 0, "notionalHoldAmount": 0, "notionalRate": 0, "totalDayDepositNotional": 0, "totalMonthDepositNotional": 0, "totalDayWithdrawNotional": 0, "totalMonthWithdrawNotional": 0 } ]

This example has been generated automatically.
SEND GetAccountTrades
PRIVATE - GetAccountTrades
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetAccountTrades
- #PRIVATE
Accepts the following message:
GetAccountTrades
application/json
Message IDGetAccountTrades
Requests the details on up to 200 past trade executions for a single specific account and Order Management System, starting at index i, where i is an integer identifying a specific execution in reverse order; that is, the most recent execution has an index of 0, and increments by one as trade executions recede into the past.
Users with Trading or AccountReadOnly permission may access trade information only for accounts with which they are associated; users with Operator permission may access trade information for any account.
The operator of the trading venue determines how long to retain an accessible trading history before archiving.
Only the last three months can be listed in the trades search.

array<any>
Reply example

object
object
OMSId
integer
The ID of the Order Management System to which the user belongs. A user will belong to only one OMS.

AccountId
integer
The ID of the account.

StartIndex
integer
The starting index into the history of trades, beginning from 0 (the most recent trade). Only accepting 0.

Count
integer
The number of trades to return. The system can return up to 200 trades.

Additional properties are NOT allowed.
array<object>
object
OMSId
integer
The ID of the Order Management System to which the account belongs.

ExecutionId
integer
The ID of this account's side of the trade. Every trade has two sides.

TradeId
integer
The ID of the overall trade.

OrderId
integer
The ID of the order causing the trade (buy or sell).

AccountId
integer
The ID of the account that made the trade (buy or sell).

SubAccountId
integer
Not currently used; reserved for future use. Defaults to 0.

InstrumentId
integer
The ID of the instrument being traded. An instrument comprises two products, for example Dollars and BitCoin.

Side
string
One of the following potential sides of a trade:
0 Buy
1 Sell
2 Short
3 Unknown (an error condition)

OrderType
string
One of the following potential sides of a trade:
Market
Limit
BlockTrade
StopMarket
StopLimit
TrailingStopLimit
StopMarket
TrailingStopMarket

Quantity
number
The unit quantity of this side of the trade.

RemainingQuantity
number
The number of units remaining to be traded by the order after this execution. This number is not revealed to the other party in the trade. This value is also known as "leave size" or "leave quantity."

Price
number
The unit price at which the instrument traded.

Value
number
The total value of the deal. The system calculates this as:
unit price X quantity executed.

CounterParty
string
The ID of the other party in a block trade. Usually, IDs are stated as integers; this value is an integer written as a string.

Direction
string
The effect of the trade on the instrument's market price. Will only return "No change"

IsBlockTrade
boolean
A value of true means that this trade was a block trade; a value of false that it was not a block trade.

Fee
number
Any fee levied against the trade by the Exchange.

FeeProductId
integer
The ID of the product in which the fee was levied.

UserName
integer
The UserName of the user who initiated the trade.

TradeTimeMS
integer
The date and time that the trade took place, in milliseconds and POSIX format. All dates and times are UTC.

MakerTaker
string
One of the following potential liquidity provider of a trade:
Maker
Taker

InsideBid
number
The best (highest) price level of the buy side of the book at the time of the trade.

InsideBidSize
number
The quantity of the best (highest) price level of the buy side of the book at the time of the trade.

InsideAsk
number
The best (lowest) price level of the sell side of the book at the time of the trade.

InsideAskSize
number
The quantity of the best (lowest) price level of the sell side of the book at the time of the trade.

IsQuote
boolean
If this order is a quote, the value for IsQuote is true, else false. Note: Always return false as these orders are not quotes.

TradeTime
integer
The date and time that the trade took place, in C# Ticks. All dates and times are UTC.

Additional properties are allowed.
#PRIVATE
Examples
[ { "OMSId": 0, "ExecutionId": 0, "TradeId": 0, "OrderId": 0, "AccountId": 0, "SubAccountId": 0, "InstrumentId": 0, "Side": "Buy", "OrderType": "Limit", "Quantity": 0, "RemainingQuantity": 0, "Price": 0, "Value": 0, "CounterParty": "", "Direction": "No change", "IsBlockTrade": false, "Fee": 0, "FeeProductId": 0, "UserName": "", "TradeTimeMS": 0, "MakerTaker": "Maker", "InsideBid": 0, "InsideBidSize": 0, "InsideAsk": 0, "InsideAskSize": 0, "IsQuote": false, "TradeTime": 0 } ]

This example has been generated automatically.
SEND GetDepositTickets
PRIVATE - GetDepositTickets
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetDepositTickets
- #PRIVATE
Accepts the following message:
GetDepositTickets
application/json
Message IDGetDepositTickets
Retrieves deposit tickets.

array<any>
Reply example

object
object
object
Deposit Tickets

sn
string
Member's serial number.

ref
integer
Member's random ref number.

email
string
Member's email.

uuid
string
Member's uuid.

name
string
Member's name.

array<object>
Deposit information

object
amount
number
Deposit's amount.
Since the value may exceed the size of a 32-bit float, use the new field suffixed with decimal.

createdAt
string
Deposit's creation date and time.

object
Currency information.

code
string
The currency code.

isCrypto
boolean
Identifies if the currency is a cryptocurrency.

isFiat
boolean
Identifies if the currency is a fiduciary coin.

name
string
The currency name.

precision
integer
The number of digits after the comma.

Additional properties are allowed.
remoteFileUrl
string
Deposit's image support.

fundExtra
string
Bank code selected by the user to make the deposit.

ref
integer
Deposit's unique reference number.

rejectedReason
string
Deposit's rejected reason.

state
string
Deposit's state. One of:
0 SUBMITTING
1 CANCELLED
2 SUBMITTED
3 REJECTED
4 ACCEPTED
5 WARNING
6 BLOCKED
7 UNBLOCKED
8 CHARGEDBACK

updatedAt
string
Deposit's last updated at date and time.

fundUid
string
Wallet address receiving funds.

blockchainUrl
string
Blockchain URL to verify the transaction.

transactionId
string
Deposit's transaction ID (TXID).

Additional properties are allowed.
Additional properties are allowed.
Additional properties are NOT allowed.
#PRIVATE
Examples
{ "viewer": { "sn": "M5B72BO46AAAA", "ref": "729602682189999", "email": "[email protected]", "uuid": "940a7698-552e-4c1c-9ee4-ed116f09999", "name": "Name Surname Surname", "deposits": [ { "amount": 100, "createdAt": "2020-06-17T11:21:51.389-03:00", "currency": { "code": "xrp", "isCrypto": true, "isFiat": false, "name": "Ripple", "precision": 6 }, "ref": "4741053231764111", "rejectedReason": "cannot lock funds (amount: 100)", "state": "DONE", "updatedAt": "2020-06-29T15:34:49.769-03:00", "remoteFileUrl": "https://s3.amazonaws.com/live-foxbit-kyc/foxbit.com.br/1234-1234-0.png", "fundExtra": "TESTENET", "fundUid": "rfSN7sAEmSm6w91wtv4Ha393mUsP8yAAAA", "blockchainUrl": "https://stellar.expert/explorer/public/tx/aaaaa", "transactionId": "C290EA63EB6A1FEF123E90664384C800B3B5E543527E78AD91E34DCBAAAAAA" } ] } }

This example has been generated automatically.
SEND GetInstrument
PUBLIC - GetInstrument
Operation IDGetInstrument
- #PUBLIC
Accepts the following message:
GetInstrument
application/json
Message IDGetInstrument
Retrieves an instruments. An instrument is a pair of exchanged products (or fractions of them) such as US dollars and BitCoin.

object
Reply example

Additional properties are NOT allowed.
object
object
InstrumentId
integer
The ID of the Instrument.

Additional properties are NOT allowed.
object
OMSId
integer
The ID of the Order Management System on which the instrument is traded.

InstrumentId
integer
The ID of the instrument.

Symbol
string
Trading symbol of the instrument, for example BTCUSD.

Product1
integer
The ID of the first product comprising the instrument.

Product1Symbol
string
The symbol for Product 1 on the trading venue. For example, BTC.

Product2
integer
The ID of the second product comprising the instrument.

Product2Symbol
string
The symbol for Product 2 on the trading venue. For example, USD.

InstrumentType
integer
A number representing the type of the instrument. All instrument types currently are standard, an exchange of one product for another (or unknown, an error condition), but this may expand to new types in the future.
0 Unknown (an error condition)
1 Standard

VenueInstrumentId
integer
A venue instrument is created at the exchange level as an instrument template for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested.

VenueId
integer
The ID of the trading venue on which the instrument trades.

SortIndex
integer
The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, SortIndex should return 0.

SessionStatus
integer
Is the market for this instrument currently open and operational? Returns one of:
0 Unknown
1 Running
2 Paused
3 Stopped
4 Starting

PreviousSessionStatus
string
What was the previous session status for this instrument? One of:
0 Unknown
1 Running
2 Paused
3 Stopped
4 Starting

SessionStatusDateTime
string
The time and date at which the session status was reported, in Microsoft Ticks format.

SelfTradePrevention
boolean
An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns true; otherwise defaults to false.

QuantityIncrement
number
The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50.

PriceIncrement
number
The amount by which the instrument can rise or fall in the market.

MinimumQuantity
number
0.0000000100000000000000000000

MinimumPrice
number
0.010000000000000000000000000

VenueSymbol
string
BTC/BRL

IsDisable
boolean
false

MasterDataId
integer
0

PriceCollarThreshold
number
0.0000000000000000000000000000

PriceCollarPercent
number
0.0000000000000000000000000000

PriceCollarEnabled
boolean
false

PriceFloorLimit
number
0.0000000000000000000000000000

PriceFloorLimitEnabled
boolean
false

PriceCeilingLimit
number
0.0000000000000000000000000000

PriceCeilingLimitEnabled
boolean
false

CreateWithMarketRunning
boolean
true

AllowOnlyMarketMakerCounterParty
boolean
false

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "OMSId": 0, "InstrumentId": 0, "Symbol": "", "Product1": 0, "Product1Symbol": "", "Product2": 0, "Product2Symbol": "", "InstrumentType": 0, "VenueInstrumentId": 0, "VenueId": 0, "SortIndex": 0, "SessionStatus": 0, "PreviousSessionStatus": "", "SessionStatusDateTime": "0001-01-01T00:00:00", "SelfTradePrevention": false, "QuantityIncrement": 0, "PriceIncrement": 0, "MinimumQuantity": 0, "MinimumPrice": 0.01, "VenueSymbol": "BTC/BRL", "IsDisable": false, "MasterDataId": 0, "PriceCollarThreshold": 0, "PriceCollarPercent": 0, "PriceCollarEnabled": false, "PriceFloorLimit": 0, "PriceFloorLimitEnabled": false, "PriceCeilingLimit": 0, "PriceCeilingLimitEnabled": false, "CreateWithMarketRunning": true, "AllowOnlyMarketMakerCounterParty": false }

This example has been generated automatically.
SEND GetInstruments
PUBLIC - GetInstruments
Operation IDGetInstruments
- #PUBLIC
Accepts the following message:
GetInstruments
application/json
Message IDGetInstruments
Retrieves a list of instruments available on the exchange. An instrument is a pair of exchanged products (or fractions of them) such as US dollars and BitCoin.

array<any>
Reply example

object
object
OMSId
integer
The ID of the Order Management System on which the instruments are available.

Additional properties are NOT allowed.
object
OMSId
integer
The ID of the Order Management System on which the instrument is traded.

InstrumentId
integer
The ID of the instrument.

Symbol
string
Trading symbol of the instrument, for example BTCUSD.

Product1
integer
The ID of the first product comprising the instrument.

Product1Symbol
string
The symbol for Product 1 on the trading venue. For example, BTC.

Product2
integer
The ID of the second product comprising the instrument.

Product2Symbol
string
The symbol for Product 2 on the trading venue. For example, USD.

InstrumentType
integer
A number representing the type of the instrument. All instrument types currently are standard, an exchange of one product for another (or unknown, an error condition), but this may expand to new types in the future.
0 Unknown (an error condition)
1 Standard

VenueInstrumentId
integer
A venue instrument is created at the exchange level as an instrument template for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested.

VenueId
integer
The ID of the trading venue on which the instrument trades.

SortIndex
integer
The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, SortIndex should return 0.

SessionStatus
integer
Is the market for this instrument currently open and operational? Returns one of:
0 Unknown
1 Running
2 Paused
3 Stopped
4 Starting

PreviousSessionStatus
string
What was the previous session status for this instrument? One of:
0 Unknown
1 Running
2 Paused
3 Stopped
4 Starting

SessionStatusDateTime
string
The time and date at which the session status was reported, in Microsoft Ticks format.

SelfTradePrevention
boolean
An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns true; otherwise defaults to false.

QuantityIncrement
number
The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50.

PriceIncrement
number
The amount by which the instrument can rise or fall in the market.

MinimumQuantity
number
0.0000000100000000000000000000

MinimumPrice
number
0.010000000000000000000000000

VenueSymbol
string
BTC/BRL

IsDisable
boolean
false

MasterDataId
integer
0

PriceCollarThreshold
number
0.0000000000000000000000000000

PriceCollarPercent
number
0.0000000000000000000000000000

PriceCollarEnabled
boolean
false

PriceFloorLimit
number
0.0000000000000000000000000000

PriceFloorLimitEnabled
boolean
false

PriceCeilingLimit
number
0.0000000000000000000000000000

PriceCeilingLimitEnabled
boolean
false

CreateWithMarketRunning
boolean
true

AllowOnlyMarketMakerCounterParty
boolean
false

Additional properties are NOT allowed.
#PUBLIC
Examples
[ { "OMSId": 0, "InstrumentId": 0, "Symbol": "", "Product1": 0, "Product1Symbol": "", "Product2": 0, "Product2Symbol": "", "InstrumentType": 0, "VenueInstrumentId": 0, "VenueId": 0, "SortIndex": 0, "SessionStatus": 0, "PreviousSessionStatus": "", "SessionStatusDateTime": "0001-01-01T00:00:00", "SelfTradePrevention": false, "QuantityIncrement": 0, "PriceIncrement": 0, "MinimumQuantity": 0, "MinimumPrice": 0.01, "VenueSymbol": "BTC/BRL", "IsDisable": false, "MasterDataId": 0, "PriceCollarThreshold": 0, "PriceCollarPercent": 0, "PriceCollarEnabled": false, "PriceFloorLimit": 0, "PriceFloorLimitEnabled": false, "PriceCeilingLimit": 0, "PriceCeilingLimitEnabled": false, "CreateWithMarketRunning": true, "AllowOnlyMarketMakerCounterParty": false } ]

This example has been generated automatically.
SEND GetOpenOrders
PUBLIC - GetOpenOrders
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetOpenOrders
- #PUBLIC
Accepts the following message:
GetOpenOrders
application/json
Message IDGetOpenOrders
Returns an array of 0 or more orders that have not yet been filled (open orders) for a single account on a specific Order Management System. The call returns an empty array if an account has no open orders.
A user with Trading or AccountReadOnly permission must be associated with the account named by AccountId; a user with Operator permissoin can get open orders for any account.

array<any>
Reply example

object
object
OMSId
integer
The ID of the Order Management System to which the user belongs. A user will belong only to one OMS.

AccountId
integer
The ID of the authenticated user’s account.

Additional properties are NOT allowed.
object
The call GetOpenOrders returns an array containing both buy-side and a sell-side open orders for the named account. The call returns an empty array if there are no open orders for the account.

Side
string
The side of a trade. One of:
0 Buy
1 Sell
2 Short
3 Unknown (an error condition)

OrderId
integer
The ID of the open order. The OrderID is unique in each Order Management System.

Price
number
The price at which the buy or sell has been ordered.

Quantity
number
The quantity of the product to be bought or sold.

DisplayQuantity
number
The quantity available to buy or sell that is publicly displayed to the market. To display a displayQuantity value, an order must be a Limit order with a reserve.

Instrument
integer
ID of the instrument being traded. The call GetInstruments can supply the instrument IDs that are available.

Account
integer
Number of accounts that placed orders.

AccountName
string
The name of the account.

orderType
string
Describes the type of order this is. One of:
0 Unknown (an error condition)
1 Market order
2 Limit
3 StopMarket
4 StopLimit
5 TrailingStopMarket
6 TrailingStopLimit
7 BlockTrade

ClientOrderId
integer
An ID supplied by the client to identify the order (like a purchase order number). The ClientOrderId defaults to 0 if not supplied.

OrderState
string
The current state of the order. One of:
0 Unknown
1 Working
2 Rejected
3 Canceled
4 Expired
5 Fully Executed.

ReceiveTime
integer
Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone).

ReceiveTimeTicks
integer
Time stamp of the order Microsoft Ticks format and UTC time zone. Note: Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer.

LastUpdatedTime
integer
1663786062818

LastUpdatedTimeTicks
integer
637993828628180000

OrigQuantity
number
If the open order has been changed or partially filled, this value shows the original quantity of the order.

QuantityExecuted
number
If the open order has been at least partially executed, this value shows the amount that has been executed.

GrossValueExecuted
integer
0

ExecutableValue
integer
0

AvgPrice
number
The average executed price for the instrument in the order.

CounterPartyId
integer
The ID of the other party in an off-market trade.

ChangeReason
string
If the order has been changed, this string value holds the reason. One of:
0 Unknown
1 NewInputAccepted
2 NewInputRejected
3 OtherRejected
4 Expired
5 Trade
6 SystemCanceled_NoMoreMarket
7 SystemCanceled_BelowMinimum
8 SystemCanceled_PriceCollar
9 SystemCanceled_MarginFailed
100 UserModified

OrigOrderId
integer
If the order has been changed, this is the ID of the original order.

OrigClOrdId
integer
If the order has been changed, this is the ID of the original client order ID.

EnteredBy
integer
The user ID of the person who entered the order.

UserName
string
The user's assigned user name.

IsQuote
boolean
If this order is a quote, the value for IsQuote is true, else false.

InsideAsk
number
If this order is a quote, this value is the Inside Ask price.

InsideAskSize
number
If this order is a quote, this value is the quantity of the Inside Ask quote.

InsideBid
number
If this order is a quote, this value is the Inside Bid price.

InsideBidSize
number
If this order is a quote, this value is the quantity of the Inside Bid quote.

LastTradePrice
number
The last price that this instrument traded at.

RejectReason
string
If this open order has been rejected, this string holds the reason for the rejection.

IsLockedIn
boolean
For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is true. Othersise, false.

CancelReason
string
If this order has been canceled, this string holds the cancelation reason.

OMSId
integer
The ID of the Order Management System on which the order took place.

OrderFlag
string
'Unknown'

UseMargin
boolean
false

StopPrice
integer
The price at which to execute the new order, if the order is a stop order.

PegPriceType
integer
An integer that represents the type of price you set in a stop/trailing order to 'peg the stop.'
0 Unknown (error condition)
1 Last
2 Bid
3 Ask
4 Midpoint

PegOffset
integer
0

PegLimitOffset
integer
0

InstantAmount
integer
null

InstantAmountExecuted
integer
null

Additional properties are NOT allowed.
#PUBLIC
Examples
[ { "Side": "", "OrderId": 0, "Price": 0, "Quantity": 0, "DisplayQuantity": 0, "Instrument": 0, "Account": 0, "AccountName": "", "orderType": "", "ClientOrderId": 0, "OrderState": "", "ReceiveTime": 0, "ReceiveTimeTicks": 0, "LastUpdatedTime": 1663786062818, "LastUpdatedTimeTicks": 637993828628180000, "OrigQuantity": 0, "QuantityExecuted": 0, "GrossValueExecuted": 0, "ExecutableValue": 0, "AvgPrice": 0, "CounterPartyId": 0, "ChangeReason": "", "OrigOrderId": 0, "OrigClOrdId": 0, "EnteredBy": 0, "UserName": "", "IsQuote": false, "InsideAsk": 0, "InsideAskSize": 0, "InsideBid": 0, "InsideBidSize": 0, "LastTradePrice": 0, "RejectReason": "", "IsLockedIn": false, "CancelReason": "", "OMSId": 0, "OrderFlag": "", "UseMargin": false, "StopPrice": 0, "PegPriceType": 0, "PegOffset": 0, "PegLimitOffset": 0, "InstantAmount": null, "InstantAmountExecuted": null } ]

This example has been generated automatically.
SEND GetOrderHistory
PRIVATE - GetOrderHistory
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetOrderHistory
- #PRIVATE
Accepts the following message:
GetOrderHistory
application/json
Message IDGetOrderHistory
Returns a complete list of all orders, both open and executed, for a specific account on the specified Order Management System.
The account named in the request must be associated with the calling user.

array<any>
Reply example

object
object
OMSId
number
The ID of the Order Management System to which the user belongs. A user will belong only to one OMS.

AccountId
number
The ID of the authenticated user’s account on the Order Management System for which positions will be returned.

Depth
number
The count of orders to return.

Additional properties are NOT allowed.
object
side
string
The side of a trade. One of:
0 Buy
1 Sell
2 Short
3 Unknown (an error coditional)

OrderId
integer
The ID of the open order. The OrderID is unique in each Order Management System.

Price
number
The quantity of the product to be bought or sold.

DisplayQuantity
number
The quantity available to buy or sell that is publicly displayed to the market. To display a displayQuantity value, an order must be a Limit order with a reserve.

Instrument
integer
ID of the instrument being traded. The call GetInstruments can supply the instrument IDs that are available.

OrderType
string
Describes the type of order this is. One of:
o Unknown (an error condition)
1 Market Order
2 Limit
3 StopMarket
4 Stop Limit
5 TrailingStopMarket
6 TrailingStopLimit
7 BlockTrade

ClientOrderId
integer
An ID supplied by the client to identify the order (like a purchase order number). The ClientOrderId defaults to 0 if not supplied.

OrderState
string
The current state of the order. One of:
0 Unknown
1 Working
2 Rejected
3 Canceled
4 Expired
5 Fully Executed

ReceiveTime
integer
Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone).

ReceiveTimeTicks
integer
Time stamp of the order Microsoft Ticks format and UTC time zone. Note: Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer.

OrigQuantity
number
If the open order has been changed or partially filled, this value shows the original quantity of the order.

QuantityExecuted
number
If the open order has been at least partially executed, this value shows the amount that has been executed.

AvgPrice
number
The average executed price for the instrument in the order.

CounterPartyId
integer
The ID of the other party in an off-market trade.

ChangeReason
string
If the order has been changed, this string value holds the reason. One of:
0 Unknown
1 NewInputAccepted
2 NewInputRejected
3 OtherRejected
4 Expired
5 Trade
6 SystemCanceled_NoMoreMarket
7 SystemCanceled_BelowMinimum
8 SystemCanceled_PriceCollar
9 SystemCanceled_MarginFailed
100 UserModified

OrigOrderId
integer
If the order has been changed, this is the ID of the original order.

OrigClOrdId
integer
If the order has been changed, this is the ID of the original client order ID.

EnteredBy
integer
The user ID of the person who entered the order.

IsQuote
integer
If this order is a quote, the value for IsQuote is true, else false.

InsideAsk
number
If this order is a quote, this value is the Inside Ask price.

InsideAskSize
number
If this order is a quote, this value is the quantity of the Inside Ask quote.

InsideBid
number
If this order is a quote, this value is the Inside Bid price.

InsideBidSize
number
If this order is a quote, this value is the quantity of the Inside Bid quote.

LastTradePrice
number
The last price that this instrument traded at.

RejectReason
string
If this open order has been rejected, this string holds the reason for the rejection.

IsLockedIn
string
For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is true. Othersise, false.

CancelReason
string
If this order has been canceled, this string holds the cancelation reason.

OMSId
string
The ID of the Order Management System on which the order took place.

Additional properties are NOT allowed.
#PRIVATE
Examples
[ { "Side": "Buy", "OrderId": 0, "Price": 0, "Quantity": 0, "DisplayQuantity": 0, "Instrument": 0, "Account": 0, "OrderType": "Unknown", "ClientOrderId": 0, "OrderState": "Unknown", "ReceiveTime": 0, "ReceiveTimeTicks": 0, "OrigQuantity": 0, "QuantityExecuted": 0, "AvgPrice": 0, "CounterPartyId": 0, "ChangeReason": "Unknown", "OrigOrderId": 0, "OrigClOrdId": 0, "EnteredBy": 0, "IsQuote": false, "InsideAsk": 0, "InsideAskSize": 0, "InsideBid": 0, "InsideBidSize": 0, "LastTradePrice": 0, "RejectReason": "", "IsLockedIn": false, "CancelReason": "", "OMSId": 0 } ]

This example has been generated automatically.
SEND GetOrderStatus
PRIVATE - GetOrderStatus
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetOrderStatus
- #PRIVATE
Accepts the following message:
GetOrderStatus
application/json
Message IDGetOrderStatus
Retrieves the status information for a single order.
A user with Trading permission can retrieve status information for accounts and orders with which the user is associated; a user with Operator permission can retreive status information for any account or order ID.

object
Reply example

Additional properties are NOT allowed.
object
object
AccountId
number
The ID of the account under which the order was placed.

OrderId
number
The ID of the order whose status will be returned.

Additional properties are NOT allowed.
object
Side
string
The side of a trade. One of:
0 Buy
1 Sell
2 Short
3 Unknown (an error condition)

OrderId
integer
The ID of the open order. The OrderID is unique in each Order Management System.

Price
number
The price at which the buy or sell has been ordered.

Quantity
number
The quantity of the product to be bought or sold.

DisplayQuantity
number
The quantity available to buy or sell that is publicly displayed to the market. To display a displayQuantity value, an order must be a Limit order with a reserve.

Instrument
integer
ID of the instrument being traded. The call GetInstruments can supply the instrument IDs that are available.

OrderType
string
Describes the type of order this is. One of:
0 Unknown (an error condition)
1 Market order
2 Limit
3 StopMarket
4 StopLimit
5 TrailingStopMarket
6 TrailingStopLimit
7 BlockTrade

ClientOrderId
integer
An ID supplied by the client to identify the order (like a purchase order number). The ClientOrderId defaults to 0 if not supplied.

OrderState
string
The current state of the order. One of:
0 Unknown
1 Working
2 Rejected
3 Canceled
4 Expired
5 Fully Executed.

ReceiveTime
integer
Time stamp of the order in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone).

ReceiveTimeTicks
integer
Time stamp of the order Microsoft Ticks format and UTC time zone. Note: Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer.

OrigQuantity
number
If the open order has been changed or partially filled, this value shows the original quantity of the order.

QuantityExecuted
number
If the open order has been at least partially executed, this value shows the amount that has been executed.

AvgPrice
number
The average executed price for the instrument in the order.

CounterPartyId
integer
The ID of the other party in an off-market trade.

ChangeReason
string
If the order has been changed, this string value holds the reason. One of:
0 Unknown
1 NewInputAccepted
2 NewInputRejected
3 OtherRejected
4 Expired
5 Trade
6 SystemCanceled_NoMoreMarket
7 SystemCanceled_BelowMinimum
8 SystemCanceled_PriceCollar
9 SystemCanceled_MarginFailed
100 UserModified

OrigOrderId
integer
If the order has been changed, this is the ID of the original order.

OrigClOrdId
integer
If the order has been changed, this is the ID of the original client order ID.

EnteredBy
integer
The user ID of the person who entered the order.

IsQuote
Boolean
If this order is a quote, the value for IsQuote is true, else false.

InsideAsk
number
If this order is a quote, this value is the Inside Ask price.

InsideAskSize
number
If this order is a quote, this value is the quantity of the Inside Ask quote.

InsideBid
number
If this order is a quote, this value is the Inside Bid price.

InsideBidSize
number
If this order is a quote, this value is the quantity of the Inside Bid quote.

LastTradePrice
number
The last price that this instrument traded at.

RejectReason
string
If this open order has been rejected, this string holds the reason for the rejection.

IsLockedIn
boolean
For a block trade, if both parties to the block trade agree that one of the parties will report the trade for both sides, this value is true. Othersise, false.

CancelReason
string
If this order has been canceled, this string holds the cancelation reason.

OMSId
integer
The ID of the Order Management System on which the order took place.

Account
integer
The ID of the account

AccountName
string
A non-unique name for the account assigned by the user.

ExecutableValue
number
The value of the order that can be executed.

GrossValueExecuted
number
The gross value of the order that has been executed.

InstantAmount
number
Funds desired to be executed on an Instant order.

InstantAmountExecuted
number
Funds executed from an Instant order.

LastUpdatedTime
integer
Time stamp of the order last update in POSIX format x 1000 (milliseconds since 1/1/1970 in UTC time zone).

LastUpdatedTimeTicks
integer
Time stamp of the order last update Microsoft Ticks format and UTC time zone. Note: Microsoft Ticks format is usually provided as a string. Here it is provided as a long integer.

StopPrice
number
Stop price to trigger a stop order.

UserName
string
The UserName of the user

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "Side": "Buy", "OrderId": 0, "Price": 0, "Quantity": 0, "DisplayQuantity": 0, "Instrument": 0, "Account": 0, "AccountName": "", "OrderType": "Limit", "ClientOrderId": 0, "OrderState": "Working", "ReceiveTime": 0, "ReceiveTimeTicks": 0, "LastUpdatedTime": null, "LastUpdatedTimeTicks": null, "OrigQuantity": 0, "QuantityExecuted": 0, "GrossValueExecuted": 0, "ExecutableValue": 0, "AvgPrice": 0, "CounterPartyId": 0, "ChangeReason": "NewInputAccepted", "OrigOrderId": 0, "OrigClOrdId": 0, "EnteredBy": 0, "UserName": "", "IsQuote": false, "InsideAsk": null, "InsideAskSize": null, "InsideBid": null, "InsideBidSize": null, "LastTradePrice": 0, "IsLockedIn": false, "CancelReason": "", "OMSId": 1, "OrderFlag": "Unknown", "UseMargin": false, "StopPrice": 0, "PegPriceType": "Unknown", "PegOffset": 0, "PegLimitOffset": 0, "InstantAmount": null, "InstantAmountExecuted": null }

This example has been generated automatically.
SEND GetProducts
PUBLIC - get-products
Operation IDget-products
- #PUBLIC
Accepts the following message:
get-products
application/json
Message IDget-products
Returns an array of products and currencies available on the exchange. A product is an asset that is tradable or paid out.

array<any>
Reply example

object
object
OMSId
integer
The ID of the Order Management System for which the array of available products and currencies will be returned.

Additional properties are NOT allowed.
array<array<any>>
The response returns an array of objects, one object for each product available on the Order Management System.

array<any>
OMSId
integer
The ID of the Order Management System that offers the product.

ProductId
integer
The ID of the product.

Product
string
“Nickname” or shortened name of the product. For example, NZD (New Zealand Dollar).

ProductFullName
string
Full and official name of the product. For example, New Zealand Dollar.

ProductType
string
A number describing the nature of the product. One of:
0 Unknown (an error condition)
1 NationalCurrency
2 CryptoCurrency
3 Contract

DecimalPlaces
integer
The number of decimal places in which the product is divided. The maximum is 8. For example, US Dollars are divided into 100 units, or 2 decimal places. Other products may be different. Burundi Francs use 0 decimal places and the Rial Omani uses 3.

TickSize
number
The smallest increment in which the product can trade.

NoFees
boolean
Shows whether trading the product incurs transaction fees. The default is false; that is, if NoFees is false, transaction fees will be incurred. If NoFees is true, no fees are incurred.

#PUBLIC
Examples
[ { "OMSId": 1, "ProductId": 1004, "Product": "FXMUSICS01", "ProductFullName": "FXMUSICS01", "ProductType": "CryptoCurrency", "decimalPlaces": 2, "tickSize": 0.01, "noFees": false } ]

This example has been generated automatically.
SEND GetL2Snapshot
PUBLIC - GetL2Snapshot
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetL2Snapshot
- #PUBLIC
Accepts the following message:
GetL2Snapshot
application/json
Message IDGetL2Snapshot
Provides a current Level 2 snapshot of a specific instrument trading on an Order Management System to a user-determined market depth.
The Level 2 snapshot allows the user to specify the level of market depth information on either side of the bid and ask. Depth in this call is 'depth of market', the number of buyers and sellers at greater or lesser prices in the order book for the instrument.

array<any>
Reply example

object
object
OMSId
number
The ID of the Order Management System where the instrument is traded.

InstrumentId
number
The ID of the instrument that is the subject of the snapshot.

Depth
number
Depth of the market — the number of buyers and sellers at greater or lesser prices in the order book for the instrument. Defaults to 100.

Additional properties are NOT allowed.
object
MDUpdateID
number
Market Data Update ID. This sequential ID identifies the order in which the update was created.

Accounts
number
Number of accounts that placed orders.

ActionDateTime
number
ActionDateTime identifies the time and date that the snapshot was taken or the event occurred, in POSIX format X 1000 (milliseconds since 1 January 1970).

ActionType
number
L2 information provides price data. This value shows whether this data is:
0 new
1 update
2 deletion

LastTradePrice
number
The price at which the instrument was last traded.

Orders
number
Number of orders in the GetL2Snapshot.

Price
number
Bid or Ask price for the Quantity (see Quantity below).

ProductPairCode
number
ProductPairCode is the same value and used for the same purpose as InstrumentID. The two are completely equivalent. InstrumentId 47 = ProductPairCode 47.

Quantity
number
The quantity of the instrument being ordered.

Side
number
A number representing on of the following potential sides of a trade. One of:
0 Buy
1 Sell
2 Short
3 Unknown (an error condition).

Additional properties are NOT allowed.
#PUBLIC
Examples
[ [ 0, 1, 123, 0, 0, 0, 0, 0, 0, 0 ] ]

This example has been generated automatically.
SEND GetTickerHistory
PUBLIC - GetTickerHistory
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetTickerHistory
- #PUBLIC
Accepts the following message:
GetTickerHistory
application/json
Message IDGetTickerHistory
Requests a ticker history (high, low, open, close, volume, bid, ask, ID) of a specific instrument from a given date to the present. You will need to format the returned data per your requirements.
Because permission is Public, any user can retrieve the ticker history for any instrument on the OMS.

array<any>
Reply example

object
object
InstrumentId
integer
The ID of a specific instrument. The current Order Management System is assumed.

Interval
integer
The time between ticks, in seconds. For example, a value of 60 returns ticker array elements between FromDate to ToDate in 60-second increments.

FromDate
string
Oldest date from which the ticker history will start, in Micrisoft Ticks format. The report moves toward ToDate from this point.

ToDate
string
Most recent date, at which the ticker history will end, in Microsoft Ticks format.

Additional properties are NOT allowed.
array<array<any>>
The response returns an array of arrays dating from the FromDate value of the request to the ToDate. The data are returned oldest-date first. The data returned in the arrays are not labeled.

array<any>
0
integer
DateTime - UTC - Milliseconds since 1/1/1970 - POSIX format

1
number
High

2
number
Low

3
number
Open

4
number
Close

5
number
Volume

6
number
Inside Bid Price

7
number
Inside Ask Price

8
integer
InstrumentId

9
integer
Initial DateTime - UTC - Milliseconds since 1/1/1970 - POSIX format

#PUBLIC
Examples
[ [ 1671451200000, 228.9, 228.9, 228.9, 228.9, 0, 150, 228.9, 1, 1671451140000 ], [ 1671451260000, 228.9, 228.9, 228.9, 228.9, 0, 150, 228.9, 1, 1671451200000 ] ]

This example has been generated automatically.
SEND GetTradesHistory
PRIVATE - GetTradesHistory
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetTradesHistory
- #PRIVATE
Accepts the following message:
GetTradesHistory
application/json
Message IDGetTradesHistory
Retrieves a list of trades for a specified account, order ID, user, instrument, or starting and ending time stamp. The returned list begins at start index i, where i is an integer identifying a specific trade in reverse order; that is, the most recent trade has an index of 0. “Depth” is the count of trades to report backwards from StartIndex.
Users with Trading permission can retrieve trade history for accounts with which they are associated; users with Operator permission can retrieve trade history for any account.
Caution: You must coordinate StartIndex, Depth, StartTimeStamp, and EndTimeStamp to retrieve the historical information you need. As the diagram shows, it is possible to specify values (for example, EndTimeStamp and Depth) that can exclude information you may want (the red areas).
Note: In this call, “Depth” refers not to the depth of the order book, but to the count of trades to report. The owner of the trading venue determines how long to retain order history before archiving.

array<any>
Reply example

object
object
omsId
integer
The ID of the Order Management System on which the trades took place. If no other values are specified, GetTradesHistory returns the trades associated with the default account for the logged-in user on this Order Management System. Required key and value.

accountId
integer
The account ID that made the trades. If no account ID is supplied, the system assumes the default account for the logged-in user making the call.

instrumentId
integer
The ID of the instrument whose trade history is reported. If no instrument ID is included, the system returns trades for all instruments associated with the account ID and OMS.

tradeId
integer
The ID of a specific trade. If you specify TradeId, GetTradesHistory can return all states for a single trade.

orderId
integer
The ID of the order resulting in the trade. If specified, the call returns all trades associated with the order.

userId
integer
The ID of the logged-in user. If not specified, the call returns trades associated with the users belonging to the default account for the logged-in user of this OMS.

startTimeStamp
integer
The historical date and time at which to begin the trade report, in POSIX format. If not specified, reverts to the start date of this account on the trading venue.

endTimeStamp
integer
Date at which to end the trade report, in POSIX format.

depth
integer
In this case, the count of trades to return, counting from the StartIndex. If Depth is not specified, returns all trades between BeginTimeStamp and EndTimeStamp, beginning at StartIndex.

startIndex
integer
The starting index into the history of trades, from 0 (the most recent trade) and moving backwards in time. If not specified, defaults to 0.

executionId
integer
The ID of the individual buy or sell execution. If not specified, returns all.

Additional properties are NOT allowed.
object
The response is an array of objects, each element of which represents the account’s side of a trade (either buy or sell).

OMSId
integer
The ID of the Order Management System to which the account belongs.

ExecutionId
integer
The ID of this account's side of the trade. Every trade has two sides.

TradeId
integer
The ID of the overall trade.

OrderId
integer
The ID of the order causing the trade (buy or sell).

AccountId
integer
The ID of the account that made the trade (buy or sell).

AccountName
string
The Name of the account that made the trade (buy or sell).

SubAccountId
integer
Not currently used; reserved for future use. Defaults to 0.

ClientOrderId
integer
An ID supplied by the client to identify the order (like a purchase order number). The clientOrderId defaults to 0 if not supplied.

InstrumentId
integer
The ID of the instrument being traded. An instrument comprises two products, for example Dollars and BitCoin.

Side
string
One of the following potential sides of a trade:
0 Buy
1 Sell
2 Short
3 Unknown (an error condition)

OrderType
string
One of the following potential sides of a trade:
Market
Limit
BlockTrade
StopMarket
StopLimit
TrailingStopLimit
StopMarket
TrailingStopMarket

Quantity
number
The unit quantity of this side of the trade.

RemainingQuantity
number
The number of units remaining to be traded by the order after this execution. This number is not revealed to the other party in the trade. This value is also known as 'leave size' or 'leave quantity.'

Price
number
The unit price at which the instrument traded.

Value
number
The total value of the deal. The system calculates this as: unit price X quantity executed.

CounterParty
string
The ID of the other party in a block trade. Usually, IDs are stated as integers; this value is an integer written as a string.

OrderTradeRevision
integer
The revision number of this trade; usually 1.

Direction
integer
The effect of the trade on the instrument's market price. One of:
0 No change
1 Uptick
2 DownTick

IsBlockTrade
boolean
A value of true means that this trade was a block trade; a value of false that it was not a block trade.

Fee
number
Any fee levied against the trade by the Exchange.

FeeProductId
integer
The ID of the product in which the fee was levied.

OrderOriginator
integer
The ID of the user who initiated the trade.

UserName
string
The UserName of the user who initiated the trade.

TradeTimeMS
integer
The date and time that the trade took place, in milliseconds and POSIX format. All dates and times are UTC.

MakerTaker
string
One of the following potential liquidity provider of a trade:
Maker
Taker

AdapterTradeId
integer
The ID of the adapter of the overall trade.

InsideBid
number
The best (highest) price level of the buy side of the book at the time of the trade.

InsideBidSize
number
The quantity of the best (highest) price level of the buy side of the book at the time of the trade.

InsideAsk
number
The best (lowest) price level of the sell side of the book at the time of the trade.

InsideAskSize
number
The quantity of the best (lowest) price level of the sell side of the book at the time of the trade.

TradeTime
integer
The date and time that the trade took place, in C# Ticks. All dates and times are UTC.

Additional properties are NOT allowed.
#PRIVATE
Examples
[ { "OMSId": 0, "ExecutionId": 0, "TradeId": 0, "OrderId": 0, "AccountId": 0, "AccountName": "", "SubAccountId": 0, "ClientOrderId": 0, "InstrumentId": 0, "Side": "Buy", "OrderType": "Limit", "Quantity": 0, "RemainingQuantity": 0, "Price": 0, "Value": 0, "CounterParty": "", "OrderTradeRevision": 0, "Direction": 0, "IsBlockTrade": false, "Fee": 0, "FeeProductId": 0, "OrderOriginator": 0, "UserName": "", "TradeTimeMS": 0, "MakerTaker": "Maker", "AdapterTradeId": 0, "InsideBid": 0, "InsideBidSize": 0, "InsideAsk": 0, "InsideAskSize": 0, "IsQuote": 0, "TradeTime": 0 } ]

This example has been generated automatically.
SEND GetUserInfo
PRIVATE - GetUserInfo
Operation IDGetUserInfo
- #PRIVATE
Accepts the following message:
GetUserInfo
application/json
Message IDGetUserInfo
Returns an object with the user data.

object
Reply example

Additional properties are NOT allowed.
object
object
additionalProperties
false
object
AccountId
integer
Account identifier.

DateTimeCreated
string
Date and time of registration.

Email
string
User e-mail.

EmailVerified
boolean
Whether the e-mail has been verified.

Locked
boolean
True if this user is currently locked; false otherwise.

Use2FA
boolean
Whether user use 2FA.

UserId
integer
User identifier.

UserName
string
User name.

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "AccountId": 8719289677238762, "DateTimeCreated": "2020-05-18T16:43:16.646Z", "Email": "[email protected]", "EmailVerified": true, "Locked": false, "Use2FA": false, "UserId": 8719289677238762, "UserName": "[email protected]" }

This example has been generated automatically.
SEND GetUserPermissions
PRIVATE - GetUserPermissions
Operation IDGetUserPermissions
- #PRIVATE
Accepts the following message:
GetUserPermissions
application/json
Message IDGetUserPermissions
Returns the permissions for use.

object
Reply example

Additional properties are NOT allowed.
object
object
array<string>
Items:
string
User permission

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "output": [ "Trading", "Deposit", "Withdraw" ] }

This example has been generated automatically.
SEND GetWithdrawTickets
PRIVATE - GetWithdrawTickets
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDGetWithdrawTickets
- #PRIVATE
Accepts the following message:
GetWithdrawTickets
application/json
Message IDGetWithdrawTickets
Returns a limited array of withdrawal tickets from the specified Order Management System and account.
GetWithdrawTickets is usable with Operator and Trading permissions. It returns tickets from a logged account.

array<any>
Reply example

object
object
Limit
integer
OPTIONAL. A pointer into the stream of withdrawal tickets. The oldest ticket is ticket 0. The default value for Limit is 0.

Additional properties are NOT allowed.
object
object
The Response is an array of detail information about the withdrawal.

AccountId
integer
The ID of the account that made the withdrawal.

AssetId
integer
The ID of the asset (product) that was withdrawn. Withdrawal fees (if any) are usually assessed in the same asset that was withdrawn.

RequestUserId
integer
The user ID of the user who submitted the withdrawal.

CreatedTimestamp
string
The time and date when the withdrawal ticket was created, in Microsoft Ticks format. All times and dates are UTC.

AssetName
string
The short name of the asset. For example, BTC for BitCoin or USD for US Dollars.

Amount
number
The number of units or fractions of units of the asset that were withdrawn (not the asset's monetary value). For example, 2.5 BitCoin or 2018.00 US Dollars.

TicketNumber
integer
The number of the ticket, as assigned by the system.

Status
integer
The current status of the withdrawal ticket. Some of these statuses are valid only for cryptocurrency withdrawals, which uses an automated withdrawal process, and some are valid for fiat currency withdrawals, which requires a human admin (operator).

Withdraw ticket statuses:

New (awaiting operator review)

AdminProcessing (An admin is looking at the ticket)

Accepted (withdrawal will proceed)

Rejected (admin or automatic rejection)

SystemProcessing (automatic processing underway)

FullyProcessed (the withdrawal has concluded)

Failed (the withdrawal failed for some reason)

Pending (the admin has placed the withdrawal in pending status)

Pending2Fa (user must click 2-factor authentication confirmation link)

AutoAccepted (withdrawal will be automatically processed)

Delayed (waiting for funds to be allocated for the withdrawal)

UserCanceled (withdraw canceled by user or Superuser)

AdminCanceled (withdraw canceled by Superuser)

AmlProcessing (anti-money-laundering process underway)

AmlAccepted (anti-money-laundering process complete)

AmlRejected (withdrawal did not stand up to anti-money-laundering process)

AmlFailed (withdrawal did not complete anti-money-laundering process)

LimitsAccepted (withdrawal meets limits for fiat or crypto asset)

LimitsRejected (withdrawal does not meet limits for fiat or crypto asset)

Submitted (withdrawal sent to Account Provider; awaiting blockchain confirmation)

Confirmed (Account Provider confirms that withdrawal is on the blockchain)

ManuallyConfirmed (admin has sent withdrawal via wallet or admin function directly; marks ticket as FullyProcessed; debits account)

Confirmed2Fa (user has confirmed withdraw via 2-factor authentication.)

LastUpdateTimestamp
string
The time and date when the withdrawal ticket was last updated, in Microsoft Ticks format. All times and dates are UTC.

FeeAmt
number
The amount of any fee that was charged for the withdrawal. feeAmt is always denominated in the asset or product that was withdrawn.

object
The contents of the template form vary from Account Provider to Account Provider depending on the asset being withdrawn and the identity of the Account Provider. The Response returns this information as a string.

TemplateType
string
If is crypto. Currency name.

Comment
string
If is crypto. Withdrawal's destination label given by user.

ExternalAddress
string
If is crypto. Withdrawal's destination source.

fullName
string
If is fiat. Member name.

bankNumber
string
If is fiat. Bank number.

branchNumber
string
If is fiat. Bank Agency number

checkDigit1
string
If is fiat. Bank Agency Digit

bankAccountNumber
string
If is fiat. Bank Account Number

checkDigit2
string
If is fiat. Bank Account Digit

typeOfAcct
string
If is fiat. Bank Account Type

Additional properties are allowed.
string
JSON string object.

TxId
string
Withdraw's transaction ID.

object
Withdrawal informations. Only available for crypto currencies.

AccountProviderName
string
The currency name.

TXId
string
Withdraw's transaction ID.

ToAddress
string
Withdrawal's destination source.

Comments
string
Blockchain URL to verify the transaction.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are NOT allowed.
#PRIVATE
Examples
{ "viewer": [ { "AccountId": 8896771987272362, "AssetId": 2, "TemplateFormType": null, "CreatedTimestamp": "2022-01-01T12:00:00.000Z", "AssetName": "R$", "Amount": 11, "TicketNumber": 3835049411532886, "Status": "FullyProcessed", "LastUpdateTimestamp": "2022-01-01T12:30:00.000Z", "FeeAmt": 10.099, "TemplateForm": { "language": "pt", "fullName": "Member Name", "bankNumber": "111", "branchNumber": "1111", "checkDigit1": null, "bankAccountNumber": "11111", "checkDigit2": "1", "typeOfAcct": "Corrente" }, "WithdrawTransactionDetails": "{\"TxId\":null}", "WithdrawInfo": null }, { "AccountId": 8896771987272362, "AssetId": 1, "TemplateFormType": null, "CreatedTimestamp": "2022-01-01T12:30:00.000Z", "AssetName": "BTC", "Amount": 0.5, "TicketNumber": 6475565438197139, "Status": "FullyProcessed", "LastUpdateTimestamp": "2022-01-01T13:00:00.000Z", "FeeAmt": 0.0004, "TemplateForm": { "TemplateType": "BitcoinRPCWithdraw", "Comment": "BTC#DJZOO", "ExternalAddress": "tb1ql0287w6gw4lhmuw80sndt2elx9ucw4pj5lntxt" }, "WithdrawTransactionDetails": "{\"TxId\":null}", "WithdrawInfo": { "AccountProviderName": "Bitcoin", "TXId": null, "FromAddress": "", "ToAddress": "tb1ql0287w6gw4lhmuw80sndt2elx9ucw4pj5lntxt", "Comments": "https://blockchain.com/pt/btc/tx/" } } ] }

This example has been generated automatically.
SEND Logout
PUBLIC - Logout
Operation IDLogout
- #PUBLIC
Accepts the following message:
Logout
application/json
Message IDLogout
LogOut ends the current websocket session.

object
Reply example

Additional properties are NOT allowed.
object
object
There is no payload for a LogOut request.

Additional properties are NOT allowed.
object
result
boolean
A successful logout returns true; an unsuccessful logout (an error condition) returns false.

errormsg
string
A successful logout returns null; the errormsg parameter for an unsuccessful logout returns one of the following messages:
Not Authorized (errorcode 20)
Invalid Response (errorcode 100)
Operation Failed (errorcode 101)
Server Error (errorcode 102)
Resource Not Found (errorcode 104)

Not Authorized and Resource Not Found are unlikely errors for a LogOut.

errorcode
integer
A successful logout returns 0. An unsuccessful logout returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send. Usually null.

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "result": true, "errormsg": null, "errorcode": 0, "detail": null }

This example has been generated automatically.
SEND SendOrder
PRIVATE - SendOrder
This WebSocket channel is deprecated and will no longer receive new features. Please use the corresponding REST endpoint for the latest updates and improvements.
Operation IDSendOrder
- #PRIVATE
Accepts the following message:
SendOrder
application/json
Message IDSendOrder
Creates an order.
Anyone submitting an order should also subscribe to the various market data and event feeds, or call GeOpenOrders or GetOrderStatus to monitor the status of the order. If the order is not in a state to be executed, GetOpenOrders will not return it.
A user with Trading permission can create an order only for those accounts and instruments with which the user is associated; a user with Operator permissions can create an order for any account and instrument.

object
Reply example

Additional properties are NOT allowed.
object
object
OMSId
integer
The ID of the Order Management System where the instrument is traded.

InstrumentId
integer
The ID of the instrument that is the subject of the snapshot.

AccountId
integer
The ID of the account placing the order.

TimeInForce
integer
An integer that represents the period during which the new order is executable. One of:
0 Unknown (error condition)
1 GTC (good 'til canceled, the default)
2 OPG (execute as close to opening price as possible)
3 IOC (immediate or canceled)
4 FOK (fill-or-kill — fill immediately or kill immediately)
5 GTX (good 'til executed)
6 GTD (good 'til date)

ClientOrderId
integer
A user-assigned ID for the order (like a purchase-order number assigned by a company). This ID is useful for recognizing future states related to this order. ClientOrderId defaults to 0.

OrderIdOCO
integer
The order ID if One Cancels the Other — If this order is order A, OrderIdOCO refers to the order ID of an order B (which is not the order being created by this call). If order B executes, then order A created by this call is canceled. You can also set up order B to watch order A in the same way, but that may require an update to order B to make it watch this one, which could have implications for priority in the order book. See CancelReplaceOrder and ModifyOrder.

UseDisplayQuantity
boolean
If you enter a Limit order with a reserve, you must set UseDisplayQuantity to true.

Side
integer
A number representing on of the following potential sides of a trade. One of:
0 Buy
1 Sell
2 Short
3 unknown (an error condition)

Quantity
number
The quantity of the instrument being ordered.

OrderType
integer
A number representing the nature of the order. One of:
0 Unknown
1 Market
2 Limit
3 StopMarket
4 StopLimit
5 TrailingStopMarket
6 TrailingStopLimit
7 BlockTrade.

PegPriceType
integer
When entering a stop/trailing order, set PegPriceType to an integer that corresponds to the type of price that pegs the stop:
1 Last
2 Bid
3 Ask
4 Midpoint

LimitPrice
number
The price at which to execute the order, if the order is a Limit order.

Additional properties are NOT allowed.
object
status
string
If the order is accepted by the system, it returns Accepted, if not it returns Rejected.
Accepted
Rejected

errormsg
string
Any error message the server returns.

OrderId
integer
The ID assigned to the order by the server. This allows you to track the order.

Additional properties are NOT allowed.
#PRIVATE
Examples
{ "status": "Accepted", "errormsg": "", "OrderId": 123 }

This example has been generated automatically.
SEND SubscribeAccountEvents
PRIVATE - SubscribeAccountEvents
Operation IDSubscribeAccountEvents
- #PRIVATE
Accepts the following message:
SubscribeAccountEvents
application/json
Message IDSubscribeAccountEvents
Subscribes the user to notifications about the status of account-level events: orders, trades, position updates, deposits, and withdrawals for a specific account on the Order Management System (OMS). The subscription reports all events associated with a given account; there is no filter at the call level to subscribe to some events and not others.

object
Reply example

Additional properties are NOT allowed.
object
object
Additional properties are NOT allowed.
object
Subscribe
boolean
A successful subscription returns true; otherwise, false.

Additional properties are NOT allowed.
object
The events that can be received from the subscription.

object
The account position event.

AccountId
string
The unique identifier of the account.

ProductSymbol
string
The symbol of the product.

ProductId
string
The unique identifier of the product.

ProductCode
string
The code of the product.

Amount
number
The amount of the position.

Hold
number
The amount of the position that is on hold.

PendingDeposits
number
The amount of the position that is pending deposit.

PendingWithdraws
number
The amount of the position that is pending withdraw.

TotalDayDeposits
number
The total amount of deposits for the day.

TotalMonthDeposits
number
The total amount of deposits for the month.

TotalDayWithdraws
number
The total amount of withdraws for the day.

TotalMonthWithdraws
number
The total amount of withdraws for the month.

Additional properties are allowed.
object
The new order rejected event.

OMSId
string
The unique identifier of the OMS.

AccountId
number
The unique identifier of the account.

ClientOrderId
number
The unique identifier of the client order.

Status
string
The status of the order.

Allowed values:
"rejected"
RejectReason
string
The reason for the rejection.

Additional properties are allowed.
object
The order state event.

Side
string
The side of the order.

Allowed values:
"buy"
"sell"
OrderId
number
The unique identifier of the order.

Price
number
The price of the order.

StopPrice
string
The stop price of the order.

Quantity
number
The quantity of the order.

DisplayQuantity
number
The display quantity of the order.

Instrument
string
The instrument of the order.

Account
number
The unique identifier of the account.

AccountName
string
The name of the account.

OrderType
string
The type of the order.

Allowed values:
"StopMarket"
"Market"
"Limit"
"Instant"
ClientOrderId
number
The unique identifier of the client order.

OrderState
string
The state of the order.

Allowed values:
"Rejected"
"Working"
"FullyExecuted"
"Canceled"
ReceiveTime
integer
format: timestamp
The time the order was received.

ReceiveTimeTicks
integer
The time the order was received in ticks.

LastUpdatedTime
integer
format: timestamp
The time the order was last updated.

LastUpdatedTimeTicks
integer
The time the order was last updated in ticks.

OrigQuantity
number
The original quantity of the order.

QuantityExecuted
number
The quantity executed of the order.

GrossValueExecuted
number
The gross value executed of the order.

ExecutableValue
number
The executable value of the order.

AvgPrice
number
The average price of the order.

CounterPartyId
number
The unique identifier of the counter party.

ChangeReason
string
The reason for the change.

EnteredBy
string
The user who entered the order.

UserName
string
The name of the user.

Additional properties are allowed.
object
The order trade event.

ExecutionId
number
The unique identifier of the execution.

TradeId
number
The unique identifier of the trade.

OrderId
number
The unique identifier of the order.

AccountId
number
The unique identifier of the account.

AccountName
string
The name of the account.

ClientOrderId
number
The unique identifier of the client order.

InstrumentId
number
The unique identifier of the instrument.

Side
string
The side of the order.

Allowed values:
"buy"
"sell"
OrderType
string
The type of the order.

Allowed values:
"StopMarket"
"Market"
"Limit"
"Instant"
Quantity
number
The quantity of the trade.

RemainQuantity
number
The remaining quantity of the order.

Price
number
The price which the trade was executed.

Value
number
The value of the trade.

CounterParty
number
The unique identifier of the counter party.

Direction
string
The direction of the trade.

Allowed values:
"NoChange"
"UpTick"
"DownTick"
Fee
number
The fee of the trade.

FeeProductId
number
The unique identifier of the product of the fee.

OrderOriginator
number
The originator of the order.

UserName
string
The name of the user.

TradeTimeMS
integer
The time the trade was executed in milliseconds.

MakerTaker
string
The maker taker of the trade.

Allowed values:
"Maker"
"Taker"
TradeTime
integer
format: timestamp
The time the trade was executed.

Additional properties are allowed.
Additional properties are allowed.
#PRIVATE
Examples
{ "Subscribe": true }

This example has been generated automatically.
SEND SubscribeLevel1
PUBLIC - SubscribeLevel1
Operation IDSubscribeLevel1
- #PUBLIC
Accepts the following message:
SubscribeLevel1
application/json
Message IDSubscribeLevel1
Retrieves the latest Level 1 Ticker information and then subscribes the user to ongoing Level 1 market data event updates for one specific instrument.
The SubscribeLevel1 call responds with the Level 1 response shown below. The OMS then periodically sends in the same format as this response Leve1UpdateEvent information when best-bid/best-offer issue, until you send the UnsubscribeLevel1 call.
Only a user with Operator permission can issue Level1MarketData permission using the call *AddUserMarketDataPermission.

object
Reply example

Additional properties are NOT allowed.
object
object
InstrumentId
number
The ID of the instrument you’re tracking.

MarketId
string
btcbrl

Additional properties are NOT allowed.
object
OMSId
integer
The ID of the Order Management System on which the instrument trades.

InstrumentId
integer
The ID of the instrument being tracked.

MarketId
string
btcbrl

BestBid
number
The current best bid for the instrument.

BestOffer
number
The current best offer for the instrument.

LastTradedPx
number
The last-traded price for the instrument.

LastTradedQty
number
The last-traded quantity for the instrument.

LastTradeTime
integer
The time of the last trade, in POSIX format.

SessionOpen
number
Opening price. In markets with openings and closings, this is the opening price for the current session; in 24-hour markets, it is the price as of UTC Midnight.

SessionHigh
number
Highest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight.

SessionLow
number
Lowest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight.

SessionClose
number
The closing price. In markets with openings and closings, this is the closing price for the current session; in 24-hour markets, it is the price as of UTC Midnight.

Volume
number
The last-traded quantity for the instrument, same value as LastTradedQty

CurrentDayVolume
number
The unit volume of the instrument traded either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight.

CurrentDayNumTrades
integer
The number of trades during the current day, either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight.

CurrentDayPxChange
number
Current day price change, either during a trading session or UTC Midnight to UTC midnight.

Rolling24HrVolume
number
Unit volume of the instrument during the past 24 hours, regardless of time zone. Recalculates continuously.

Rolling24NumTrades
integer
Number of trades during the past 24 hours, regardless of time zone. Recalculates continuously.

Rolling24HrPxChange
number
Price change during the past 24 hours, regardless of time zone. Recalculates continuously.

TimeStamp
integer
The time this information was provided, in POSIX format.

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "OMSId": 1, "InstrumentId": 1, "BestBid": 6423.57, "BestOffer": 6436.53, "LastTradedPx": 6423.57, "LastTradedQty": 0.96183964, "LastTradeTime": 1534862990343, "SessionOpen": 6249.64, "SessionHigh": 11111, "SessionLow": 4433, "SessionClose": 6249.64, "Volume": 0.96183964, "CurrentDayVolume": 3516.31668185, "CurrentDayNumTrades": 8529, "CurrentDayPxChange": 173.93, "CurrentNotional": 0, "Rolling24HrNotional": 0, "Rolling24HrVolume": 4319.63870783, "Rolling24NumTrades": 10585, "Rolling24HrPxChange": -0.4165607307408487, "TimeStamp": "1534862990358" }

This example has been generated automatically.
SEND SubscribeLevel1Markets
PUBLIC - SubscribeLevel1Markets
Operation IDSubscribeLevel1Markets
- #PUBLIC
Accepts the following message:
SubscribeLevel1Markets
application/json
Message IDSubscribeLevel1Markets
Retrieves the latest Level 1 Ticker information and then subscribes the user to ongoing Level 1 market data event updates for one specific instrument.
The SubscribeLevel1 call responds with the Level 1 Markets response shown below. The OMS then periodically sends in the same format as this response Leve1UpdateEvent information when best-bid/best-offer issue, until you send the UnsubscribeLevel1 call.
Only a user with Operator permission can issue Level1MarketData permission using the call *AddUserMarketDataPermission.

object
Reply example

Additional properties are NOT allowed.
object
object
array<string>
Items:
string
btcbrl

Additional properties are NOT allowed.
array<object>
object
OMSId
integer
The ID of the Order Management System on which the instrument trades.

InstrumentId
integer
The ID of the instrument being tracked.

MarketId
string
btcbrl

BestBid
number
The current best bid for the instrument.

BestOffer
number
The current best offer for the instrument.

LastTradedPx
number
The last-traded price for the instrument.

LastTradedQty
number
The last-traded quantity for the instrument.

LastTradeTime
integer
The time of the last trade, in POSIX format.

SessionOpen
number
Opening price. In markets with openings and closings, this is the opening price for the current session; in 24-hour markets, it is the price as of UTC Midnight.

SessionHigh
number
Highest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight.

SessionLow
number
Lowest price during the trading day, either during a session with opening and closing prices or UTC midnight to UTC midnight.

SessionClose
number
The closing price. In markets with openings and closings, this is the closing price for the current session; in 24-hour markets, it is the price as of UTC Midnight.

Volume
number
The last-traded quantity for the instrument, same value as LastTradedQty

CurrentDayVolume
number
The unit volume of the instrument traded either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight.

CurrentDayNumTrades
integer
The number of trades during the current day, either during a session with openings and closings or in 24-hour markets, the period from UTC Midnight to UTC Midnight.

CurrentDayPxChange
number
Current day price change, either during a trading session or UTC Midnight to UTC midnight.

Rolling24HrVolume
number
Unit volume of the instrument during the past 24 hours, regardless of time zone. Recalculates continuously.

Rolling24NumTrades
integer
Number of trades during the past 24 hours, regardless of time zone. Recalculates continuously.

Rolling24HrPxChange
number
Price change during the past 24 hours, regardless of time zone. Recalculates continuously.

TimeStamp
integer
The time this information was provided, in POSIX format.

Additional properties are allowed.
#PUBLIC
Examples
[ { "OMSId": 1, "InstrumentId": 1, "BestBid": 6423.57, "BestOffer": 6436.53, "LastTradedPx": 6423.57, "LastTradedQty": 0.96183964, "LastTradeTime": 1534862990343, "SessionOpen": 6249.64, "SessionHigh": 11111, "SessionLow": 4433, "SessionClose": 6249.64, "Volume": 0.96183964, "CurrentDayVolume": 3516.31668185, "CurrentDayNumTrades": 8529, "CurrentDayPxChange": 173.93, "CurrentNotional": 0, "Rolling24HrNotional": 0, "Rolling24HrVolume": 4319.63870783, "Rolling24NumTrades": 10585, "Rolling24HrPxChange": -0.4165607307408487, "TimeStamp": "1534862990358" } ]

This example has been generated automatically.
SEND SubscribeLevel2
PUBLIC - SubscribeLevel2
Operation IDSubscribeLevel2
- #PUBLIC
Accepts the following message:
SubscribeLevel2
application/json
Message IDSubscribeLevel2
Retrieves the latest Level 2 Ticker information and then subscribes the user to Level 2 market data event updates for one specific instrument. Level 2 allows the user to specify the level of market depth information on either side of the bid and ask. The SubscribeLevel2 call responds with the Level 2 response shown below. The OMS then periodically sends Level2UpdateEvent information in the same format as this response until you send the UnsubscribeLevel2 call.
Only a user with Operator permission can issue a Level2MarketData permission using the call AddUserMarketDataPermission.

array<any>
Reply example

object
object
InstrumentId
integer
The ID of the instrument you’re tracking. Conditionally optional.

MarketId
string
btcbrl

Depth
integer
The depth of the order book. The example request returns 10 price levels on each side of the market.

Additional properties are NOT allowed.
array<any>
MDUpdateID
integer
Market Data Update ID. This sequential ID identifies the order in which the update was created.

NumberAccounts
integer
Number of accounts

ActionDateTime
integer
ActionDateTime identifies the time and date that the snapshot was taken or the event occurred, in POSIX format X 1000 (milliseconds since 1 January 1970).

ActionType
integer
L2 information provides price data. This value shows whether this data is:
0 new
1 update
2 deletion.

LastTradePrice
number
The price at which the instrument was last traded.

NumberOrders
integer
Number of orders.

Price
number
Bid or Ask price for the Quantity (see Quantity below).

ProductPairCode
integer
ProductPairCode is the same value and used for the same purpose as InstrumentID. The two are completely equivalent. InstrumentId 47 = ProductPairCode 47.

Quantity
number
Quantity available at a given Bid or Ask price (see Price above).

Side
integer
One of:
0 Buy
1 Sell
2 Short (reserved for future use)
3 Unknown (error condition)

#PUBLIC
Examples
[ [ 0, 1, 123, 0, 0, 0, 0, 0, 0, 0 ] ]

This example has been generated automatically.
SEND SubscribeTicker
PUBLIC - SubscribeTicker
Operation IDSubscribeTicker
- #PUBLIC
Accepts the following message:
SubscribeTicker
application/json
Message IDSubscribeTicker
Subscribes a user to a Ticker Market Data Feed for a specific instrument and interval. SubscribeTicker sends a response object as described below, and then periodically returns a TickerDataUpdateEvent that matches the content of the response object.
Only a user with Operator permission can issue a Level1MarketData permission using the call AddUserMarketDataPermission.

array<any>
Reply example

object
object
OMSId
integer
The ID of the Order Management System.

InstrumentId
integer
The ID of the instrument whose information you want to track.

Interval
integer
Specifies in seconds how frequently to obtain ticker updates. Default is 60 — one minute.

IncludeLastCount
integer
The limit of records returned in the ticker history. The default is 100.

Additional properties are NOT allowed.
array<any>
The response returns an array of objects , each object an unlabeled, comma-delimited array of numbers. The Open price and Close price are those at the beginning of the tick — the Interval time subscribed to in the request. For 24-hour exchanges, the trading day runs from UTC midnight to UTC midnight; highs, lows, opens, closes, and volumes consider that midnight-to-midnight period to be the trading day. The data order is:

date/time UTC in milliseconds since 1/1/1970
high
low
open
close
volume
inside bid price
inside ask price
instrument ID

A typical response might look like this: [[1510719222970.21,6943.51,6890.27,6898.41,6891.16,0,6890.98,6891.98,1,1510718681956.34]]

#PUBLIC
Examples
[ [ 1501603632000, 2700.33, 2701.268701, 2687.01, 2687.01, 24.86100992, 0, 2870.95, 1 ], [ 1501604532000, 2792.73, 2667.95, 2687.01, 2700.81, 242.61340767, 0, 2871, 0 ] ]

This example has been generated automatically.
SEND SubscribeTrades
PUBLIC - SubscribeTrades
Operation IDSubscribeTrades
- #PUBLIC
Accepts the following message:
SubscribeTrades
application/json
Message IDSubscribeTrades
Subscribes an authenticated user to the Trades Market Data Feed for a specific instrument. Each trade has two sides: Buy and Sell.
SubscribeTrades returns the response documented here for your immediate information, then periodically sends the OrderTradeEvent documented in SubscribeAccountEvents. Only a user with Operator permission can issue the permission Level1MarketData using the call AddUserMarketDataPermission.

array<any>
Reply example

object
object
OMSId
integer
The ID of the Order Management System on which the instrument is traded.

InstrumentId
integer
The ID of the instrument whose trades will be reported.

IncludeLastCount
integer
Specifies the number of previous trades to retrieve in the immediate snapshot. Default is 100.

Additional properties are NOT allowed.
array<any>
0 (TradeId)
integer
The ID of this trade.

1 (ProductPairCode)
integer
ProductPairCode is the same number and used for the same purpose as InstrumentID. The two are completely equivalent in value. InstrumentId 47 = ProductPairCode 47.

2 (Quantity)
integer
The quantity of the instrument traded.

3 (Price)
integer
The price at which the instrument traded.

4 (Order1)
integer
The ID of the first order that resulted in the trade, either Buy or Sell.

5 (Order2)
integer
The ID of the second order that resulted in the trade, either Buy or Sell.

6 (Tradetime)
integer
UTC trade time in Total Milliseconds. POSIX format.

7 (Direction)
integer
Effect of the trade on the instrument’s market price. One of:
0 NoChange
1 UpTick
2 DownTick

8 (TakerSide)
integer
Which side of the trade took liquidity? One of:
0 Buy
1 Sell

9 (BlockTrade)
boolean
Was this a privately negotiated trade that was reported to the OMS? A private trade returns 1 (true); otherwise 0 (false). Default is false. Block trades are not supported in exchange version 3.1

10 (order1ClientId or order2ClientId)
integer
The client-supplied order ID for the trade. Internal logic determines whether the program reports the order1ClientId or the order2ClientId.

#PUBLIC
Examples
[ [ 63, 1, 0.001, 9346, "184", "192", 1588191985835, 0, 1, false, 0 ] ]

This example has been generated automatically.
SEND UnsubscribeLevel1
PUBLIC - UnsubscribeLevel1
Operation IDUnsubscribeLevel1
- #PUBLIC
Accepts the following message:
UnsubscribeLevel1
application/json
Message IDUnsubscribeLevel1
Unsubscribes the user from a Level 1 Market Data Feed subscription.

object
Retry example

Additional properties are NOT allowed.
object
object
OMSId
integer
The ID of the Order Management System on which the user has subscribed to a Level 1 market data feed.

InstrumentId
integer
The ID of the instrument being tracked by the Level 1 market data feed.

Additional properties are NOT allowed.
object
result
boolean
A successful receipt of the unsubscribe request returns true; and unsuccessful receipt (an error condition) returns false.

errormsg
string
A successful receipt of the unsubscribe request returns null; the errormsg parameter for an unsuccessful request returns one of the following messages:
Not Authorized (errorcode 20)
Invalid Request (errorcode 100)
Operation Failed (errorcode 101)
Server Error (errorcode 102)
Resource Not Found (errorcode 104)

errorcode
integer
A successful receipt of the unsubscribe request returns 0. An unsuccessful receipt returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send. Usually null.

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "result": true, "errormsg": null, "errorcode": 0, "detail": null }

This example has been generated automatically.
SEND UnsubscribeLevel2
PUBLIC - UnsubscribeLevel2
Operation IDUnsubscribeLevel2
- #PUBLIC
Accepts the following message:
UnsubscribeLevel2
application/json
Message IDUnsubscribeLevel2
Unsubscribes the user from a Level 2 Market Data Feed subscription.

object
Retry example

Additional properties are NOT allowed.
object
object
OMSId
integer
The ID of the Order Management System on which the user has subscribed to a Level 2 market data feed.

InstrumentId
integer
The ID of the instrument being tracked by the Level 2 market data feed.

Additional properties are NOT allowed.
object
result
boolean
A successful receipt of the unsubscribe request returns true; and unsuccessful receipt (an error condition) returns false.

errormsg
string
A successful receipt of the unsubscribe request returns null; the errormsg parameter for an unsuccessful request returns one of the following messages:
Not Authorized (errorcode 20)
Invalid Request (errorcode 100)
Operation Failed (errorcode 101)
Server Error (errorcode 102)
Resource Not Found (errorcode 104)

errorcode
integer
A successful receipt of the unsubscribe request returns 0. An unsuccessful receipt returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send. Usually null.

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "result": true, "errormsg": null, "errorcode": 0, "detail": null }

This example has been generated automatically.
SEND UnsubscribeTicker
PUBLIC - UnsubscribeTicker
Operation IDUnsubscribeTicker
- #PUBLIC
Accepts the following message:
UnsubscribeTicker
application/json
Message IDUnsubscribeTicker
Unsubscribes the user from a Ticker Market Data Fee.

object
Reply example

Additional properties are NOT allowed.
object
object
InstrumentId
integer
The ID of the instrument being tracked by the ticker market data feed.

Additional properties are NOT allowed.
object
result
boolean
A successful receipt of the unsubscribe request returns true; and unsuccessful receipt (an error condition) returns false.

errormsg
string
A successful receipt of the unsubscribe request returns null; the errormsg parameter for an unsuccessful request returns one of the following messages:
Not Authorized (errorcode 20)
Invalid Request (errorcode 100)
Operation Failed (errorcode 101)
Server Error (errorcode 102)
Resource Not Found (errorcode 104)

errorcode
integer
A successful receipt of the unsubscribe request returns 0. An unsuccessful receipt returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send. Usually null.

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "result": true, "errormsg": null, "errorcode": 0, "detail": null }

This example has been generated automatically.
SEND UnsubscribeTrades
PUBLIC - UnsubscribeTrades
Operation IDUnsubscribeTrades
- #PUBLIC
Accepts the following message:
UnsubscribeTrades
application/json
Message IDUnsubscribeTrades
Unsubscribes the user from a Trades Market Data Feed.

object
Retry example

Additional properties are NOT allowed.
object
object
OMSId
integer
The ID of the Order Management System on which the user has subscribed to a trades market data feed.

InstrumentId
integer
The ID of the instrument being tracked by the trades market data feed.

Additional properties are NOT allowed.
object
result
boolean
A successful receipt of the unsubscribe request returns true; and unsuccessful receipt (an error condition) returns false.

errormsg
string
A successful receipt of the unsubscribe request returns null; the errormsg parameter for an unsuccessful request returns one of the following messages:
Not Authorized (errorcode 20)
Invalid Request (errorcode 100)
Operation Failed (errorcode 101)
Server Error (errorcode 102)
Resource Not Found (errorcode 104)

errorcode
integer
A successful receipt of the unsubscribe request returns 0. An unsuccessful receipt returns one of the errorcodes shown in the errormsg list.

detail
string
Message text that the system may send. Usually null.

Additional properties are NOT allowed.
#PUBLIC
Examples
{ "result": true, "errormsg": null, "errorcode": 0, "detail": null }

This example has been generated automatically.

Foxbit websocket API 2.0

Introduction to WebSocket and how to use

GitHub – WebSocket Example

Connecting Websocket

WS Rate-Limit

Message Fame example

Payload

Events

Sending Data

Authentication

Operations

SEND AuthenticateUser

Examples

This example has been generated automatically.

SEND CancelAllOrders

Examples

This example has been generated automatically.

SEND CancelOrder

Examples

This example has been generated automatically.

SEND GetAccountInfo

Examples

This example has been generated automatically.

SEND GetAccountPositions

Examples

This example has been generated automatically.

SEND GetAccountTrades

Examples

This example has been generated automatically.

SEND GetDepositTickets

Examples

This example has been generated automatically.

SEND GetInstrument

Examples

This example has been generated automatically.

SEND GetInstruments

Examples

This example has been generated automatically.

SEND GetOpenOrders

Examples

This example has been generated automatically.

SEND GetOrderHistory

Examples

This example has been generated automatically.

SEND GetOrderStatus

Examples

This example has been generated automatically.

SEND GetProducts

Examples

This example has been generated automatically.

SEND GetL2Snapshot

Examples

This example has been generated automatically.

SEND GetTickerHistory

Examples

This example has been generated automatically.

SEND GetTradesHistory

Examples

This example has been generated automatically.

SEND GetUserInfo

Examples

This example has been generated automatically.

SEND GetUserPermissions

Examples

This example has been generated automatically.

SEND GetWithdrawTickets

Examples

This example has been generated automatically.

SEND Logout

Examples

This example has been generated automatically.

SEND SendOrder

Examples

This example has been generated automatically.

SEND SubscribeAccountEvents

Examples

This example has been generated automatically.

SEND SubscribeLevel1

Examples

This example has been generated automatically.