Skip to main content
Version: Upcoming

StockLocateResponse

V8 Message Definiton

StockLocateResponse records are either locates or rejections of locate requests. These records are clientFirm specific and are not shared. SpiderRock execution engines are aware of the locate quantities in StockLocateResponse records. Also, these records are shared and depricated accross all SpiderRock production environments. VLanBridge:FieldRename:coreClientFirm:clientFirm BridgeFromV7

METADATA

AttributeValue
Topic1725-client-borrow
MLink TokenClientControl
ProductSRControl
accessTypeSELECT

Table Definition

FieldTypeKeyDefault ValueComment
ticker_atenum - AssetTypePRI'None'
ticker_tsenum - TickerSrcPRI'None'
ticker_tkVARCHAR(12)PRI''
coreClientFirmVARCHAR(16)PRI''
requestIDCHAR(19)PRI'0000-0000-0000-0000'ID used to make locate requests SR generated request ID
tradeDateDATE'1900-01-01'
locateFirmVARCHAR(6)''typically a clearing firm or 3rd party locate desk
locatePoolVARCHAR(16)''locate pool firm granting the locate
requestQuanINT0original request quantity for requestID
locateQuanINT0
locateStatusenum - LocateStatus'None'
requestOriginenum - RequestOrigin'None'
requestTimestampDATETIME(6)'1900-01-01 00:00:00.000000'
modifiedByVARCHAR(24)''user who last modified this record
modifiedInenum - SysEnvironment'None'
timestampDATETIME(6)'1900-01-01 00:00:00.000000'timestamp of last modification

PRIMARY KEY DEFINITION (Unique)

FieldSequence
ticker_tk1
ticker_at2
ticker_ts3
coreClientFirm4
requestID5

CREATE TABLE EXAMPLE QUERY

CREATE TABLE `SRControl`.`MsgStockLocateResponse` (
`ticker_at` ENUM('None','EQT','IDX','BND','CUR','COM','FUT','SYN','WAR','FLX','MUT','SPD','MM','MF','COIN','TOKEN','ANY') NOT NULL DEFAULT 'None',
`ticker_ts` ENUM('None','SR','NMS','CME','ICE','CFE','CBOT','NYMEX','COMEX','RUT','CIDX','ARCA','NYSE','OTC','NSDQ','MFQS','MIAX','DJI','CUSIP','ISIN','BXE','EUX','ANY','CXE','DXE','NXAM','NXBR','NXLS','NXML','NXOS','NXP','EUREX','CEDX','ICEFE') NOT NULL DEFAULT 'None',
`ticker_tk` VARCHAR(12) NOT NULL DEFAULT '',
`coreClientFirm` VARCHAR(16) NOT NULL DEFAULT '',
`requestID` CHAR(19) NOT NULL DEFAULT '0000-0000-0000-0000' COMMENT 'ID used to make locate requests (SR generated request ID)',
`tradeDate` DATE NOT NULL DEFAULT '1900-01-01',
`locateFirm` VARCHAR(6) NOT NULL DEFAULT '' COMMENT 'typically a clearing firm (or 3rd party locate desk)',
`locatePool` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'locate pool @ firm granting the locate',
`requestQuan` INT NOT NULL DEFAULT 0 COMMENT 'original request quantity for requestID',
`locateQuan` INT NOT NULL DEFAULT 0,
`locateStatus` ENUM('None','Queued','Submitted','SubmitError','Pending','FullOK','Partial','Rejected','CallDesk','Unknown') NOT NULL DEFAULT 'None',
`requestOrigin` ENUM('None','SRSE','MLink','Tool','AwaySystem') NOT NULL DEFAULT 'None',
`requestTimestamp` DATETIME(6) NOT NULL DEFAULT '1900-01-01 00:00:00.000000',
`modifiedBy` VARCHAR(24) NOT NULL DEFAULT '' COMMENT 'user who last modified this record',
`modifiedIn` ENUM('None','Neptune','Pluto','V7_Stable','V7_Latest','Saturn','Venus','Mars','SysTest','V7_Current') NOT NULL DEFAULT 'None',
`timestamp` DATETIME(6) NOT NULL DEFAULT '1900-01-01 00:00:00.000000' COMMENT 'timestamp of last modification',
CONSTRAINT nonnegative_requestID CHECK(ASCII(requestID) < 56),
PRIMARY KEY USING HASH (`ticker_tk`,`ticker_at`,`ticker_ts`,`coreClientFirm`,`requestID`)
) ENGINE=SRSE DEFAULT CHARSET=LATIN1 COMMENT='StockLocateResponse records are either locates or rejections of locate requests. These records are clientFirm specific and are not shared. SpiderRock execution engines are aware of the locate quantities in StockLocateResponse records. Also, these records are shared and depricated accross all SpiderRock production environments.\nVLanBridge:FieldRename:coreClientFirm:clientFirm\nBridgeFromV7';

SELECT TABLE EXAMPLE QUERY

SELECT
`ticker_at`,
`ticker_ts`,
`ticker_tk`,
`coreClientFirm`,
`requestID`,
`tradeDate`,
`locateFirm`,
`locatePool`,
`requestQuan`,
`locateQuan`,
`locateStatus`,
`requestOrigin`,
`requestTimestamp`,
`timestamp`
FROM `SRControl`.`MsgStockLocateResponse`
WHERE
/* Replace with a ENUM('None','EQT','IDX','BND','CUR','COM','FUT','SYN','WAR','FLX','MUT','SPD','MM','MF','COIN','TOKEN','ANY') */
`ticker_at` = 'None'
AND
/* Replace with a ENUM('None','SR','NMS','CME','ICE','CFE','CBOT','NYMEX','COMEX','RUT','CIDX','ARCA','NYSE','OTC','NSDQ','MFQS','MIAX','DJI','CUSIP','ISIN','BXE','EUX','ANY','CXE','DXE','NXAM','NXBR','NXLS','NXML','NXOS','NXP','EUREX','CEDX','ICEFE') */
`ticker_ts` = 'None'
AND
/* Replace with a VARCHAR(12) */
`ticker_tk` = 'Example_ticker_tk'
AND
/* Replace with a VARCHAR(16) */
`coreClientFirm` = 'Example_coreClientFirm'
AND
/* Replace with a CHAR(19) */
`requestID` = 'Example_requestID';

Doc Columns Query

SELECT * FROM SRControl.doccolumns WHERE TABLE_NAME='StockLocateResponse' ORDER BY ordinal_position ASC;