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/withdraw
  • /rest/account/depositAddress/{exchange}/{currency}
  • /rest/account/depositAddress/{exchange}/{currency}/{walletType}
  • 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.search
  • /rest/strategy
  • /rest/symbol-securities-and-accounts.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
MarketDataRestController
  • /rest/subscription/marketdata/subscribe
  • /rest/subscription/marketdata/supported-feed
  • /rest/subscription/marketdata/unsubscribe
  • PUT
  • GET
  • PUT
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/{id}
  • /rest/position/reduce/{id}
  • POST
  • DELETE
  • POST
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
BarVO
CurrencyAmountVO
Duration
ExchangeVO
ForexVO
MarketDataEventVO
MarketDataSubscriptionVO
NamedCurrencyAmountVO
OrderPreferenceVO
OrderStatusVO
OrderType
OrderVO
PositionVO
PropertyHolderVO
SecurityFamilyType
SecurityFamilyVO
SecurityVO
Side
Status
StrategyVO
SymbolSecuritiesAccountsVO
TIF
TradingHoursVO
TransactionType
TransactionVO
WithdrawStatusVO

XML

Default Namespace (schema)
type description
transactionVO
propertyHolderVO
orderVO
gitPropertiesSerializationWrapper
currencyAmountVO
namedCurrencyAmountVO
withdrawStatusVO
jsonNode
base