Option Exercise

Example context

import { createClientConfig, TradeClient } from '@tigeropenapi/tigeropen';

const config = createClientConfig();
const tradeClient = TradeClient.fromConfig(config, config.account, config.secretKey);

`checkOptionExercise`

Signature

async checkOptionExercise(req: OptionExerciseCheckRequest): Promise<OptionExerciseCheckResult | undefined>

Purpose

Performs check option exercise.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionExerciseCheckRequest`	Yes	None	No client-side validation is declared.
`req.account`	`string \| undefined`	No	TradeClient account when empty (client)	No client-side validation is declared.
`req.secretKey`	`string \| undefined`	No	None	Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default.
`req.contractId`	`number`	Yes	None	Option contract ID
`req.type`	`string`	Yes	None	Exercise \| Expire
`req.quantity`	`number \| undefined`	No	None	No client-side validation is declared.
`req.executingDate`	`string \| undefined`	No	None	yyyy-MM-dd; Recommended for Exercise
`req.isForce`	`boolean \| undefined`	No	None	Recommended for Exercise
`req.itmRate`	`number \| undefined`	No	None	0–10; Used only for Expire
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<OptionExerciseCheckResult | undefined>

Field	Type	Description
availableQuantity	number	Available quantity
position	number	Position quantity
stkPosition	number	Stock position
stkPositionChange	number	Stock position change
stkPositionBefore	number	Stock position before exercise
stkPositionAfter	number	Stock position after exercise
symbol	string	Symbol code

Type-checked example

const result = await tradeClient.checkOptionExercise({ contractId: 123, type: 'Exercise' });
console.log(result);

Response example

{
  "availableQuantity": 0,
  "position": 0,
  "stkPosition": 0,
  "stkPositionChange": 0,
  "stkPositionBefore": 0,
  "stkPositionAfter": 0,
  "symbol": "string"
}

`getOptionExercisePositions`

Signature

async getOptionExercisePositions(req: OptionExercisePositionRequest): Promise<OptionExercisePositionPageResult | undefined>

Purpose

Gets option exercise positions.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionExercisePositionRequest`	Yes	None	No client-side validation is declared.
`req.account`	`string \| undefined`	No	TradeClient account when empty (client)	No client-side validation is declared.
`req.secretKey`	`string \| undefined`	No	None	Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default.
`req.type`	`string`	Yes	None	Exercise \| Expire
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<OptionExercisePositionPageResult | undefined>

Field	Type	Description
pageNum	number	Page number
pageSize	number	Page size
itemCount	number	Item count
pageCount	number	Total pages
items	OptionExercisePosition[]	Data items array

Type-checked example

const result = await tradeClient.getOptionExercisePositions({ type: 'Exercise' });
console.log(result);

Response example

{
  "pageNum": 0,
  "pageSize": 0,
  "itemCount": 0,
  "pageCount": 0,
  "items": [
    {
      "contractId": 0,
      "symbol": "string",
      "stkSymbol": "string",
      "expireDate": "string",
      "strike": "string",
      "callPut": "string",
      "market": "string",
      "accountId": 0,
      "position": 0,
      "availableQuantity": 0
    }
  ]
}

`submitOptionExercise`

Signature

async submitOptionExercise(req: OptionExerciseSubmitRequest): Promise<boolean>

Purpose

Performs submit option exercise.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionExerciseSubmitRequest`	Yes	None	No client-side validation is declared.
`req.account`	`string \| undefined`	No	TradeClient account when empty (client)	No client-side validation is declared.
`req.secretKey`	`string \| undefined`	No	None	Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default.
`req.contractId`	`number`	Yes	None	No client-side validation is declared.
`req.type`	`string`	Yes	None	Exercise \| Expire
`req.quantity`	`number`	Yes	None	No client-side validation is declared.
`req.executingDate`	`string \| undefined`	No	None	Required for Exercise; yyyy-MM-dd
`req.isForce`	`boolean \| undefined`	No	None	Required for Exercise
`req.itmRate`	`number \| undefined`	No	None	0–10; Used only for Expire
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<boolean>

Type-checked example

const result = await tradeClient.submitOptionExercise({ contractId: 123, type: 'Exercise', quantity: 1 });
console.log(result);

Response example

true

`getOptionExerciseRecords`

Signature

async getOptionExerciseRecords(req: OptionExerciseRecordsRequest): Promise<OptionExerciseRecordPageResult | undefined>

Purpose

Gets option exercise records.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionExerciseRecordsRequest`	Yes	None	No client-side validation is declared.
`req.account`	`string \| undefined`	No	TradeClient account when empty (client)	No client-side validation is declared.
`req.secretKey`	`string \| undefined`	No	None	Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default.
`req.page`	`number \| undefined`	No	None	Starts at 1; server default is 1
`req.size`	`number \| undefined`	No	None	1–100; server default is 20
`req.status`	`string \| undefined`	No	None	New \| Cancel \| Success \| Fail
`req.type`	`string \| undefined`	No	None	Exercise \| Expire
`req.symbol`	`string \| undefined`	No	None	No client-side validation is declared.
`req.orderBy`	`string \| undefined`	No	None	symbol \| expire_date \| strike \| is_call
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<OptionExerciseRecordPageResult | undefined>

Field	Type	Description
pageNum	number	Page number
pageSize	number	Page size
itemCount	number	Item count
pageCount	number	Total pages
items	OptionExerciseRecord[]	Data items array

Type-checked example

const result = await tradeClient.getOptionExerciseRecords({ page: 1, size: 20, type: 'Exercise' });
console.log(result);

Response example

{
  "pageNum": 0,
  "pageSize": 0,
  "itemCount": 0,
  "pageCount": 0,
  "items": [
    {
      "id": 0,
      "contractId": 0,
      "symbol": "string",
      "stkSymbol": "string",
      "expireDate": "string",
      "strike": "string",
      "callPut": "string",
      "type": "string",
      "requestQuantity": 0,
      "quantity": 0,
      "status": "string",
      "executingDate": "string",
      "itmRate": 0,
      "isForce": true,
      "reason": "string",
      "accountId": 0
    }
  ]
}

`cancelOptionExercise`

Signature

async cancelOptionExercise(req: OptionExerciseCancelRequest): Promise<boolean>

Purpose

Cancels option exercise.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionExerciseCancelRequest`	Yes	None	No client-side validation is declared.
`req.account`	`string \| undefined`	No	TradeClient account when empty (client)	No client-side validation is declared.
`req.secretKey`	`string \| undefined`	No	None	Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default.
`req.id`	`number`	Yes	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<boolean>

Type-checked example

const result = await tradeClient.cancelOptionExercise({ id: 1 });
console.log(result);

Response example

true