Option Exercise

Option Exercise Check

Purpose

Calculates the option and underlying-position impact of an exercise or expiry request. The client fills an empty account field from the client default.

Signature

func (c *TradeClient) OptionExerciseCheck(req model.OptionExerciseCheckRequest) (*model.OptionExerciseCheckResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OptionExerciseCheckRequest

SDK field	Type	Required	Serialization	SDK default and constraints
`Type`	`string`	Yes	Omitted if empty	`Exercise` or `Expire`
`Lang`	`string`	No	Omitted if empty	Allowed values: zh_CN, zh_TW, en_US
`Account`	`string`	No	Uses the client default account when empty	Trading account; the client default is used when empty
`SecretKey`	`string`	No	Uses client configuration when available	Institutional-account secret key; populated from client configuration when available
`ContractId`	`int64`	Yes	Omitted when zero	Contract ID
`Quantity`	`float64`	Yes	Omitted when zero	Exercise or expiry quantity
`ExecutingDate`	`string`	No	Omitted when empty	Execution date in yyyy-MM-dd format
`IsForce`	`*bool`	No	Omitted when nil	Whether to force execution
`ItmRate`	`*int`	No	Omitted when nil	In-the-money rate from 0 to 10

Returns

(*model.OptionExerciseCheckResult, error). Key fields from model.OptionExerciseCheckResult:

Field	Type	Description
AvailableQuantity	float64	Available quantity for exercise
Position	float64	Option position quantity
StkPosition	float64	Underlying stock position
StkPositionChange	float64	Stock position change
StkPositionBefore	float64	Stock position before exercise
StkPositionAfter	float64	Stock position after exercise
Symbol	string	Symbol code

Invocation example

result, err := tc.OptionExerciseCheck(model.OptionExerciseCheckRequest{
	Account: "U123456",
	ContractId: 123456,
	Type: "Exercise",
	Quantity: 1,
	ExecutingDate: "2025-06-20",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "availableQuantity": 5,
  "position": 10,
  "stkPosition": 0,
  "stkPositionChange": 100,
  "stkPositionBefore": 0,
  "stkPositionAfter": 100,
  "symbol": "AAPL"
}

Rate limit

The base rate limit is 60 requests/min.

Option Exercise Positions

Purpose

Returns positions eligible for exercise or expiry handling. The client fills an empty account field from the client default.

Signature

func (c *TradeClient) OptionExercisePositions(req model.OptionExercisePositionRequest) (*model.OptionExercisePositionPageResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OptionExercisePositionRequest

SDK field	Type	Required	Serialization	SDK default and constraints
`Type`	`string`	Yes	Omitted if empty	`Exercise` or `Expire`
`Lang`	`string`	No	Omitted if empty	Allowed values: zh_CN, zh_TW, en_US
`Account`	`string`	No	Uses the client default account when empty	Trading account; the client default is used when empty
`SecretKey`	`string`	No	Uses client configuration when available	Institutional-account secret key; populated from client configuration when available

Returns

(*model.OptionExercisePositionPageResult, error). Key fields from model.OptionExercisePositionPageResult:

Field	Type	Description
PageNum	int	Current page number
PageSize	int	Page size
ItemCount	int	Total item count
PageCount	int	Total page count
Items	[]OptionExercisePosition	Exercisable position list

`OptionExercisePosition` field	Type	Description
ContractId	int64	Contract ID
Symbol	string	Option symbol
StkSymbol	string	Underlying stock symbol
ExpireDate	string	Expiry date
Strike	string	Strike price
CallPut	string	Call or put side
Market	string	Market
AccountId	int64	Numeric account ID
Position	float64	Position quantity
AvailableQuantity	float64	Available quantity

Invocation example

result, err := tc.OptionExercisePositions(model.OptionExercisePositionRequest{
	Account: "U123456",
	Type: "Exercise",
	Lang: "en_US",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "pageNum": 1,
  "pageSize": 20,
  "itemCount": 1,
  "pageCount": 1,
  "items": [
    {
      "contractId": 55678,
      "symbol": "AAPL",
      "stkSymbol": "AAPL",
      "expireDate": "20250815",
      "strike": "300",
      "callPut": "CALL",
      "market": "US",
      "accountId": 123,
      "position": 10,
      "availableQuantity": 10
    }
  ]
}

Rate limit

The base rate limit is 60 requests/min.

Option Exercise Submit

Purpose

Submits an option exercise or expiry-handling request. The client fills an empty account field from the client default.

Signature

func (c *TradeClient) OptionExerciseSubmit(req model.OptionExerciseSubmitRequest) (bool, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OptionExerciseSubmitRequest

SDK field	Type	Required	Serialization	SDK default and constraints
`Type`	`string`	Yes	Omitted if empty	`Exercise` or `Expire`
`ExecutingDate`	`string`	Conditional	Omitted if empty	None; Type=Exercise requires this field; yyyy-MM-dd
`IsForce`	`*bool`	Conditional	Omitted if empty	None; Type=Exercise requires this field
`ItmRate`	`*int`	Conditional	Omitted if empty	Required for Expire; range 0–10
`Lang`	`string`	No	Omitted if empty	Allowed values: zh_CN, zh_TW, en_US
`Account`	`string`	No	Uses the client default account when empty	Trading account; the client default is used when empty
`SecretKey`	`string`	No	Uses client configuration when available	Institutional-account secret key; populated from client configuration when available
`ContractId`	`int64`	Yes	Omitted when zero	Contract ID
`Quantity`	`float64`	Yes	Omitted when zero	Exercise or expiry quantity

Returns

(bool, error); true means the server accepted the operation.

Invocation example

isForce := false
result, err := tc.OptionExerciseSubmit(model.OptionExerciseSubmitRequest{
	Account: "U123456",
	ContractId: 123456,
	Type: "Exercise",
	Quantity: 1,
	ExecutingDate: "2025-06-20",
	IsForce: &isForce,
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

true

Rate limit

The base rate limit is 60 requests/min.

Option Exercise Records

Purpose

Returns a filtered, paginated list of option-exercise requests. The client fills an empty account field from the client default.

Signature

func (c *TradeClient) OptionExerciseRecords(req model.OptionExercisePageRequest) (*model.OptionExerciseRecordPageResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OptionExercisePageRequest

SDK field	Type	Required	Serialization	SDK default and constraints
`Page`	`int`	No	Omitted if empty	None; Starts at 1; server default 1
`Size`	`int`	No	Omitted if empty	None; 1-100; server default 20
`Status`	`string`	No	Omitted if empty	None; New
`Type`	`string`	No	Omitted if empty	`Exercise` or `Expire`
`OrderBy`	`string`	No	Omitted if empty	None; symbol
`Lang`	`string`	No	Omitted if empty	Allowed values: zh_CN, zh_TW, en_US
`Account`	`string`	No	Uses the client default account when empty	Trading account; the client default is used when empty
`SecretKey`	`string`	No	Uses client configuration when available	Institutional-account secret key; populated from client configuration when available
`Symbol`	`string`	No	Omitted when empty	Symbol

Returns

(*model.OptionExerciseRecordPageResult, error). Key fields from model.OptionExerciseRecordPageResult:

Field	Type	Description
PageNum	int	Current page number
PageSize	int	Page size
ItemCount	int	Total item count
PageCount	int	Total page count
Items	[]OptionExerciseRecord	Exercise record list

`OptionExerciseRecord` field	Type	Description
Id	int64	Record ID
ContractId	int64	Contract ID
Symbol	string	Option symbol
StkSymbol	string	Underlying stock symbol
ExpireDate	string	Expiry date
Strike	string	Strike price
CallPut	string	Call or put side
Type	string	Request type
RequestQuantity	float64	Requested quantity
Quantity	float64	Executed quantity
Status	string	Status
ExecutingDate	string	Execution date
ItmRate	int	In-the-money rate
IsForce	bool	Whether execution is forced
Reason	string	Reason
AccountId	int64	Numeric account ID

Invocation example

result, err := tc.OptionExerciseRecords(model.OptionExercisePageRequest{
	Account: "U123456",
	Page: 1,
	Size: 20,
	Type: "Exercise",
	Symbol: "AAPL",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "pageNum": 1,
  "pageSize": 20,
  "itemCount": 1,
  "pageCount": 1,
  "items": [
    {
      "id": 998877,
      "contractId": 55678,
      "symbol": "AAPL",
      "stkSymbol": "AAPL",
      "expireDate": "20250815",
      "strike": "300",
      "callPut": "CALL",
      "type": "Exercise",
      "requestQuantity": 5,
      "quantity": 5,
      "status": "New",
      "executingDate": "2025-08-15",
      "itmRate": 0,
      "isForce": false,
      "reason": "",
      "accountId": 123
    }
  ]
}

Rate limit

The base rate limit is 60 requests/min.

Option Exercise Cancel

Purpose

Cancels a pending option-exercise request by record ID. The client fills an empty account field from the client default.

Signature

func (c *TradeClient) OptionExerciseCancel(req model.OptionExerciseCancelRequest) (bool, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OptionExerciseCancelRequest

SDK field	Type	Required	Serialization	SDK default and constraints
`Lang`	`string`	No	Omitted if empty	Allowed values: zh_CN, zh_TW, en_US
`Account`	`string`	No	Uses the client default account when empty	Trading account; the client default is used when empty
`SecretKey`	`string`	No	Uses client configuration when available	Institutional-account secret key; populated from client configuration when available
`Id`	`int64`	Yes	Omitted when zero	Exercise-request record ID

Returns

(bool, error); true means the server accepted the operation.

Invocation example

result, err := tc.OptionExerciseCancel(model.OptionExerciseCancelRequest{
	Account: "U123456",
	Id: 789012,
	Lang: "en_US",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

true

Rate limit

The base rate limit is 60 requests/min.