Resources

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

Try it out!

name path methods description
RestAccountController
  • /api/v1/accounts
  • /api/v1/accounts/properties
  • GET
  • PUT
Handles accounts requests.
RestBarController
  • /api/v1/current-bars/{security_id}
  • /api/v1/historical-bars/{security_id}
  • GET
  • GET
Handles bar requests.
RestCurrencyController
  • /api/v1/currencies
  • /api/v1/currencies/{currency_id}
  • /api/v1/currencies/commission_plans/active
  • /api/v1/currencies/{currency_id}/commission_plans
  • /api/v1/currencies/{currency_id}/limits
  • /api/v1/currencies/{currency_id}/commission_plans/active
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Handles currency requests.
RestCustomServicesController
  • /api/v1/custom-services
  • /api/v1/custom-services/{service_name}
  • /api/v1/custom-services/{service_name}/request
  • GET
  • GET
  • POST
Handles custom services requests.
RestL2DataController
  • /api/v1/books/{security_id}
  • /api/v1/trades/{security_id}
  • GET
  • GET
Handles l2data requests.
RestLinkedUsersController
  • /api/v1/linked
  • GET
RestLogController
  • /api/v1/log
  • POST
Handles log requests.
RestLoginController
  • /api/v1/login/attempt
  • /api/v1/login/confirm
  • /api/v1/login/keepalive
  • /api/v1/login/logout
  • POST
  • POST
  • POST
  • POST
RestPrimeBrokerController
  • /api/v1/prime-broker/accounts
  • GET
Handles prime broker requests.
RestSecurityController
  • /api/v1/securities
  • /api/v1/securities/statistics
  • /api/v1/securities/{security_id}
  • GET
  • GET
  • GET
Handles securities requests.
RestSecurityV2Controller
  • /api/v2/securities
  • /api/v2/securities/commissions
  • /api/v2/securities/{security_id}
  • /api/v2/securities/commission_plans/active
  • /api/v2/securities/{security_id}/bar_info
  • /api/v2/securities/{security_id}/commission_plans
  • /api/v2/securities/{security_id}/commissions
  • /api/v2/securities/{security_id}/session
  • /api/v2/securities/{security_id}/status
  • /api/v2/securities/{security_id}/commission_plans/active
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Handles securities requests.
RestSystemController
  • /api/v1/keepalive
  • /api/v1/time
  • /api/v1/global/settings
  • /api/v1/trader/health
  • POST
  • GET
  • GET
  • GET
Handles system requests, not specific for concrete user.
RestTradingController
  • /api/v1/deals
  • /api/v1/orders
  • /api/v1/orders/events
  • /api/v1/orders/history
  • /api/v1/orders/schema
  • /api/v1/trading/limits
  • /api/v1/orders/confirmation/description
  • /api/v1/orders/schema/details
  • /api/v1/orders/schema/linked
  • /api/v1/orders/schema/modify
  • /api/v1/orders/schema/pre-open
  • /api/v1/orders/schema/recurring
  • /api/v1/orders/schema/{security_id}
  • /api/v1/orders/schema/linked/{security_id}
  • /api/v1/orders/schema/modify/{security_id}
  • /api/v1/orders/schema/pre-open/modify
  • /api/v1/orders/schema/pre-open/{security_id}
  • /api/v1/orders/schema/recurring/{security_id}
  • /api/v1/orders/schema/pre-open/modify/{security_id}
  • GET PUT
  • DELETE GET POST PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Handles orders requests.
RestTradingSessionController
  • /api/v1/trading-sessions
  • GET
Handles trading session requests.
RestTransactionController
  • /api/v1/transactions/complete
  • /api/v1/transactions/history
  • /api/v1/transactions/incomplete
  • GET
  • GET
  • GET
Handles transaction requests.
RestUserController
  • /api/v1/user/id
  • /api/v1/user/settings
  • /api/v1/user/settings/custom
  • GET
  • GET PUT
  • GET PUT
Handles user settings requests.