Overview

Bring the trading platform into your own applications and extensions.
View as Markdown

The Trade API is a REST-based web interface that lets you bring trading functionality into your own applications and extensions. Almost anything you can do in the trader application, you can also do through the API — place and modify orders, query account data, manage risk, and more.

For real-time market data (quotes, depth of market, charts), see the separate Market Data API.

Prefer a code-first walkthrough? The JavaScript example project covers these concepts with runnable samples.

What You Can Do

  • Place and modify orders. Any order type supported by the trader application can also be placed through the API. See the Orders endpoints in the API reference.
  • Query account data. Use the account/* operations to find an account by its ID, get a snapshot of its current cash balance, and read its trading permissions. See the Accounting endpoints.
  • Query contracts and products. Retrieve contracts, products, currencies, and maturities. See the ContractLibrary endpoints.
  • Manage risk. Set position limits and create, modify, and delete risk parameters. See the Risks endpoints.
  • Send alerts and use chat. Generate alerts that appear in the trader application, and open, query, post to, and close a chat context. See the Alerts and Chat endpoints.

Get Started

New to the API? Start with Getting Started for the steps to get access and make your first call, then see Authentication & Access for the token flow.