Data Blocks

Get and Search Options Orders

Get Option Order and Search Options Orders Data Blocks.

Schema
Example

Attributes	Data Type	Length	Description
`orderId`	String	32	Unique ID generated by the Stock Exhange
`orderNumber`	String	8	Internal identifier
`orderType`	String		Single, Basket, Block, Allocation
`accountType`	String		Cash, Margin, Short
`action`	String		BuyToOpen, BuyToClose, SellToOpen, SellToClose
`timeInForce`	String		Day, GoodTillCancel, GTXPre
`orderStatus`	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
`securityIdentifier`	Security Identifier
`openCloseIndicator`	String		Open, Close
`quantity`	Number		Amount
`filledQuantity`	String		Amount filled out of the original amount submitted
`solicited`	Boolean		True or False
`notHeld`	Boolean		True or False
`tradeInfo`	Trade Info Data Block
`averageTradePriceAmount`	Number
`orderWarnings`	String
`orderError`
`enteredDate`	String		Date-Time
`completedDate`	String		Date-Time

"data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "accountType": "Cash",
    "action": "BuyToOpen",
    "timeInForce": "Day",
    "orderStatus": "Verification",
    "securityIdentifier": {
      "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "securityNumber": "string",
      "sourceSystem": "string",
      "symbol": "string",
      "underlyingSymbol": "string",
      "isin": "string",
      "sedol": "string",
      "cusip": "string",
      "description": "string",
      "strikePrice": 0,
      "expirationDate": "2024-05-13T14:29:33.168Z",
      "displaySymbol": "string"
    },
    "openCloseIndicator": "Open",
    "quantity": 0,
    "filledQuantity": 0,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-13T14:29:33.168Z",
      "estimatedPrincipal": 0,
      "estimatedNetTotal": 0,
      "estimatedCommission": 0,
      "estimatedHandlingFee": 0,
      "estimatedPostageFee": 0,
      "estimatedSecFee": 0,
      "estimatedFirmFee": 0,
      "estimatedPrice": 0,
      "actualPrincipal": 0,
      "actualNetTotal": 0,
      "actualCommission": 0,
      "actualHandlingFee": 0,
      "actualPostageFee": 0,
      "actualSecFee": 0,
      "actualPrice": 0
    },
    "averageTradePriceAmount": 0,
    "orderWarnings": [
      "string"
    ],
    "orderError": {
      "code": "string",
      "target": "string",
      "message": "string",
      "details": [
        "string"
      ]
    },
    "enteredDate": "2024-05-13T14:29:33.168Z",
    "completedDate": "2024-05-13T14:29:33.168Z"
  }

Single Option Order

Single Option Order Data Block.

Schema
Example

