Trading APIs
Trading APIs focus on trading and managing contracts.
They include functionalities for buying, selling, and updating contracts, as well as managing copy trading activities. The APIs also allow users to retrieve important trading information such as profit tables, portfolio details, and contract durations.
These APIs are essential for users who actively trade on the platform and need to manage their trading accounts effectively.
| # | API Name | Description | Send | Subscribe | Scope |
|---|---|---|---|---|---|
| 1 | Buy Contract: Trade | Buys a contract. | ✔ | ✘ | Trade |
| 2 | Buy Contract for Multiple Accounts | Buys a contract for multiple accounts specified by the tokens parameter. Note that although this is an authorized call, the contract is not purchased for the authorized account. | ✔ | ✘ | Trade |
| 3 | Cancel a Contract | Cancels a contract using its contract ID. | ✔ | ✘ | Trade |
| 4 | Update Contract | Updates the conditions of a contract. | ✔ | ✘ | Trade |
| 5 | Update Contract History | Retrieves the update history of a contract. | ✔ | ✘ | Read |
| 6 | Copy Trading: Start | Starts copy trader bets. | ✔ | ✘ | Trade |
| 7 | Copy Trading: Stop | Stops copy trader bets. | ✔ | ✘ | Trade |
| 8 | Copy Trading: List | Retrieves a list of active copiers and/or traders involved in copy trading. | ✔ | ✘ | Admin |
| 9 | Copy Trading: Statistics | Retrieves performance, trading, risk, and copiers statistics for a trader. | ✔ | ✘ | NA |
| 10 | Sell Contract | Sells a contract as identified from a previous portfolio call. | ✔ | ✘ | Trade |
| 11 | Sell Contracts: Multiple Accounts | Sells contracts for multiple accounts simultaneously. Uses the shortcode response from buy_contract_for_multiple_accounts to identify the contract and authorization tokens to select which accounts to sell. | ✔ | ✘ | Trade |
| 12 | Sell Expired Contracts | Attempts to sell any expired contracts and returns the number of sold contracts. | ✔ | ✘ | Trade |
| 13 | Set Account Currency | Sets the account's default currency for trading and deposits. The account currency can only be set once and cannot be changed. | ✔ | ✘ | Admin |
| 14 | Trading Durations | Retrieves a list of available underlying contract types and trading duration boundaries. If the user is logged in, assets available only for their landing company will be returned. | ✔ | ✘ | NA |
| 15 | Profit Table | Retrieves a summary of the account's profit table based on the specified search criteria. | ✔ | ✘ | Read, Trading Information |
| 16 | Portfolio | Provides information about your current portfolio of outstanding options. | ✔ | ✘ | Read, Trading Information |
Updated 10 days ago