Funds and Transfers

State-changing operations must prevent duplicate submission.

Get Segment Fund History

Operation

TradeApiService.SEGMENT_FUND_HISTORY = segment_fund_history. Uses server method segment_fund_history.

Request

TigerRequest<SegmentFundsResponse>

ModelValue: SegmentFundModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
FromSegmentSegmentTypefrom_segmentNone (omitted if not set)Optional
ToSegmentSegmentTypeto_segmentNone (omitted if not set)Optional
CurrencyCurrencycurrencyNone (omitted if not set)Optional
AmountDoubleamountNone (omitted if not set)Optional

Return

SegmentFundsResponse inherits TigerResponse; its data property is list of SegmentFundItem. Key SDK fields: Id: Int64, FromSegment: string, ToSegment: string, Currency: string, Amount: Double, Status: SegmentFundStatus, StatusDesc: string, Message: string.

Example

TigerRequest<SegmentFundsResponse> request = new()
{
    ApiMethodName = TradeApiService.SEGMENT_FUND_HISTORY,
    ModelValue = new SegmentFundModel { Account = tradeClient.GetDefaultAccount, FromSegment = SegmentType.SEC, ToSegment = SegmentType.FUT, Currency = Currency.USD, Amount = 1 }
};
SegmentFundsResponse? response = await tradeClient.ExecuteAsync(request);

Response type

List<SegmentFundItem>? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": [
    {
      "id": 10001,
      "fromSegment": "SEC",
      "toSegment": "FUT",
      "currency": "USD",
      "amount": 5000.0,
      "status": "SUCCESS",
      "statusDesc": "Success"
    }
  ]
}

Related APIs

See Requests, responses, and operations.

Get Available Segment Funds

Operation

TradeApiService.SEGMENT_FUND_AVAILABLE = segment_fund_available. Uses server method segment_fund_available.

Request

TigerRequest<SegmentFundAvailableResponse>

ModelValue: SegmentFundModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
FromSegmentSegmentTypefrom_segmentNone (omitted if not set)Optional
ToSegmentSegmentTypeto_segmentNone (omitted if not set)Optional
CurrencyCurrencycurrencyNone (omitted if not set)Optional
AmountDoubleamountNone (omitted if not set)Optional

Return

SegmentFundAvailableResponse inherits TigerResponse; its data property is list of SegmentFundAvailableItem. Key SDK fields: FromSegment: string, Currency: string, Amount: Double.

Example

TigerRequest<SegmentFundAvailableResponse> request = new()
{
    ApiMethodName = TradeApiService.SEGMENT_FUND_AVAILABLE,
    ModelValue = new SegmentFundModel { Account = tradeClient.GetDefaultAccount, FromSegment = SegmentType.SEC, ToSegment = SegmentType.FUT, Currency = Currency.USD, Amount = 1 }
};
SegmentFundAvailableResponse? response = await tradeClient.ExecuteAsync(request);

Response type

List<SegmentFundAvailableItem>? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": [
    {"segment": "SEC", "currency": "USD", "availableFunds": 50000.0},
    {"segment": "FUT", "currency": "USD", "availableFunds": 20000.0}
  ]
}

Related APIs

See Requests, responses, and operations.

Transfer Funds

Operation

TradeApiService.TRANSFER_FUND = transfer_fund. Uses server method transfer_fund.

Request

TigerRequest<DepositWithdrawResponse>

ModelValue: DepositWithdrawModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
SegTypeSegmentType (nullable)seg_typenullOptional
StartDatestringstart_datenullOptionalTimestamp or date format; maintain chronological order
EndDatestringend_datenullOptionalTimestamp or date format; maintain chronological order
CurrencystringcurrencynullOptional
Limitint (nullable)limitnullOptionalPositive integer
Pageint (nullable)pagenullOptionalPositive integer

Return

DepositWithdrawResponse inherits TigerResponse; its data property is list of DepositWithdrawItem. Key SDK fields: Id: string, RefId: string, Type: string, TypeDesc: string, Currency: string, Amount: double, BusinessDate: string, CompletedStatus: string.

Example

TigerRequest<DepositWithdrawResponse> request = new()
{
    ApiMethodName = TradeApiService.TRANSFER_FUND,
    ModelValue = new DepositWithdrawModel { Account = tradeClient.GetDefaultAccount, SegType = SegmentType.SEC, StartDate = "2026-01-01", EndDate = "2026-01-31", Currency = "USD" }
};
DepositWithdrawResponse? response = await tradeClient.ExecuteAsync(request);

Response type

List<DepositWithdrawItem>? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "id": 10002
  }
}

Related APIs

See Requests, responses, and operations.

Fund Details

Operation

TradeApiService.FUND_DETAILS = fund_details. Uses server method fund_details.

Request

TigerRequest<FundDetailsResponse>

ModelValue: FundDetailsModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
SegTypeslist of stringseg_typesnullOptional
FundTypestringfund_typenullOptional
CurrencystringcurrencynullOptional
StartDatestringstart_datenullOptionalTimestamp or date format; maintain chronological order
EndDatestringend_datenullOptionalTimestamp or date format; maintain chronological order
Startlong (nullable)startnullOptional
Limitlong (nullable)limitnullOptionalPositive integer

Return

FundDetailsResponse inherits TigerResponse; its data property is FundDetailsPageItem. Key SDK fields: Page: int, Limit: int, ItemCount: int, PageCount: int, Timestamp: long, Items: list of FundDetailsItem.