Attributes	Data Type	Length	Description
`clientAccountIdentifier`	Account Identifier		Data Block
`stopPrice`	Number		Price assigned to trigger a Stop Order
`limitPrice`	Number		Price assigned to a Limit order
`noPostage`	Boolean		True or False
`allOrNone`	Boolean		True or False
`ttoRep`	String		Character field
`commissionType`	String		FlatRate, CentsPerShare, PercentOfDiscount, Zero, Unknown, CommissionSchedule
`commissionSchedule`	Integer		Character field
`commissionAmount`	Number		$ amount for commission
`calculatedCommission`	Number		Commission amount total
`confirmNote`	String		Character field
`orderId`	String	32	Unique ID generated by the Stock Exhange
`orderNumber`	String	8	Internal identifier
`orderType`	String		Single, Basket, Block, Allocation
`accountType`	String		Cash, Margin, Short
`action`	String		BuyToOpen, BuyToClose, SellToOpen, SellToClose
`timeInForce`	String		Day, GoodTillCancel, GTXPre
`orderStatus`	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
`securityIdentifier`	Security Identifier
`openCloseIndicator`	String		Open, Close
`quantity`	Number		Amount
`filledQuantity`	String		Amount filled out of the original amount submitted
`solicited`	Boolean		True or False
`notHeld`	Boolean		True or False
`tradeInfo`	Trade Info Data Block
`averageTradePriceAmount`	Number
`orderWarnings`	String
`orderError`
`enteredDate`	String		Date-Time
`completedDate`	String		Date-Time

  "data": {
    "clientAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    },
    "stopPrice": 0,
    "limitPrice": 0,
    "noPostage": false,
    "allOrNone": false,
    "ttoRep": false,
    "commissionType": "FlatRate",
    "commissionSchedule": 0,
    "commissionAmount": 0,
    "calculatedCommission": 0,
    "confirmNote": "string",
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "accountType": "Cash",
    "action": "BuyToOpen",
    "timeInForce": "Day",
    "orderStatus": "Verification",
    "securityIdentifier": {
      "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "securityNumber": "string",
      "sourceSystem": "string",
      "symbol": "string",
      "underlyingSymbol": "string",
      "isin": "string",
      "sedol": "string",
      "cusip": "string",
      "description": "string",
      "strikePrice": 0,
      "expirationDate": "2024-05-07T20:39:49.567Z",
      "displaySymbol": "string"
    },
    "openCloseIndicator": "Open",
    "quantity": 0,
    "filledQuantity": 0,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-07T20:39:49.567Z",
      "estimatedPrincipal": 0,
      "estimatedNetTotal": 0,
      "estimatedCommission": 0,
      "estimatedHandlingFee": 0,
      "estimatedPostageFee": 0,
      "estimatedSecFee": 0,
      "estimatedFirmFee": 0,
      "estimatedPrice": 0,
      "actualPrincipal": 0,
      "actualNetTotal": 0,
      "actualCommission": 0,
      "actualHandlingFee": 0,
      "actualPostageFee": 0,
      "actualSecFee": 0,
      "actualPrice": 0
    },
    "averageTradePriceAmount": 0,
    "orderWarnings": [
      "string"
    ],
    "orderError": {
      "code": "string",
      "target": "string",
      "message": "string",
      "details": [
        "string"
      ]
    },
    "enteredDate": "2024-05-07T20:39:49.567Z",
    "completedDate": "2024-05-07T20:39:49.567Z"
  }

Block Option Order

Block Option Order Data Block.

Schema
Example

Attributes	Data Type	Length	Description
`inventoryAccountIdentifier`	Account Identifier		Data Block
`allocationOptionOrders`
`stopPrice`	Number		Price assigned to trigger a Stop Order
`limitPrice`	Number		Price assigned to a Limit order
`orderId`	String	32	Unique ID generated by the Stock Exhange
`orderNumber`	String	8	Internal identifier
`orderType`	String		Single, Basket, Block, Allocation
`accountType`	String		Cash, Margin, Short
`action`	String		BuyToOpen, BuyToClose, SellToOpen, SellToClose
`timeInForce`	String		Day, GoodTillCancel, GTXPre
`orderStatus`	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
`securityIdentifier`	Security Identifier
`openCloseIndicator`	String		Open, Close
`quantity`	Number		Amount
`filledQuantity`	String		Amount filled out of the original amount submitted
`solicited`	Boolean		True or False
`notHeld`	Boolean		True or False
`tradeInfo`	Trade Info Data Block
`averageTradePriceAmount`	Number
`orderWarnings`	String
`orderError`
`enteredDate`	String		Date-Time
`completedDate`	String		Date-Time

