Completes the second part of a two-factor authentication by sending the authentication token from the non-AlphaPoint authentication system to the Order Management System. The call returns a verification that the user logging in has been authenticated, and a token. Here is how the two-factor authentication process works:
Code holds the token obtained from the other authentication source.
Cancels all open matching orders for the specified instrument, account, user (subject to permission level) or a combination of them on a specific Order Management System. User and account permissions govern cancellation actions.
| UserId 37 | AccId 14 | Instr 25 | Result |
|---|---|---|---|
| X | X | X | Account #14 belonging to user #37 for instrument #25. |
| X | X | Account #14 belonging to user #37 for all instruments. | |
| X | X | All accounts belonging to user #37 for instrument #25. | |
| X | All accounts belonging to user #37 for all instruments. | ||
| X | X | All users of account #14 for instrument #25. | |
| X | All users of account #14 for all instruments. | ||
| X | All accounts of all users for instrument #25. (requires special permission) | ||
| All accounts of all users for all instruments (requires special permission) |
The Order Management System under which the account operates.Required
Cancels an open order that has been placed but has not yet been executed. Only a trading venue operator can cancel orders for another user or account
The Order Management System on which the order exists. Required
Cancels a quote that has not been executed yet. Quoting is not enabled for the retail end user of the AlphaPoint software. Only registered market participants or market makers may quote. Only a trading venue operator can cancel quotes for another user.
The ID of the Order Management System where the quote was requested. Required
The ID of the bid quote. Required.
The ID of the ask quote. Required
CancelReplaceOrder is single API call that both cancels an existing order and replaces it with a
new order. Canceling one order and replacing it with another also cancels the order’s priority in
the order book. You can use ModifyOrder to preserve priority in the book; but ModifyOrder only
allows a reduction in order quantity.
Note: CancelReplaceOrder sacrifices the order’s priority in the order book.
Connect to FoxBit websocket endpoint
Disconnect from FoxBit websocket connection
Retrieves Fee structure for specific Account
Endpoint Type: Public
The ID of the account for which information was requested.
The ID of the Order Management System that includes the product.
Returns detailed information about one specific account belonging to the authenticated user and existing on a specific Order Management System
The ID of the Order Management System on which the account exists
The ID of the account on the Order Management System for which information will be returned.
AccountHandle is a unique user-assigned name that is checked at create time by the Order Management System. Alternate to Account ID.
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.
The ID of the authenticated user’s account on the Order Management System for which positions will be returned.
The ID of the Order Management System to which the user belongs. A user will belong only to one OMS.
Requests the details on up to 200 past trade executions for a single specific user account and its
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.
The operator of the trading venue determines how long to retain an accessible trading history
before archiving.
The ID of the authenticated user’s account.
The ID of the Order Management System to which the user belongs. A user will belong only to one OMS.
The starting index into the history of trades, from 0
(the most recent trade).
The number of trades to return. The system can return up to 200 trades.
Returns a list of transactions for a specific account on an Order Management System. The owner of the trading venue determines how long to retain order history before archiving.
The ID of the account for which transactions will be returned. If not specified, the call returns transactions for the default account for the logged-in user
The ID of the Order Management System from which the account’s transactions will be returned.
The number of transactions that will be returned, starting with the most recent transaction.
Returns all deposit tickets that match the string/value pairs included in the request, starting at a specific ticket, and returning up to a total number that can be specified in the request.
OMSId and OperatorId are required; other string/value pairs are optional. AmountOperator must be included if an Amount value is included.
Returns a single deposit ticket by matching its request code to one already in the database.
Only admin-level users can issue this call.
The ID of the Order Management System where the withdrawal was made.
The ID of the trading venue operator on the system where the withdraw was made.
A GUID (globally unique ID) that identifies the specific withdrawal ticket you want to return. Obtain the RequestCode from CreateWithdrawTicket or GetAllWithdrawTickets.
The ID of the account from which the withdrawal was made.
Retrieves the details of a specific instrument from the Order Management System of the trading venue. An instrument is a pair of exchanged products (or fractions of them) such as US dollars and ounces of gold.
Endpoint Type: Public
The ID of the Order Management System from where the instrument is traded.
The ID of the instrument.
Retrieves the details of a specific instrument from the Order Management System of the trading venue. An instrument is a pair of exchanged products (or fractions of them) such as US dollars and ounces of gold.
Endpoint Type: Public
The ID of the Order Management System on which the instruments are available.
Provides a current Level 2 snapshot of a specific instrument trading on an Order Management System to a user-determined market depth
Endpoint Type: Public
The ID of the Order Management System where the instrument is traded.
The ID of the instrument that is the subject of the snapshot.
Returns an array of 0 or more orders that have not yet been filled (open orders) for a single account for a given user on a specific Order Management System. The call returns an empty array if a user has no open orders.
The ID of the authenticated user’s account
The ID of the Order Management System to which the user belongs. A user will belong only to one OMS.
Returns an estimate of the fee for a specific order and order type. Fees are set and calculated by the operator of the trading venue.
Returns a complete list of all orders, both open and executed, for a specific account on the specified Order Management System.
The ID of the Order Management System where the orders were placed
The ID of the account whose orders will be returned
Retrieves the details about a specific product on the trading venue. A product is an asset that is tradable or paid out.
Endpoint Type: Public
The ID of the Order Management System that includes the product
The ID of the product (often a currency) on the specified Order Management System.
Returns an array of products available on the trading venue. A product is an asset that is tradable or paid out
Endpoint Type: Public
The ID of the Order Management System that includes the product
Requests a ticker history (high, low, open, close, volume, bid, ask, ID) of a specific instrument from a given date forward to the present. You will need to format the returned data per your requirements.
Endpoint Type: Public
The ID of the Order Management System.
The ID of a specific instrument. The Order Management System and the default Account ID of the logged-in user are assumed.
Oldest date from which the ticker history will start, in 'yyyy-MM-ddThh:mm:ssZ' format. The report moves toward the present from this point.
GetUserConfig returns the list of key/value pairs set by the SetUserConfig call and associated with a user record. A trading venue can use Config strings to store custom information or compliance information with a user record.
}
Retrieves basic information about a user from the Order Management System. A user may only see information about himself; an administrator (or superuser) may see, enter, or change information about other users
Retrieves an array of permissions for the logged-in user. Permissions can be set only by an administrator or superuser. An administrator or superuser can set permissions for each user on an API-call by API-call basis, to allow for highly granular control. Common permission sets include Trading, Deposit, and Withdrawal (which allow trading, deposit of funds, and account withdrawals, respectively); or AdminUI, UserOperator, and AccountOperator (which allow control of the Order Management System, set of users, or an account)
The ID of the user whose permission information will be returned. A user can only retrieve his own permissions; an administrator can retrieve information about the permissions of others.
Returns a single withdraw ticket from the Order Management System, trading venue operator, and account that matches the GUID (globally unique identifier) in RequestCode. Obtain the GUID from the call CreateWithdrawTicket when the ticket is first created, or from GetAllWithdrawTickets, another admin-level-only call. An administrator can use GetWithdrawTicket to return any single withdrawal ticket in the system.
The ID of the Order Management System where the withdrawal was made.
The ID of the trading venue operator on the system where the withdraw was made.
A GUID (globally unique ID) that identifies the specific withdrawal ticket you want to return. Obtain the RequestCode from CreateWithdrawTicket or GetAllWithdrawTickets.
The ID of the account from which the withdrawal was made.
Logout ends the current websocket session
Endpoint Type: Public
RemoveUserConfig deletes a single key/value Config pair from a user record. A trading venue uses onfig strings to store custom information or compliance information with a user’s record.
The ID of the user from whose record you’re deleting the custom key/value pair
The name of the user from whose record you’re deleting the custom key/value pair
The name of the key/value pair to delete
ResetPassword is a two-step process. The first step calls ResetPassword with the user’s username. The Order Management System then sends an email to the user’s registered email address. The email contains a reset link. Clicking the link sends the user to a web page where he can enter a new password.
Endpoint Type: Public
The name of the user, for example, jsmith.
Creates an order. Anyone submitting an order should also subscribe to the various market data and event feeds, or call GetOpenOrders 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.
SetUserConfig adds an array of one or more arbitrary key/value pairs to a user record. A trading venue can use Config strings to store custom information or compliance information with a user’s record.
The ID of the user to whose record you’re adding the custom key/value pairs.
The name of the user to whose record you’re adding the custom key/value pairs.
array of key/value pairs. “Key” is always a string; but the associated Value of Key can be of any data type.
Enters basic information about a user into the Order Management System. A user may only enter or change information about himself; an administrator (or superuser) may enter or change information about other users.
The ID of the user; set by the system when the user registers.
User’s name; “John Smith.”
User’s password.
User’s email address.
Send true if you have verified the user’s email; send false if you have not verified the email address. Default is false.
The ID of the default account with which the user is associated. A user may be associated with more than one account, and more than one user may be associated with a single account. An admin or superuser can specify additional accounts
Set to true if this user must use two-factor authentication; set to false if this user does not need to user two-factor authentication. Default is false.
Retrieves the latest Level 1 Ticker information and then subscribes the user to ongoing Level 1 market data event updates for one specific instrument. For more information about Level 1 and Level 2. The SubscribeLevel1 call responds with the Level 1 response shown below. The OMS then periodically sends Leve1UpdateEvent information when best bid/best offer issues in the same format as this response, until you send the UnsubscribeLevel1 call.
Endpoint Type: Public
The ID of the Order Management System on which the instrument trades.
The ID of the instrument you’re tracking. or The symbol of the instrument you’re tracking.
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.
Endpoint Type: Public
The ID of the Order Management System on which the instrument trades.
The ID of the instrument you’re tracking or The symbol of the instrument you’re tracking
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.
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.
Endpoint Type: Public
The ID of the Order Management System
The ID of the instrument whose information you want to track.
Retrieves the latest public market trades and Subscribes User to Trade updates for the specified Instrument.
When subscribed to Trades, you will receive TradeDataUpdateEvent messages from the server
Order Management System ID
Instrument's Identifier
Unsubscribes the user from a Level 1 Market Data Feed subscription..
Endpoint Type: Public
The ID of the Order Management System on which the user has subscribed to a Level 1 market data feed.
The ID of the instrument being tracked by the Level 1 market data feed.
Unsubscribes the user from a Level 2 Market Data Feed subscription.
Endpoint Type: Public
The ID of the Order Management System on which the user has subscribed to a Level 2 market data feed.
The ID of the instrument being tracked by the Level 2 market data feed.
Unsubscribes a user from a Ticker Market Data Feed
Endpoint Type: Public
The ID of the Order Management System on which the user has subscribed to a ticker market data feed.
The ID of the instrument being tracked by the ticker market data feed.
Unsubscribes a user from the Trades Market Data Feed.
The ID of the Order Management System on which the user has subscribed to a trades market data feed.
The ID of the instrument being tracked by the trades market data feed.
WebAuthenticateUser authenticates a user (logs in a user) for the current websocket session. You must call WebAuthenticateUser in order to use the calls in this document not otherwise shown as "No authentication required."
Endpoint Type: Public
The name of the user, for example, jsmith.
The user password. The user logs into a specific Order Management System via Secure Socket Layer (SSL and HTTPS).
Generated using TypeDoc
Discover if websocket connection is open
{boolean}
FoxBitClient