TWS Invest / Divest

POST

/v1/api/fa/model/tws-invest-divest

POST

/v1/api/fa/model/tws-invest-divest

curl -X POST https://localhost:5000/v1/api/fa/model/tws-invest-divest \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "reqID": 398889,
  "modelList": [
    {}
  ]
}'

{
  "allocations": [
    {
      "account": "DU12345",
      "batchNumber": 4,
      "cashQty": "15.73",
      "closePosition": false,
      "conid": 270639,
      "isCashQty": false,
      "model": "MODEL-API-DEMO",
      "price": "103.256",
      "quantity": "0.1523",
      "relatedRequestAccount": "DU12345",
      "relatedRequestID": "21449",
      "secType": "STK"
    },
    {
      "account": "DU12345",
      "batchNumber": 4,
      "cashQty": "206.92",
      "closePosition": false,
      "conid": 76792991,
      "isCashQty": false,
      "model": "MODEL-API-DEMO",
      "price": "339.489",
      "quantity": "0.6095",
      "relatedRequestAccount": "DU12345",
      "relatedRequestID": "21449",
      "secType": "STK"
    }
  ],
  "cashTransfers": [
    {
      "account": "DU12345",
      "amt": "3000",
      "batchNumber": 1,
      "ccy": "USD",
      "destinationModel": "MODEL-API-DEMO",
      "sourceModel": "Core"
    }
  ],
  "errors": [
    "None"
  ],
  "positionTransfers": [],
  "reqID": 398889,
  "subscriptionStatus": 1,
  "transfersInstructionId": 2
}

Submit TWS-style invest or divest instructions across one or more destination models for a set of accounts. Positive amtToInvest values invest cash into the target model; negative values divest. The response returns the resulting allocation plan and cash transfers between the source cash pool and each destination model.

The set of accounts to invest can be specified in one of three mutually exclusive ways:

account - a single U-account identifier (e.g. "account": "DU12349").
accountList - an explicit list of U-account identifiers (e.g. "accountList": ["DU12349", "DU12350", "DU12351"]).
group - the name of an FA pre-trade allocation group (e.g. "group": "Group1"), or "All" to include every account under the advisor. When accountList or group is used, each amtToInvest value is divided equally across the resolved accounts.

Feature comparison vs. /fa/model/invest-divest:

tws-invest-divest supports models denominated in multiple currencies; invest-divest supports only single-currency models.
tws-invest-divest accepts multiple destination models per request (via modelList); invest-divest targets a single model per request.
invest-divest allows a different investment amount per account because each account is listed individually with its own amtToInvest. FA pre-trade allocation groups are not supported by invest-divest.
When tws-invest-divest uses group or accountList, the single amtToInvest is split equally across all resolved accounts.

Submit TWS-style invest or divest instructions across **one or more destination models** for a set of accounts. Positive `amtToInvest` values invest cash into the target model; negative values divest. The response returns the resulting allocation plan and cash transfers between the source cash pool and each destination model. The set of accounts to invest can be specified in one of three **mutually exclusive** ways: * `account` - a single U-account identifier (e.g. `"account": "DU12349"`). * `accountList` - an explicit list of U-account identifiers (e.g. `"accountList": ["DU12349", "DU12350", "DU12351"]`). * `group` - the name of an FA pre-trade allocation group (e.g. `"group": "Group1"`), or `"All"` to include every account under the advisor. When `accountList` or `group` is used, each `amtToInvest` value is **divided equally** across the resolved accounts. Feature comparison vs. `/fa/model/invest-divest`: * `tws-invest-divest` supports models denominated in **multiple currencies**; `invest-divest` supports only single-currency models. * `tws-invest-divest` accepts **multiple destination models** per request (via `modelList`); `invest-divest` targets a single model per request. * `invest-divest` allows a **different investment amount per account** because each account is listed individually with its own `amtToInvest`. FA pre-trade allocation groups are not supported by `invest-divest`. * When `tws-invest-divest` uses `group` or `accountList`, the single `amtToInvest` is split **equally** across all resolved accounts.

Authentication

AuthorizationBearer

SSO bearer token.

Request

This endpoint expects an object.

reqIDlongRequired

Request identifier to uniquely track a request.

modelListlist of objectsRequired

List of invest/divest instructions, one per model destination.

accountstringOptional

Single U-account identifier submitting the invest/divest instructions. Mutually exclusive with accountList and group.

accountListlist of stringsOptional

Explicit list of U-account identifiers to invest/divest. Each amtToInvest value in modelList is divided equally across the listed accounts. Mutually exclusive with account and group.

groupstringOptional

Name of an FA pre-trade allocation group whose member accounts should receive the invest/divest instructions. Use "All" to target every account under the advisor. When supplied, each amtToInvest value in modelList is divided equally across the resolved group members. Mutually exclusive with account and accountList.

Name of an FA pre-trade allocation group whose member accounts should receive the invest/divest instructions. Use `"All"` to target every account under the advisor. When supplied, each `amtToInvest` value in `modelList` is divided equally across the resolved group members. Mutually exclusive with `account` and `accountList`.

subscriptionKeystringOptional

Subscription key. Send an empty string on the initial request.

Response

Successfully computed the invest/divest allocation plan.

allocationslist of objectsOptional

Per-instrument allocation instructions produced by the invest/divest planner.

cashTransferslist of objectsOptional

Cash movements between source and destination models required to fund the plan.

errorslist of strings or nullOptional

Errors produced by the planner. null when the plan is successful.

positionTransferslist of objectsOptional

Position transfers scheduled between the source and destination models.

reqIDlongOptional

Request identifier echoed from the originating request.

subscriptionStatuslongOptional

Describes if the model is in polling mode.

transfersInstructionIdlongOptional

Identifier that groups the resulting transfers; supply to downstream submit endpoints.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error