Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AccountRestController
  • /rest/account/balance
  • /rest/account/walletHistory
  • /rest/account/withdraw
  • /rest/account/depositAddress/{exchange}/{currency}
  • /rest/account/depositAddress/{exchange}/{currency}/{walletType}
  • GET
  • GET
  • POST
  • GET
  • GET
CacheRestController
  • /rest/cache/clear-all
  • POST
ConfigRestController
  • /rest/config-params
  • /rest/broker/url/main
  • /rest/broker/url/ws
  • GET
  • GET
  • GET
HistoricalDataRestController
  • /rest/historicaldata/bars
  • /rest/historicaldata/resolutions
  • GET
  • GET
LookupRestController
  • /rest/account
  • /rest/equity.search
  • /rest/exchange
  • /rest/forex
  • /rest/order-preference
  • /rest/position
  • /rest/property
  • /rest/security
  • /rest/security.search
  • /rest/strategy
  • /rest/symbol-securities-and-accounts.search
  • /rest/symbol.search
  • /rest/transaction
  • /rest/account/{name}
  • /rest/exchange/tradinghours
  • /rest/exchange/{id}
  • /rest/position/{id}
  • /rest/security/{id}
  • /rest/security-family-by-security/{id}
  • /rest/transaction/daily
  • /rest/transaction/{id}
  • /rest/exchange/{id}/tradinghours
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
MarketDataRestController
  • /rest/subscription/marketdata/aggregated-order-book
  • /rest/subscription/marketdata/subscribe
  • /rest/subscription/marketdata/supported-feed
  • /rest/subscription/marketdata/unsubscribe
  • /rest/subscription/orderBook/{adapterType}/{ticker}
  • GET
  • PUT
  • GET
  • PUT
  • GET
MetaDataRestController
  • /rest/meta/
  • /rest/meta/orderTypes
  • /rest/meta/timezone
  • /rest/meta/version
  • GET
  • GET
  • GET
  • GET
OrderRestController
  • /rest/execution/completed-order
  • /rest/execution/next-order-id
  • /rest/execution/open-order
  • /rest/execution/order
  • /rest/execution/orderstatus
  • /rest/execution/reconciliation
  • /rest/execution/child-order/{intId}
  • /rest/execution/modify/order
  • /rest/execution/order/{intId}
  • GET
  • POST
  • GET
  • GET POST
  • GET
  • GET
  • GET
  • POST
  • DELETE GET
PositionRestController
  • /rest/position/reset-positions
  • /rest/position/transfer
  • /rest/position/transferAll
  • /rest/position/transferPartially
  • /rest/position/{id}
  • /rest/position/reduce/{id}
  • POST
  • POST
  • POST
  • POST
  • DELETE
  • POST
RfqRestController
  • /rest/execution/quote-discard
  • /rest/execution/quote-request
  • /rest/execution/quote/{quoteId}
  • POST
  • POST
  • GET
RuntimeRestController
  • /rest/init-status
  • /rest/runtime/exit-vm
  • GET
  • POST
TransactionRestController
  • /rest/transaction
  • /rest/transaction/order
  • /rest/transaction/reset-cash-balances
  • POST
  • GET
  • POST

Data Types

JSON

type description
AccountVO
AdaptiveOrderVO Base Class for all Order Types
AlgoOrderVO Base Class for all Order Types
BarVO
CurrencyAmountVO
Duration
ExchangeVO
ForexVO
LimitOrderVO Base Class for all Order Types
MarketDataEventVO
MarketDataSubscriptionVO
MarketOrderVO Base Class for all Order Types
NamedCurrencyAmountVO
OrderBookLevelVO
OrderBookVO
OrderPreferenceVO
OrderStatusVO
OrderType The Type of an Order (e.g. Market, Limit, etc.). The string values contain the fully-qualified name of the corresponding class.
OrderVO Base Class for all Order Types
PositionVO
PreviouslyIndicatedOrderVO Base Class for all Order Types
PropertyHolderVO
QuoteRequestVO
QuoteVO
RoutingTargetVO
SecurityFamilyType
SecurityFamilyVO
SecurityVO
Side
SimpleOrderVO Base Class for all Order Types
SlicingOrderVO Base Class for all Order Types
Status
StopLimitOrderVO Base Class for all Order Types
StopOrderVO Base Class for all Order Types
StrategyVO
SymbolSecuritiesAccountsVO
TIF
TWAPOrderVO Base Class for all Order Types
TargetPositionOrderVO Base Class for all Order Types
TradingHoursVO
TrailingLimitOrderVO Base Class for all Order Types
TransactionType
TransactionVO
TransferAllPositionsRequest
TransferPositionRequest
VWAPOrderVO Base Class for all Order Types
WalletEventType
WalletEventVO
WithdrawStatusVO

XML

Default Namespace (schema)
type description
transactionVO
propertyHolderVO
orderVO Base Class for all Order Types
gitPropertiesSerializationWrapper
transferAllPositionsRequest
transferPositionRequest
currencyAmountVO
namedCurrencyAmountVO
walletEventVO
withdrawStatusVO
jsonNode
base