Example

TigerRequest<FundDetailsResponse> request = new()
{
    ApiMethodName = TradeApiService.FUND_DETAILS,
    ModelValue = new FundDetailsModel { Account = tradeClient.GetDefaultAccount, SegTypes = new List<string> { "SEC" }, Currency = "USD", StartDate = "2026-01-01", EndDate = "2026-01-31" }
};
FundDetailsResponse? response = await tradeClient.ExecuteAsync(request);

Response type

FundDetailsPageItem? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "netLiquidation": 125000.0,
    "totalCashValue": 50000.0,
    "settledCash": 48000.0,
    "buyingPower": 100000.0
  }
}

Related APIs

See Requests, responses, and operations.

Transfer Segment Fund

Operation

TradeApiService.TRANSFER_SEGMENT_FUND = transfer_segment_fund. Uses server method transfer_segment_fund.

Request

TigerRequest<SegmentFundResponse>

ModelValue: SegmentFundModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
FromSegmentSegmentTypefrom_segmentNone (omitted if not set)Optional
ToSegmentSegmentTypeto_segmentNone (omitted if not set)Optional
CurrencyCurrencycurrencyNone (omitted if not set)Optional
AmountDoubleamountNone (omitted if not set)Optional

Return

SegmentFundResponse inherits TigerResponse; its data property is SegmentFundItem. Key SDK fields: Id: Int64, FromSegment: string, ToSegment: string, Currency: string, Amount: Double, Status: SegmentFundStatus, StatusDesc: string, Message: string.

Example

TigerRequest<SegmentFundResponse> request = new()
{
    ApiMethodName = TradeApiService.TRANSFER_SEGMENT_FUND,
    ModelValue = new SegmentFundModel { Account = tradeClient.GetDefaultAccount, FromSegment = SegmentType.SEC, ToSegment = SegmentType.FUT, Currency = Currency.USD, Amount = 1 }
};
SegmentFundResponse? response = await tradeClient.ExecuteAsync(request);

Response type

SegmentFundItem? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "id": 10003
  }
}

Related APIs

See Requests, responses, and operations.

Cancel Segment Transfer

Operation

TradeApiService.CANCEL_SEGMENT_FUND = cancel_segment_fund. Uses server method cancel_segment_fund.

Request

TigerRequest<SegmentFundResponse>

ModelValue: SegmentFundModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
FromSegmentSegmentTypefrom_segmentNone (omitted if not set)Optional
ToSegmentSegmentTypeto_segmentNone (omitted if not set)Optional
CurrencyCurrencycurrencyNone (omitted if not set)Optional
AmountDoubleamountNone (omitted if not set)Optional

Return

SegmentFundResponse inherits TigerResponse; its data property is SegmentFundItem. Key SDK fields: Id: Int64, FromSegment: string, ToSegment: string, Currency: string, Amount: Double, Status: SegmentFundStatus, StatusDesc: string, Message: string.

Example

TigerRequest<SegmentFundResponse> request = new()
{
    ApiMethodName = TradeApiService.CANCEL_SEGMENT_FUND,
    ModelValue = new SegmentFundModel { Account = tradeClient.GetDefaultAccount, FromSegment = SegmentType.SEC, ToSegment = SegmentType.FUT, Currency = Currency.USD, Amount = 1 }
};
SegmentFundResponse? response = await tradeClient.ExecuteAsync(request);

Response type

SegmentFundItem? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "id": 10003,
    "status": "CANCELLED"
  }
}

Related APIs

See Requests, responses, and operations.

Place Forex Order

Operation

TradeApiService.PLACE_FOREX_ORDER = place_forex_order. Uses server method place_forex_order.

Request

TigerRequest<ForexTradeOrderResponse>

ModelValue: ForexTradeOrderModel.

Parameters

SDK propertyC# typeAPI fieldSDK defaultRequiredConstraints
LangLanguagelangNone (omitted if not set)no
Accountstring (nullable)accountnullAuto-filled if emptyTradeClient uses DefaultAccount when empty
SecretKeystringsecret_keynullno
SourceCurrencyCurrencysource_currencyNone (omitted if not set)Optional
SourceAmountDoublesource_amountNone (omitted if not set)Optional
TargetCurrencyCurrencytarget_currencyNone (omitted if not set)Optional
SegTypeSegmentTypeseg_typeNone (omitted if not set)Optional
TimeInForceTimeInForcetime_in_forceTimeInForce.DAYOptional

Return

ForexTradeOrderResponse inherits TigerResponse; its data property is TradeOrder. Key SDK fields: Symbol: string, Market: string, SecType: string, Currency: string, Expiry: string, Strike: string, Right: string, Multiplier: double.

Example

TigerRequest<ForexTradeOrderResponse> request = new()
{
    ApiMethodName = TradeApiService.PLACE_FOREX_ORDER,
    ModelValue = new ForexTradeOrderModel { Account = tradeClient.GetDefaultAccount, SourceCurrency = Currency.USD, SourceAmount = 1, TargetCurrency = Currency.HKD, SegType = SegmentType.SEC }
};
ForexTradeOrderResponse? response = await tradeClient.ExecuteAsync(request);

Response type

TradeOrder? data = response?.Data; // null when response or data is absent

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "id": 10004,
    "orderId": 890001
  }
}

Related APIs

See Requests, responses, and operations.


Did this page help you?