"data": {
    "inventoryAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    },
    "allocationOptionOrders": 
      {
        "clientAccountIdentifier": {
          "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "subNo": "string",
          "branchNo": "string",
          "accountNumber": "string",
          "name": "string",
          "sourceSystem": "string",
          "subType": "Discretionary",
          "catType": "string"
        },
        "noPostage": false,
        "allOrNone": false,
        "ttoRep": "string",
        "commissionType": "FlatRate",
        "commissionSchedule": 0,
        "commissionAmount": 0,
        "calculatedCommission": 0,
        "confirmNote": "string",
        "blockOptionOrder": "string",
        "orderId": "00000000-0000-0000-0000-000000000000",
        "orderNumber": "00000000",
        "orderType": "Single",
        "accountType": "Cash",
        "action": "BuyToOpen",
        "timeInForce": "Day",
        "orderStatus": "Verification",
        "securityIdentifier": {
          "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "securityNumber": "string",
          "sourceSystem": "string",
          "symbol": "string",
          "underlyingSymbol": "string",
          "isin": "string",
          "sedol": "string",
          "cusip": "string",
          "description": "string",
          "strikePrice": 0,
          "expirationDate": "2024-05-09T17:26:23.857Z",
          "displaySymbol": "string"
        },
        "openCloseIndicator": "Open",
        "quantity": 0,
        "filledQuantity": 0,
        "solicited": false,
        "notHeld": false,
        "tradeInfo": {
          "buyingPower": 0,
          "estimatedSettlementDate": "2024-05-09T17:26:23.857Z",
          "estimatedPrincipal": 0,
          "estimatedNetTotal": 0,
          "estimatedCommission": 0,
          "estimatedHandlingFee": 0,
          "estimatedPostageFee": 0,
          "estimatedSecFee": 0,
          "estimatedFirmFee": 0,
          "estimatedPrice": 0,
          "actualPrincipal": 0,
          "actualNetTotal": 0,
          "actualCommission": 0,
          "actualHandlingFee": 0,
          "actualPostageFee": 0,
          "actualSecFee": 0,
          "actualPrice": 0
        },
        "averageTradePriceAmount": 0,
        "orderWarnings": [
          "string"
        ],
        "orderError": {
          "code": "string",
          "target": "string",
          "message": "string",
          "details": [
            "string"
          ]
        },
        "enteredDate": "2024-05-09T17:26:23.857Z",
        "completedDate": "2024-05-09T17:26:23.857Z"
      }}

Options Allocation Order

Options Allocation Order Data Block.

Schema
Example

Attributes	Data Type	Length	Description
`clientAccountIdentifier`	Account Identifier		Data Block
`noPostage`	Boolean		True or False
`allOrNone`	Boolean		True or False
`ttoRep`	String		Character field
`commissionType`	String		FlatRate, CentsPerShare, PercentOfDiscount, Zero, Unknown, CommissionSchedule
`commissionSchedule`	Integer		Character field
`commissionAmount`	Number		$ amount for commission
`calculatedCommission`	Number		Commission amount total
`confirmNote`	String		Character field
`blockOptionOrder`	Block Option Order		Data Block
`orderId`	String	32	Unique ID generated by the Stock Exhange
`orderNumber`	String	8	Internal identifier
`orderType`	String		Single, Basket, Block, Allocation
`accountType`	String		Cash, Margin, Short
`action`	String		BuyToOpen, BuyToClose, SellToOpen, SellToClose
`timeInForce`	String		Day, GoodTillCancel, GTXPre
`orderStatus`	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
`securityIdentifier`	Security Identifier
`openCloseIndicator`	String		Open, Close
`quantity`	Number		Amount
`filledQuantity`	String		Amount filled out of the original amount submitted
`solicited`	Boolean		True or False
`notHeld`	Boolean		True or False
`tradeInfo`	Trade Info Data Block
`averageTradePriceAmount`	Number
`orderWarnings`	String
`orderError`
`enteredDate`	String		Date-Time
`completedDate`	String		Date-Time

 "data": {
    "clientAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    },
    "noPostage": false,
    "allOrNone": false,
    "ttoRep": "string",
    "commissionType": "FlatRate",
    "commissionSchedule": 0,
    "commissionAmount": 0,
    "calculatedCommission": 0,
    "confirmNote": "string",
    "blockOptionOrder": {
      "inventoryAccountIdentifier": {
        "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "subNo": "string",
        "branchNo": "string",
        "accountNumber": "string",
        "name": "string",
        "sourceSystem": "string",
        "subType": "Discretionary",
        "catType": "string"
      },
      "allocationOptionOrders": [
        "string"
      ],
      "stopPrice": 0,
      "limitPrice": 0,
      "orderId": "00000000-0000-0000-0000-000000000000",
      "orderNumber": "00000000",
      "orderType": "Single",
      "accountType": "Cash",
      "action": "BuyToOpen",
      "timeInForce": "Day",
      "orderStatus": "Verification",
      "securityIdentifier": {
        "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "securityNumber": "string",
        "sourceSystem": "string",
        "symbol": "string",
        "underlyingSymbol": "string",
        "isin": "string",
        "sedol": "string",
        "cusip": "string",
        "description": "string",
        "strikePrice": 0,
        "expirationDate": "2024-05-13T14:13:27.274Z",
        "displaySymbol": "string"
      },
      "openCloseIndicator": "Open",
      "quantity": 0,
      "filledQuantity": 0,
      "solicited": false,
      "notHeld": false,
      "tradeInfo": {
        "buyingPower": 0,
        "estimatedSettlementDate": "2024-05-13T14:13:27.274Z",
        "estimatedPrincipal": 0,
        "estimatedNetTotal": 0,
        "estimatedCommission": 0,
        "estimatedHandlingFee": 0,
        "estimatedPostageFee": 0,
        "estimatedSecFee": 0,
        "estimatedFirmFee": 0,
        "estimatedPrice": 0,
        "actualPrincipal": 0,
        "actualNetTotal": 0,
        "actualCommission": 0,
        "actualHandlingFee": 0,
        "actualPostageFee": 0,
        "actualSecFee": 0,
        "actualPrice": 0
      },
      "averageTradePriceAmount": 0,
      "orderWarnings": [
        "string"
      ],
      "orderError": {
        "code": "string",
        "target": "string",
        "message": "string",
        "details": [
          "string"
        ]
      },
      "enteredDate": "2024-05-13T14:13:27.274Z",
      "completedDate": "2024-05-13T14:13:27.274Z"
    },
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "accountType": "Cash",
    "action": "BuyToOpen",
    "timeInForce": "Day",
    "orderStatus": "Verification",
    "securityIdentifier": {
      "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "securityNumber": "string",
      "sourceSystem": "string",
      "symbol": "string",
      "underlyingSymbol": "string",
      "isin": "string",
      "sedol": "string",
      "cusip": "string",
      "description": "string",
      "strikePrice": 0,
      "expirationDate": "2024-05-13T14:13:27.274Z",
      "displaySymbol": "string"
    },
    "openCloseIndicator": "Open",
    "quantity": 0,
    "filledQuantity": 0,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-13T14:13:27.274Z",
      "estimatedPrincipal": 0,
      "estimatedNetTotal": 0,
      "estimatedCommission": 0,
      "estimatedHandlingFee": 0,
      "estimatedPostageFee": 0,
      "estimatedSecFee": 0,
      "estimatedFirmFee": 0,
      "estimatedPrice": 0,
      "actualPrincipal": 0,
      "actualNetTotal": 0,
      "actualCommission": 0,
      "actualHandlingFee": 0,
      "actualPostageFee": 0,
      "actualSecFee": 0,
      "actualPrice": 0
    },
    "averageTradePriceAmount": 0,
    "orderWarnings": [
      "string"
    ],
    "orderError": {
      "code": "string",
      "target": "string",
      "message": "string",
      "details": [
        "string"
      ]
    },
    "enteredDate": "2024-05-13T14:13:27.274Z",
    "completedDate": "2024-05-13T14:13:27.274Z"
  }

