Data Blocks

Get and Search Equity

Get Equity Order and Search Equity Orders Data Blocks.

Schema

Attributes	Data Type	Length	Description
orderId	String	32	Unique ID generated by the Stock Exchange
orderNumber	String	8	Internal identifier
orderType	String		Single, Basket, Block, Allocation
action	String		Buy, Sell, BuyToCover, SellShort
timeInForce	String		Day, GoodTillCancel, FillorKill, GTXPre, NTE
orderStatus	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
securityIdentifier	Security Identifier
quantity	Number		Amount
filledQuantity	String		Amount filled out of the original amount submitted
stopPrice	Number		Price assigned to trigger a Stop Order
limitPrice	Number		Price assigned to a Limit order
onClose	Boolean		True or False
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

Example

"data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "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-10T15:47:41.506Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-10T15:47:41.506Z",
      "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-10T15:47:41.506Z",
    "completedDate": "2024-05-10T15:47:41.506Z"
}

Single Equity Order

Single Equity Order Data Block.

Schema

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
action	String		Buy, Sell, BuyToCover, SellShort
timeInForce	String		Day, GoodTillCancel, FillorKill, GTXPre, NTE
orderStatus	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
securityIdentifier	Security Identifier
quantity	Number		Amount
filledQuantity	String		Amount filled out of the original amount submitted
stopPrice	Number		Price assigned to trigger a Stop Order
limitPrice	Number		Price assigned to a Limit order
onClose	Boolean		True or False
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

Example

"data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "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-10T15:47:41.506Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-10T15:47:41.506Z",
      "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-10T15:47:41.506Z",
    "completedDate": "2024-05-10T15:47:41.506Z"
}

Block Equity Order

blockEquityOrder

Block Equity Order Data Block.

Schema

Attributes	Data Type	Length	Description
inventoryAccountIdentifier	Account Identifier Data Block		Data Block
allocationOptionOrders
orderId	String	32	Unique ID generated by the Stock Exhange
orderNumber	String	8	Internal identifier
orderType	String		Single, Basket, Block, Allocation
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
quantity	Number		Amount
filledQuantity	String		Amount filled out of the original amount submitted
stopPrice	Number		Price assigned to trigger a Stop Order
limitPrice	Number		Price assigned to a Limit order
onClose	Boolean		True or False
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

Example

"data": {
    "inventoryAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    },
    "allocationEquityOrders": [
      {
        "clientAccountIdentifier": {
          "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "subNo": "string",
          "branchNo": "string",
          "accountNumber": "string",
          "name": "string",
          "sourceSystem": "string",
          "subType": "Discretionary",
          "catType": "string"
        },
        "accountType": "Cash",
        "noPostage": false,
        "allOrNone": false,
        "ttoRep": "string",
        "commissionType": "FlatRate",
        "commissionSchedule": 0,
        "commissionAmount": 0,
        "calculatedCommission": 0,
        "confirmNote": "string",
        "blockEquityOrder": "string",
        "orderId": "00000000-0000-0000-0000-000000000000",
        "orderNumber": "00000000",
        "orderType": "Single",
        "action": "Buy",
        "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-10T19:24:03.807Z",
          "displaySymbol": "string"
        },
        "quantity": 0,
        "filledQuantity": 0,
        "stopPrice": 0,
        "limitPrice": 0,
        "onClose": false,
        "solicited": false,
        "notHeld": false,
        "tradeInfo": {
          "buyingPower": 0,
          "estimatedSettlementDate": "2024-05-10T19:24:03.807Z",
          "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-10T19:24:03.807Z",
        "completedDate": "2024-05-10T19:24:03.807Z"
      }
    ],
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "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-10T19:24:03.807Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-10T19:24:03.807Z",
      "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-10T19:24:03.807Z",
    "completedDate": "2024-05-10T19:24:03.807Z"
}

Equity Allocation Order

Equity Allocation Order Data Block.

Schema

Attributes	Data Type	Length	Description
clientAccountIdentifier	Account Identifier Data Block		Data Block
accountType	String		Cash, Margin, Short
allOrNone	Boolean		True or False
noPostage	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
blockEquityOrder	Block Equity Order Data Block		Data Block
orderId	String	32	Unique ID generated by the Stock Exhange
orderNumber	String	8	Internal identifier
orderType	String		Single, Basket, Block, Allocation
action	String		Buy, Sell, BuyToCover, SellShort
timeInForce	String		Day, GoodTillCancel, FillorKill, GTXPre, NTE
orderStatus	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
securityIdentifier	Security Identifier
quantity	Number		Amount
filledQuantity	String		Amount filled out of the original amount submitted
stopPrice	Number		Price assigned to trigger a Stop Order
limitPrice	Number		Price assigned to a Limit order
onClose	Boolean		True or False
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

Example

 "data": {
    "clientAccountIdentifier": {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subNo": "string",
      "branchNo": "string",
      "accountNumber": "string",
      "name": "string",
      "sourceSystem": "string",
      "subType": "Discretionary",
      "catType": "string"
    },
    "accountType": "Cash",
    "noPostage": false,
    "allOrNone": false,
    "ttoRep": "string",
    "commissionType": "FlatRate",
    "commissionSchedule": 0,
    "commissionAmount": 0,
    "calculatedCommission": 0,
    "confirmNote": "string",
    "blockEquityOrder": {
      "inventoryAccountIdentifier": {
        "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "subNo": "string",
        "branchNo": "string",
        "accountNumber": "string",
        "name": "string",
        "sourceSystem": "string",
        "subType": "Discretionary",
        "catType": "string"
      },
      "allocationEquityOrders": [
        "string"
      ],
      "orderId": "00000000-0000-0000-0000-000000000000",
      "orderNumber": "00000000",
      "orderType": "Single",
      "action": "Buy",
      "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-10T14:29:17.393Z",
        "displaySymbol": "string"
      },
      "quantity": 0,
      "filledQuantity": 0,
      "stopPrice": 0,
      "limitPrice": 0,
      "onClose": false,
      "solicited": false,
      "notHeld": false,
      "tradeInfo": {
        "buyingPower": 0,
        "estimatedSettlementDate": "2024-05-10T14:29:17.393Z",
        "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-10T14:29:17.393Z",
      "completedDate": "2024-05-10T14:29:17.393Z"
    },
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "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-10T14:29:17.393Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-10T14:29:17.393Z",
      "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-10T14:29:17.393Z",
    "completedDate": "2024-05-10T14:29:17.393Z"
  }

Account Identifier

clientAccountIdentifier and inventoryAccountIdentifier

Schema

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

Example

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

Update Equity Order

Update Equity Order Data Block.

Schema

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
action	String		Buy, Sell, BuyToCover, SellShort
timeInForce	String		Day, GoodTillCancel, FillorKill, GTXPre, NTE
orderStatus	String		Verification, Created, Open, Filled, Cancel, Canceled, Route, Routed, Rejected, Deleted, Expired, Unknown
securityIdentifier	Security Identifier
quantity	Number		Amount
filledQuantity	String		Amount filled out of the original amount submitted
stopPrice	Number		Price assigned to trigger a Stop Order
limitPrice	Number		Price assigned to a Limit order
onClose	Boolean		True or False
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

Example

"data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "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-10T19:29:23.792Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-10T19:29:23.792Z",
      "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"
      ]
}}

Security Identifier

securityIdentifier

Schema

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

Example

"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

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

Example

"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
}