Skip to main content
Version: 8.6.10.4

Schema: LocateFragment (ID: 1741)

One fragment per locate line: born from a StockLocateResponse (fragSource Vendor, fragID = requestID; the gateway's rolling requestID-0 response maps to one updating fragment) or an AwayStockLocate statement (fragSource Notice, fragID = noticeID). Published ONLY by execution engines, atomically with AvailableStockLocates under the pool lock. Short-sale fills allocate FIFO by grantTimestamp within (pool, lane); a release reduces locateQuan to the consumed floor, never below, and never deletes the fragment.

METADATA​

AttributeValue
Topic1725-client-borrow
MLink TokenClientControl
MLink EndpointMLink-Live
SRSE ProductSRControl

Note: The symbol = next to a field number indicates that it is a primary key.

BODY​

#FieldTypeDefault ValueComment
10=tickerTickerKey
11=coreClientFirmstring(16)
12=locateFirmstring(6)
13=locatePoolstring(16)locate pool @ firm granting the locate
14=laneenum : ProdTestpropagated from the input command/response
15=tradeDateDateKey
16=fragSourceenum : LocateFragSource
17=fragIDlongrequestID (Vendor) or noticeID (Notice); 0 = the rolling line
100locateQuanintgranted/stated quantity on this line (post consumed-floor reconcile)
103locateQuanUsedintshares sold short allocated to this line (FIFO)
106availableLocateQuanintlocateQuan - locateQuanUsed
109locateStatusenum : LocateStatus
112grantTimestampDateTimeFIFO position; fixed at fragment creation
115engineNamestring(32)SR server code
118timestampDateTime
121statedQuanintquantity the source last stated; locateQuan = max(statedQuan, min(locateQuanUsed, stmtFloor))
124stmtFloorintconsumption a downward statement could not undo
127stmtTimestampDateTimesource record timestamp; an older statement never overrides a newer one
130legacyStmtenum : YesNoYes = stated via ClientStockLocate (1731); loses ties to AwayStockLocate
133stmtRevisionintbumped by every accepted statement or delete; recovery restores only a higher revision

Get Schema API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'LocateFragment'

# Request Parameters for Get Schema Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getschema',
    "msgType": MSG_TYPE, 
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Msg API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'LocateFragment'

# Replace with your pkey value for getting the specific message desired
PKEY = 'ReplaceThisValueForTheQueryToWork'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned. 
VIEW = 'locateQuan|locateQuanUsed|availableLocateQuan|locateStatus|grantTimestamp|engineName|timestamp|statedQuan|stmtFloor|stmtTimestamp|legacyStmt|stmtRevision'

# Replace with your desired where clause.
# a string in the form "field1:eq:valuse" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'coreClientFirm:eq:ExampleString'

# Request Parameters for getmsg Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getmsg',
    "pkey": PKEY,
    "msgType": MSG_TYPE,
    # Optional Parameters
    "view": VIEW, 
    "where": WHERE
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Msgs API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'LocateFragment'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'locateQuan|locateQuanUsed|availableLocateQuan|locateStatus|grantTimestamp|engineName|timestamp|statedQuan|stmtFloor|stmtTimestamp|legacyStmt|stmtRevision'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'coreClientFirm:eq:ExampleString'

# Replace with your desired limit of how many messages you receive. The default limit is 500
LIMIT = 500

# Order clause eg. "(field1:DESC | field1:ASC | field2:DESC:ABS | field2:ASC:ABS" (default is unordered; default is faster)
ORDER = 'locateQuan:ASC'

# Request Parameters for getmsgs Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getmsgs',
    "msgType": MSG_TYPE,
    # Optional Parameters
    "view": VIEW, 
    "where": WHERE,
    "limit": LIMIT,
    "order": ORDER
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Aggregate API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'LocateFragment'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'locateQuan|locateQuanUsed|availableLocateQuan|locateStatus|grantTimestamp|engineName|timestamp|statedQuan|stmtFloor|stmtTimestamp|legacyStmt|stmtRevision'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'locateStatus|legacyStmt'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'coreClientFirm:eq:ExampleString'

# Request Parameters for getaggregate Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getaggregate',
    "msgType": MSG_TYPE,
    "measure": MEASURE,
    "group": GROUP,
    # Optional Parameters
    "where": WHERE,
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Count API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'LocateFragment'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = 'coreClientFirm:eq:ExampleString'

# Request Parameters for getCount Of The MsgType
params = {
# Required Parameters
"apiKey": API_KEY,
"cmd": 'getcount',
"msgType": MSG_TYPE,
# Optional Parameters
"where": WHERE,
}

response = requests.get(MLINK_PROD_URL, params=params)
Table of Contents