Account Identifier

`clientAccountIdentifier` and `inventoryAccountIdentifier`

Schema
Example

Attributes	Data Type	Length	Description
`accountId`	String	32	Unique Account Identifier
`subNo`	String	3	Assigned Sub Number
`branchNo`	String	2	Assigned Branch Number
`accountNumber`	String	8	Account Identifier
`name`	String		Account Name
`sourceSystem`	String		Software Platform
`subType`	String		Discretionary, Advisory, AveragePrice
`catType`	String		CAT, FGN

 "data": {
    "clientAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    }}

Update Option Order

Update Option Order Data Block.

Schema
Example

Attributes	Data Type	Length	Description
`orderId`	String	32	Unique ID generated by the Stock Exhange
`orderNumber`	String	8	Internal identifier
`orderType`	String		Single, Basket, Block, Allocation
`accountType`	String		Cash, Margin, Short
`action`	String		BuyToOpen, BuyToClose, SellToOpen, SellToClose
`timeInForce`	String		Day, GoodTillCancel, GTXPre
`orderStatus`	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
`securityIdentifier`	Security Identifier
`openCloseIndicator`	String		Open, Close
`quantity`	Number		Amount
`filledQuantity`	String		Amount filled out of the original amount submitted
`solicited`	Boolean		True or False
`notHeld`	Boolean		True or False
`tradeInfo`	Trade Info Data Block
`averageTradePriceAmount`	Number
`orderWarnings`	String
`orderError`
`enteredDate`	String		Date-Time
`completedDate`	String		Date-Time

 "data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "accountType": "Cash",
    "action": "BuyToOpen",
    "timeInForce": "Day",
    "orderStatus": "Verification",
    "securityIdentifier": {
      "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "securityNumber": "string",
      "sourceSystem": "string",
      "symbol": "string",
      "underlyingSymbol": "string",
      "isin": "string",
      "sedol": "string",
      "cusip": "string",
      "description": "string",
      "strikePrice": 0,
      "expirationDate": "2024-05-13T14:18:25.234Z",
      "displaySymbol": "string"
    },
    "openCloseIndicator": "Open",
    "quantity": 0,
    "filledQuantity": 0,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-13T14:18:25.234Z",
      "estimatedPrincipal": 0,
      "estimatedNetTotal": 0,
      "estimatedCommission": 0,
      "estimatedHandlingFee": 0,
      "estimatedPostageFee": 0,
      "estimatedSecFee": 0,
      "estimatedFirmFee": 0,
      "estimatedPrice": 0,
      "actualPrincipal": 0,
      "actualNetTotal": 0,
      "actualCommission": 0,
      "actualHandlingFee": 0,
      "actualPostageFee": 0,
      "actualSecFee": 0,
      "actualPrice": 0
    },
    "averageTradePriceAmount": 0,
    "orderWarnings": [
      "string"
    ],
    "orderError": {
      "code": "string",
      "target": "string",
      "message": "string",
      "details": [
        "string"
      ]
    },
    "enteredDate": "2024-05-13T14:18:25.234Z",
    "completedDate": "2024-05-13T14:18:25.234Z"
  }

