APIs for functional areas

The following functions access the Marketcetera API across different functional areas.

Trade

Client Function	Purpose
readAvailableFixInitiatorSessions	Get a list of available FIX sessions. These FIX sessions must be initiator sessions and must be currently at Available status.
getOpenOrders	Get a list of open orders. These orders are at a Cancelable status and are subject to user ownership.
sendOrder/sendOrders	Send an order (or list of orders)
sendOrderSuggestion	Send an order suggestion which can later be converted to an order by user intervention
addReport	Add a new execution report. This is rarely done and typically only to address an unusual problem with a broker.
deleteReport	Delete an existing execution report. This is rarely done and can affect position accuracy.
resolveSymbol	Resolves a symbol to an instrument. Trades and other behaviors are almost always done with an Instrument, which identifies the asset class. Users usually enter symbols, and this feature closes that gap.
findRootOrderIdFor	Finds the order ID that identifies the order chain for a given order
getLatestExecutionReportForOrderChain	Get the latest Execution Report for a given order chain
getReports	Get a list of FIX message reports
getFills	Get a list of FIX messages that represent fills
getAveragePriceFills	Get a list of FIX-like messages that represent the average price for fills by instrument
addSuggestionListener	Add an order suggestion listener
removeSuggestionListener	Remove an order suggestion listener
addTradeMessageListener	Add a trade message listener to receive Execution Reports and Order Cancel Reject messages
removeTradeMessageListener	Remove a trade message listener

Market data

Client Function	Purpose
request	Initiate a market data request
cancel	Cancel an existing market data request
getSnapshot	Get the most recent snapshot of a given type of market data
addMarketDataStatusListener	Add a listener to receive market data provider status changes
removeMarketDataStatusListener	Remove an existing market data status listener
getAvailableCapability	Get the capabilities of all connected market data providers
getProviders	Get the list of all market data providers

Strategies

The Strategy API loads strategies and controls their lifecycle.

While most users control strategies through Photon and its strategy menus, you can use the existing Strategy RPC Client for headless control of strategies. You can also create a custom Strategy API implementation in another language for integration.

Client Function	Purpose
getStrategyInstances	Get a list of all current strategies (subject to user ownership)
loadStrategyInstance	Upload a new strategy instance to the server
getStrategyMessages	Retrieve a page of strategy messages for a given strategy instance
findByName	Find the strategy instance with the given name
uploadFile	Upload the implementation of a strategy instance to the server
emitMessage	Emit a strategy message from a running strategy instance. This method is available to running strategy instances only.
deleteStrategyMessage	Delete the strategy message with the given unique id
deleteAllStrategyMessages	Delete all strategy messages for the given strategy instance
startStrategyInstance	Start a loaded strategy
stopStrategyInstance	Stop a running strategy
unloadStrategyInstance	Stop a strategy and remove it from the server. It cannot be rerun after being unloaded without being loaded again.
addStrategyEventListener	Add a listener to receive strategy events
removeStrategyEventListener	Remove a strategy event listener

To upload a strategy in Photon, refer to run strategies from Photon.

Admin APIs

Client Function	Purpose
getPermissionsForCurrentUser	Returns the permissions allocated to the user logged in to the client
getCurrentUser	Returns information about the user logged in to the client
readUsers	Returns a list of all users
createUser	Creates a new user
updateUser	Updates information about an existing user
changeUserPassword	Changes the password of an existing user
deleteUser	Remove a user from the system
deactivateUser	Retain a user in the system but prevent the user from logging in
createPermission	Create a new permission
readPermissions	Read all existing permissions
updatePermission	Update information about an existing permission
createRole	Create a new role
readRoles	Returns a list of all roles
deleteRole	Remove a role from the system
updateRole	Update information about an existing role
getUserAttribute	Read a user attribute of a given type for a given user
setUserAttribute	Update a user attribute of a given type for a given user