Trading

Provides order placement, modification, cancellation, order queries, and option exercise. All methods are asynchronous TradeClient methods returning Promise. Institutional accounts can inject their trading key with TradeClient.fromConfig(config, account, secretKey?). Source: openapi-typescript-sdk.

PageDescription
Contracts and OrdersContract queries, place/modify/cancel orders, order queries
Option ExerciseSubmit and query option exercise requests

API List

Contracts

APIDescription
Get ContractGet single contract
Get ContractsBatch get contracts
Get Quote ContractGet quote contract
Get Derivative ContractsOptions/warrants/CBBC contracts

Order Operations

APIDescription
Place OrderPlace an order (market, limit, stop, etc.)
Preview OrderPreview order without submitting

Modify and Cancel

APIDescription
Modify OrderModify price or quantity
Cancel OrderCancel an order

Order Queries

APIDescription
Get OrdersQuery order list
Get Active OrdersPending orders
Get Inactive OrdersCancelled orders
Get Filled OrdersFilled orders
Get OrderQuery single order
Get Order TransactionsTransaction details

Option Exercise

APIDescription
Exercise CheckCheck exercisability
Get Exercise PositionsExercisable positions
Submit ExerciseSubmit exercise request
Get Exercise RecordsExercise history
Cancel ExerciseCancel exercise request

Did this page help you?