Security Identifier

`securityIdentifier`

Schema
Example

Attributes	Data Type	Description
`securityId`	String
`securityNumber`	String
`sourceSystem`	String	Software Platform
`symbol`	String
`underlyingSymbol`	String	Cusip, Isin, Sedol, Symbol
`isin`	String
`sedol`	String
`cusip`	String
`description`	String
`strikePrice`	Number	The price at which a Put or Call can be exercised
`expirationDate`	String	(date-time)
`displaySymbol`	String

"securityIdentifier": {
        "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "securityNumber": "string",
        "sourceSystem": "string",
        "symbol": "string",
        "underlyingSymbol": "string",
        "isin": "string",
        "sedol": "string",
        "cusip": "string",
        "description": "string",
        "strikePrice": 0,
        "expirationDate": "2024-05-10T14:29:17.393Z",
        "displaySymbol": "string"
}

Trade Info

`tradeInfo`

Schema
Example

Attributes	Data Type
`buyingPower`	Number
`estimatedSettlementDate`	String
`estimatedPrincipal`	Number
`estimatedNetTotal`	Number
`estimatedCommission`	Number
`estimatedHandlingFee`	Number
`estimatedPostageFree`	Number
`estimatedSecFee`	Number
`estimatedFirmFee`	Number
`estimatedPrice`	Number
`actualPrincipal`	Number
`actualNetTotal`	Number
`actualCommission`	Number
`actualHandlingFee`	Number
`actualPostageFee`	Number
`actualSecFee`	Number
`actualPrice`	Number

"tradeInfo": {
        "buyingPower": 0,
        "estimatedSettlementDate": "2024-05-10T16:00:17.526Z",
        "estimatedPrincipal": 0,
        "estimatedNetTotal": 0,
        "estimatedCommission": 0,
        "estimatedHandlingFee": 0,
        "estimatedPostageFee": 0,
        "estimatedSecFee": 0,
        "estimatedFirmFee": 0,
        "estimatedPrice": 0,
        "actualPrincipal": 0,
        "actualNetTotal": 0,
        "actualCommission": 0,
        "actualHandlingFee": 0,
        "actualPostageFee": 0,
        "actualSecFee": 0,
        "actualPrice": 0
}

Get and Search Options Orders​

Single Option Order​

Block Option Order​

Options Allocation Order​

Account Identifier​

clientAccountIdentifier and inventoryAccountIdentifier​

Update Option Order​

Security Identifier​

securityIdentifier​

Trade Info​

tradeInfo​

Get and Search Options Orders

Single Option Order

Block Option Order

Options Allocation Order

Account Identifier

`clientAccountIdentifier` and `inventoryAccountIdentifier`

Update Option Order

Security Identifier

`securityIdentifier`

Trade Info

`tradeInfo`