Schema: SpdrParentOrder (ID: 4095)

SpdrParentOrder records are visible in SRSE immediately after receipt. Parent orders received via FIX, SRSE or SpiderRock GUI tools, or 3rd party vendor systems are all visible in this table.

Parent orders can be for stocks, futures, options or spreads. And they can be one-sided (agency) or two-sided (facilitation) orders. Parent order records should be immutable and not update.

SpdrParentOrder records are published to the SpiderRock elatic cluster on arrival.

METADATA

Attribute	Value
Topic	3985-parent-orders
MLink Token	ClientTrading
SRSE Product	SRTrade

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

BODY

#	Field	Type	Comment
10=	parentNumber	long	SPDR order number
100	sysEnvironment	enum : SysEnvironment	original (source) sys environment [Stable, Current, etc]
103	runStatus	enum : RunStatus	original (source) run status [Prod,Beta]
106	spdrActionType	enum : SpdrActionType
109	parentShape	enum : SpdrOrderShape
112	clientSeqNumIn	int	inbound client seq number (FIX orders only)
115	altOrderId	string(24)	alternate order ID (usually clOrdId from client)
118	altPrevOrderId	string(24)	alternate prev order ID (usually origClOrdId from client during cxl/replace)
124	altAutoHedgeId	string(24)	alternate order ID for child autohedge orders (if any)
127	altAccnt	string(32)	alternate (client assigned) "long" account string (optional) [used to map between client and SR account strings]
130	altUserName	string(24)	alternate (client assigned) user name (optional) [used to map between client and SR account strings]
133	srcRoutingCode	text1	inbound FIX routing code or SRSE/tool server appID (if any)
136	packageId	long	references spread orderNumber, if a legged spread order or auto-hedge order
139	secKey	OptionKey	Composite Security Key
142	secType	enum : SpdrKeyType	Security Type [Stock, Future, Option]
145	securityDesc	text1	additional security description
148	accnt	string(16)	SR trading account
151	clientFirm	string(16)	SR client firm
154	spdrSource	enum : SpdrSource
157	groupingCode	long	unique broker code;broker.pkey = (key + accnt + spdrSource + groupingCode)
1039	execBrkrCode	string(16)	overrides the default executing broker for this parent order
1040	externExDest	string(16)	routing code for orders directed to an external order router (default = null); must match an exDest associated with a RouteDefinition
166	externParams	text1	external algo names/parameters (usually just an algo name)
169	strategy	string(36)	client-supplied strategy string;visible on SpiderRock GUI tools and other order reports.
172	userName	string(24)	name of the user entering the order
1031	userSource	enum : SpdrSource	SpdrSource of this order (assumed to be the same as spdrSource if None)
178	orderDttm	DateTime	order entry time (from client;if any)
181	orderSide	enum : BuySell
184	orderSize	int	maximum fill size (contracts)
187	orderActiveSize	int	total activated size (total size released for execution) (-1 = all available size)
190	curCumFillQuantity	int	set order size = orderSize - Max(0, curCumFillQty - ee.cumFillQty) (used to ensure integrity of submitted cxl/replace orders)
193	addCumFillQuantity	enum : YesNo	If Yes then OrderSize is calculated @ order arrival as requested OrderSize + existing 'CumFillQuantity'.
196	maxExposureSize	int	maximum simultaneous cumulative child order public size exposure (-1 = orderActiveSize) [order can overfill if > orderActiveSize and numMakeExchanges > 1]
199	numMakeExchanges	byte	number of exchanges (1 - 4) on which to publish public making orders. Effective number might be less than requested number if sufficient exchanges are not available.
202	publicSize	enum : PublicSizeHandling	public order size handling: None=algo default; Randomize=randomize public size; MktSize=expose typical market size; FullSize=expose entire order size where possible; FullSizeR=randomize full size
205	canOverlapCxlRepl	enum : YesNo	can execution engines overlap cancel/replace operations [order can overfill if YES] (at most one active overlapping cxl/replace operation for each parent order)
208	progressRule	enum : ProgressRule	Immediate = all size immediately available; TWAP = work from arrival to expiration; VWAP = work order not faster than participation rate
211	blockVisibility	enum : BlockVisibility	for BlockAuction orders, visibility (to responders) is neither, side only, or side + price
214	progressSliceCnt	byte	number of slices to use (default = 4 or 8) [max 20]
217	progressExposeTime	int	minimum time (secs) to expose order (0 = no minimum; used to guarantee that the order is exposed at mid-market for some time before actively taking)
220	vwapParticipation	float	target vwap participation rate (target % of trade activity)
223	minMktOnClosePct	byte	Minimum pct [0 - 100] of order reserved for the on-close (MOC) auction
226	triggerType	enum : TriggerType	type of trigger (PrintVol/SurfVol only for options) [print = print or actionable quote]
229	triggerLevel	float	stop/trigger level for parent order to go active (can be either a price or vol)
232	auctionResponder	enum : AuctionResponder	if set, parent order can be an auction responder
235	maxMakeExchFee	float	maximum making exchange fee (in point value) [zero = no limit; use non-zero number for limit to apply]
238	maxTakeExchFee	float	maximum taking exchange fee (in point value) [zero = no limit; use non-zero number for limit to apply]
241	incTakeExchFee	enum : IncExchFee	include exchange fee in probability and surface based take limit calculations
244	incMakeExchFee	enum : IncExchFee	include exchange fee in probability and surface based make limit calculations
247	makeExchRule	enum : MakeExchRule	ActiveMaker exch preference: 'MaxPart' = max participation; 'FeeOrder' = minimize fees [max rebates]; 'ImprvOnly' will only make when improving NBBO; 'RoundRobin' will rotate through exch list; 'ProRataOptim' will post on pro-rata only.
250	cxlUPrcRange	enum : UPrcCxl	cancel parent order if/when outside the uPrice range [ _Halt = also cancel if halted ]
253	minUBid	float	[optional]
256	maxUAsk	float	[optional] (< $0.01 = none)
259	minMaxType	enum : MinMaxType	if Prc minUBid/maxUAsk are expressed as prices; if Pct then they are expresses as pct change since parent order arrival
262	minOptionPx	float	[optional] option price floor for tied to stock orders
265	maxChildOrders	int	maximum number of child orders that can be generated by this parent order [order will terminate if/when this cap is reached;zero or neg = unlimited]
268	exchMask	uint	eligible exchanges (0 = all)
271	spdrStageType	enum : SpdrStageType	note: stageType != None implies both KeepAlive behavior and makes the order visible on tools
1032	marketSession	enum : MarketSession
277	startDttm	DateTime	[optional] (parent order start time)
280	orderDuration	int	[optional] (number of seconds)
1033	activeDuration	int
283	goodTillDttm	DateTime	[optional] (default: 2099-01-01)
286	startType	enum : StartType	WaitTrigger associates this order with a triggerGroupId. The initial wave of child orders from the TriggerGroup will be send when a (final) parent order with startType=TriggerAll or when an external trigger signal is received.
289	triggerGroupId	long	triggerGroupId is required if startType=WaitTrigger; note that child orders from all parent orders in the trigger group will be organized and released optimally when the triggerGroup is released
292	triggerTimestamp	long	WaitTrigger trigger timestamp (nanoseconds since epoch)
298	parentOrderHandling	enum : ParentOrderHandling
301	parentBalanceHandling	enum : ParentBalanceHandling
304	orderLimitType	enum : SpdrLimitType
307	takeLimitClass	enum : SpdrLimitClass	Simple = LimitPrice +/- offset, Surface = BEST(LimitPrice, SurfLimit), Probability = BEST(LimitPrice, ProbLimit), SurfProb = BEST(LimitPrice, SurfLimit, ProbLimit)
310	makeLimitClass	enum : SpdrLimitClass	Simple = LimitPrice +/- offset, Surface = BEST(LimitPrice, SurfLimit), Probability = BEST(LimitPrice, ProbLimit), SurfProb = BEST(LimitPrice, SurfLimit, ProbLimit)
313	takeReachRule	enum : ReachRule	None = size immediately available; Delayed = available after [1-3] seconds; Passive = available if contra side aggresses; WeakOnly = only take if available size < avgMarketSize; ISOSweep = Intermarket Sweep [requires WaitTrigger]
316	orderPrcLimit	double	Applies if LimitType = Prc[]
319	orderRefUPrc	double	default=underlier.mid
322	orderRefDelta	float	default=option.delta
325	orderRefGamma	float	default=option.gamma
328	orderVolLimit	float	Applies if LimitType = Vol[] [uses SR dividends and borrow rates]
331	rateOverride	float	zero = ignore; > zero = override
334	sdivOverride	float
337	ddivOverride	text1	discrete dividend string override ([yearsToExpiry,divYears:divAmount,divYears:divAmount, ...])
340	overrideCode	enum : OverrideCode
343	orderPrcOffset	double	default=0 [surface, relX and pegX limit offsets]
346	stateModel	enum : StateModel
349	uStateModel	enum : StateModel
352	takeAlphaType	enum : AlphaType	Applies if takeLimitClass = Probability
355	makeAlphaType	enum : AlphaType	Applies if makeLimitClass = Probability
358	takeAlphaFactor	float	[-2,+2] takeProbLimit = MAX(takeProbability, takeProbAvg + takeAlphaFactor * takeProbStd) [if AlphaType = Relative]
361	makeAlphaFactor	float	[-2,+2] makeProbLimit = MAX(makeProbability, makeProbAvg + makeAlphaFactor * makeProbStd) [if AlphaType = Relative]
364	takeProbability	float	takeProbLimit = takeProbability [if AlphaType = Static]
367	makeProbability	float	makeProbLimit = makeProbability [if AlphaType = Static]
370	takeSurfPrcOffset	double	default=0
373	takeSurfVolOffset	float	default=0
376	takeSurfWidthOffset	float	[-1.x to +1.x] -1.0 = -0.5 * avgMktWidth, +1.0 = +0.5 * avgMktWidth
379	makeSurfPrcOffset	double	default=0
382	makeSurfVolOffset	float	default=0
385	makeSurfWidthOffset	float	[-1.x to +1.x] -1.0 = -0.5 * avgMktWidth, +1.0 = +0.5 * avgMktWidth
388	orderRefEventMult	float	expected underlier abs move (0.01 = 1%) @ orderRefEventDttm
391	orderRefEventDttm	DateTime	Date/time of the next event. Note that events are usually earnings but are not required to be.
394	autoHedge	enum : AutoHedge
397	hedgeInstrument	enum : HedgeInst	Default=actual underlier (EQT or FUT) [IndexOptions use ETF]; FrontMonth=actual underlier (EQT) or front month (FUT) [IndexOptions use FM Fut]; Stock=hedgeSecKey.TickerKey; Future=hedgeSecKey.ExpiryKey
400	hedgeSecKey	ExpiryKey	autohedge instrument (can be a TickerKey (stock) or ExpiryKey (future)) [required for Stock and Future]
403	hedgeBetaRatio	float	portion of executed $money to auto-hedge (can be 1.0 / Beta for beta hedging) [-4.0 to +4.0]
406	hedgeScope	enum : HedgeScope	hedge group scope [RiskGroup or Accnt]
1034	hedgeSession	enum : MarketSession	market session for the autohedge order [defaults to pOrder.marketSession]
1041	externHedgeExDest	string(16)	external broker exDest (only used if orderHandling=Extern) # Should match FixRoutingTable.destination type (eg. #Nighthawk)
415	externHedgeParams	text1	external algo names/parameters (usually just an algo name) # usually copied from the FixRoutingTable.externParams
418	firmType	enum : FirmType	used to override firmType in account config
421	orderCapacity	enum : OrderCapacity
424	positionType	enum : PositionType
427	ssaleFlag	enum : ShortSaleFlag	used to determine stock auto-hedge flags
430	noCrossGroup	string(16)
433	exchTraderId	string(16)
436	largeTraderId	string(16)
439	tradingLocation	string(16)
484	leadSide	enum : BuySell	for legged orders, which side to lead with. (optional, None ok)
487	maxCompletionSlippage	double	maximum price slippage to complete an open basket
490	orderRefPremium	float	reference premium (mleg orders only)
1038	noticeNumber	long	required when parentOrderHandling = BlockResponse
496	theoVol	float	client supplied theoretical volatility (used for markup only)
499	clArriveMark	float	client specified arrival mark (passed through to ParentExecution; markup only)
502	riskGroupId	long	all orders with the same riskGroupId share a common set of risk counters;.Grp. risk limits apply to these shared counters
1036	reqAuxRiskGroupCtrl	enum : YesNo
442	refRMetric1Src	enum : RMetricSource
445	refRMetric2Src	enum : RMetricSource
448	refRMetric3Src	enum : RMetricSource
451	refRMetric4Src	enum : RMetricSource
454	refRMetric5Src	enum : RMetricSource
457	refRMetric6Src	enum : RMetricSource
460	refRMetric7Src	enum : RMetricSource
463	orderRefRMetric1	float	user supplied RMetric1 value (used in RiskGroupID risk controls) [netRMetric1 = sum(fillQty * orderRefRMetric1 * underlierPerCn)]
466	orderRefRMetric2	float	user supplied RMetric2 value (used in RiskGroupID risk controls) [netRMetric2 = sum(fillQty * orderRefRMetric2 * underlierPerCn)]
469	orderRefRMetric3	float	user supplied RMetric3 value (used in RiskGroupID risk controls) [netRMetric3 = sum(fillQty * orderRefRMetric3 * underlierPerCn)]
472	orderRefRMetric4	float	user supplied RMetric4 value (used in RiskGroupID risk controls) [netRMetric4 = sum(fillQty * orderRefRMetric4 * underlierPerCn)]
475	orderRefRMetric5	float	user supplied RMetric5 value (used in RiskGroupID risk controls) [netRMetric5 = sum(fillQty * orderRefRMetric5 * underlierPerCn)]
478	orderRefRMetric6	float	user supplied RMetric6 value (used in ExpDay risk controls) [netRMetric6 = sum(fillQty * orderRefRMetric6 * underlierPerCn)]
481	orderRefRMetric7	float	user supplied RMetric7 value (used in SymDay risk controls) [netRMetric7 = sum(fillQty * orderRefRMetric7 * underlierPerCn)]
529	expDayWtVegaOffset	float	max acct+symbol day wtVega offset (target)
523	maxExpDayWtVegaLn	float	max accnt+expiration day (time weighted) vega long (positive number;-1=no limit);risk limit = max limit - (current net counter - offset)
526	maxExpDayWtVegaSh	float	max accnt+expiration day (time weighted) vega short (positive number;-1=no limit);risk limit = max limit + (current net counter - offset)
559	maxExpDayRMetric6Ln	float	max acct+expiration day rMetric6 long (positive number;-1=no limit);risk limit = max limit - current net counter
562	maxExpDayRMetric6Sh	float	max acct+expiration day rMetric6 short (positive number;-1=no limit);risk limit = max limit + current net counter
556	symDayDDeltaOffset	float	max acct+symbol day $delta offset (target)
550	maxSymDayDDeltaLn	float	max acct+symbol day $delta long (positive number;-1=no limit);risk limit = max limit - (current net counter - offset)
553	maxSymDayDDeltaSh	float	max acct+symbol day $delta short (positive number;-1=no limit);risk limit = max limit + (current net counter - offset)
538	symDayVegaOffset	float	max acct+symbol day vega offset (target)
532	maxSymDayVegaLn	float	max acct+symbol day vega long (positive number;-1=no limit);risk limit = max limit - (current net counter - offset)
535	maxSymDayVegaSh	float	max acct+symbol day vega short (positive number;-1=no limit);risk limit = max limit + (current net counter - offset)
547	symDayWtVegaOffset	float	max acct+symbol day wtVega offset (target)
541	maxSymDayWtVegaLn	float	max acct+symbol day (time weighted) vega long (positive number;-1=no limit);risk limit = max limit - (current net counter - offset)
544	maxSymDayWtVegaSh	float	max acct+symbol day (time weighted) vega short (positive number;-1=no limit);risk limit = max limit + (current net counter - offset)
568	maxSymDayRMetric7Ln	float	max acct+symbol day rMetric7 long (positive number;-1=no limit);risk limit = max limit - current net counter
571	maxSymDayRMetric7Sh	float	max acct+symbol day rMetric7 short (positive number;-1=no limit);risk limit = max limit + current net counter
577	maxGrpDayDDeltaLn	float	max acct+riskGroup day $delta long (positive number;-1=no limit);risk limit = max limit - current net counter
580	maxGrpDayDDeltaSh	float	max acct+riskGroup day $delta short (positive number;-1=no limit);risk limit = max limit + current net counter
586	maxGrpDayVegaLn	float	max acct+riskGroup day vega long (positive number;-1=no limit);risk limit = max limit - current net counter
589	maxGrpDayVegaSh	float	max acct+riskGroup day vega short (positive number;-1=no limit);risk limit = max limit + current net counter
592	maxGrpDayVegaAbs	float	max acct+riskGroup day vega abs (positive number;-1=no limit);risk limit = max limit - abs(current net counter)
595	grpDayVegaRatio	float	target bot / sld ratio (eg ratio=2.0 means that neutral is bot vega = 2x sld vega)
646	maxGrpDayContractsLn	int	max acct+riskGroup day opt contracts long (positive number;-1=no limit);risk limit = max limit - current net counter
649	maxGrpDayContractsSh	int	max acct+riskGroup day opt contracts short (positive number;-1=no limit);risk limit = max limit + current net counter
652	maxGrpDayContractsAbs	int	max acct+riskGroup day opt contracts abs (positive number;-1=no limit);risk limit = max limit - abs(current net counter)
610	maxGrpDayRMetric1Ln	float	max acct+riskGroup day rMetric1 long (positive number;-1=no limit);risk limit = max limit - current net counter
613	maxGrpDayRMetric1Sh	float	max acct+riskGroup day rMetric1 short (positive number;-1=no limit);risk limit = max limit + current net counter
616	maxGrpDayRMetric1Abs	float	max acct+riskGroup day rMetric1 abs (positive number;-1=no limit);risk limit = max limit - abs(current net counter)
619	grpDayRMetric1Ratio	float	target bot / sld ratio (eg ratio=0.5 means that neutral is bot rMetric1 = 0.5x sld rMetric1)
622	maxGrpDayRMetric2Ln	float	max acct+riskGroup day rMetric2 long (positive number;-1=no limit);risk limit = max limit - current net counter
625	maxGrpDayRMetric2Sh	float	max acct+riskGroup day rMetric2 short (positive number;-1=no limit);risk limit = max limit + current net counter
628	maxGrpDayRMetric3Ln	float	max acct+riskGroup day rMetric3 long (positive number;-1=no limit);risk limit = max limit - current net counter
631	maxGrpDayRMetric3Sh	float	max acct+riskGroup day rMetric3 short (positive number;-1=no limit);risk limit = max limit + current net counter
634	maxGrpDayRMetric4Ln	float	max acct+riskGroup day rMetric4 long (positive number;-1=no limit);risk limit = max limit - current net counter
637	maxGrpDayRMetric4Sh	float	max acct+riskGroup day rMetric4 short (positive number;-1=no limit);risk limit = max limit + current net counter
640	maxGrpDayRMetric5Ln	float	max acct+riskGroup day rMetric5 long (positive number;-1=no limit);risk limit = max limit - current net counter
643	maxGrpDayRMetric5Sh	float	max acct+riskGroup day rMetric5 short (positive number;-1=no limit);risk limit = max limit + current net counter
655	symEmaCxlDDeltaLn	float	max acct+symbol 60s EMA $delta long (positive number; <= 0 is no limit) [will immediately cxl all option orders in a symbol if any order in the symbol breaches]
658	symEmaCxlDDeltaSh	float	max acct+symbol 60s EMA $delta short (positive number; <= 0 is no limit)
661	symEmaCxlWtVegaLn	float	max acct+symbol 60s EMA wtVega long (positive number; <= 0 is no limit) [will immediately cxl all option orders in a symbol if any order in the symbol breaches]
664	symEmaCxlWtVegaSh	float	max acct+symbol 60s EMA wtVega short (positive number; <= 0 is no limit)
667	lastFillDttm	DateTime
670	userData1	text1	client supplied data field; passes through to parent and child executions and reports as well as FIX drops
673	userData2	text1	client supplied data field; passes through to parent and child executions and reports as well as FIX drops
676	childData	text1	client supplied data field; passes through to down stream child orders
679	srcTimestamp	long
682	sgwTimestamp	long
685	timestamp	DateTime
1037	includeSRNetwork	enum : InclExclDisclose

REPEATING FIELDS

DirectedCounterParty

Field	Type	Comment
697	clientFirm	string(16)
700	inclExcl	enum : InclExclDisclose

OrderLegs

Field	Type	Comment
754	ticker	TickerKey
757	stockSide	enum : BuySell
760	stockShares	int
763	stockLegId	long
766	altStkLegId	string(24)
769	ssaleFlag	enum : ShortSaleFlag
775	refUPrc	float
778	numLegs	byte
781	secKey1	OptionKey
784	secType1	enum : SpdrKeyType
787	mult1	ushort
790	side1	enum : BuySell
793	legId1	long
796	altLegId1	string(24)
799	posType1	enum : PositionType
805	ssaleFlag1	enum : ShortSaleFlag
811	vega1	float
814	refUPrc1	double
817	refDelta1	float
820	refEarnCnt1	byte
823	secKey2	OptionKey
826	secType2	enum : SpdrKeyType
829	mult2	ushort
832	side2	enum : BuySell
835	legId2	long
838	altLegId2	string(24)
841	posType2	enum : PositionType
847	ssaleFlag2	enum : ShortSaleFlag
853	vega2	float
856	refUPrc2	double
859	refDelta2	float
862	refEarnCnt2	byte
865	secKey3	OptionKey
868	secType3	enum : SpdrKeyType
871	mult3	ushort
874	side3	enum : BuySell
877	legId3	long
880	altLegId3	string(24)
883	posType3	enum : PositionType
889	ssaleFlag3	enum : ShortSaleFlag
895	vega3	float
898	refUPrc3	double
901	refDelta3	float
904	refEarnCnt3	byte
907	secKey4	OptionKey
910	secType4	enum : SpdrKeyType
913	mult4	ushort
916	side4	enum : BuySell
919	legId4	long
922	altLegId4	string(24)
925	posType4	enum : PositionType
931	ssaleFlag4	enum : ShortSaleFlag
937	vega4	float
940	refUPrc4	double
943	refDelta4	float
946	refEarnCnt4	byte
949	secKey5	OptionKey
952	secType5	enum : SpdrKeyType
955	mult5	ushort
958	side5	enum : BuySell
961	legId5	long
964	altLegId5	string(24)
967	posType5	enum : PositionType
973	ssaleFlag5	enum : ShortSaleFlag
979	vega5	float
982	refUPrc5	double
985	refDelta5	float
988	refEarnCnt5	byte
991	secKey6	OptionKey
994	secType6	enum : SpdrKeyType
997	mult6	ushort
1000	side6	enum : BuySell
1003	legId6	long
1006	altLegId6	string(24)
1009	posType6	enum : PositionType
1015	ssaleFlag6	enum : ShortSaleFlag
1021	vega6	float
1024	refUPrc6	double
1027	refDelta6	float
1030	refEarnCnt6	byte

Get Schema API Call

Python

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 = 'SpdrParentOrder'

# 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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getschema' \
--data-urlencode 'msgType=SpdrParentOrder'

Get Msg API Call

Python

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 = 'SpdrParentOrder'

# 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 = 'sysEnvironment|runStatus|spdrActionType|parentShape|clientSeqNumIn|altOrderId|altPrevOrderId|altAutoHedgeId|altAccnt|altUserName|srcRoutingCode|packageId|secKey|secType|securityDesc|accnt|clientFirm|spdrSource|groupingCode|execBrkrCode|externExDest|externParams|strategy|userName|userSource|orderDttm|orderSide|orderSize|orderActiveSize|curCumFillQuantity|addCumFillQuantity|maxExposureSize|numMakeExchanges|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|progressSliceCnt|progressExposeTime|vwapParticipation|minMktOnClosePct|triggerType|triggerLevel|auctionResponder|maxMakeExchFee|maxTakeExchFee|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minUBid|maxUAsk|minMaxType|minOptionPx|maxChildOrders|exchMask|spdrStageType|marketSession|startDttm|orderDuration|activeDuration|goodTillDttm|startType|triggerGroupId|triggerTimestamp|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|orderPrcLimit|orderRefUPrc|orderRefDelta|orderRefGamma|orderVolLimit|rateOverride|sdivOverride|ddivOverride|overrideCode|orderPrcOffset|stateModel|uStateModel|takeAlphaType|makeAlphaType|takeAlphaFactor|makeAlphaFactor|takeProbability|makeProbability|takeSurfPrcOffset|takeSurfVolOffset|takeSurfWidthOffset|makeSurfPrcOffset|makeSurfVolOffset|makeSurfWidthOffset|orderRefEventMult|orderRefEventDttm|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|externHedgeExDest|externHedgeParams|firmType|orderCapacity|positionType|ssaleFlag|noCrossGroup|exchTraderId|largeTraderId|tradingLocation|leadSide|maxCompletionSlippage|orderRefPremium|noticeNumber|theoVol|clArriveMark|riskGroupId|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|orderRefRMetric1|orderRefRMetric2|orderRefRMetric3|orderRefRMetric4|orderRefRMetric5|orderRefRMetric6|orderRefRMetric7|expDayWtVegaOffset|maxExpDayWtVegaLn|maxExpDayWtVegaSh|maxExpDayRMetric6Ln|maxExpDayRMetric6Sh|symDayDDeltaOffset|maxSymDayDDeltaLn|maxSymDayDDeltaSh|symDayVegaOffset|maxSymDayVegaLn|maxSymDayVegaSh|symDayWtVegaOffset|maxSymDayWtVegaLn|maxSymDayWtVegaSh|maxSymDayRMetric7Ln|maxSymDayRMetric7Sh|maxGrpDayDDeltaLn|maxGrpDayDDeltaSh|maxGrpDayVegaLn|maxGrpDayVegaSh|maxGrpDayVegaAbs|grpDayVegaRatio|maxGrpDayContractsLn|maxGrpDayContractsSh|maxGrpDayContractsAbs|maxGrpDayRMetric1Ln|maxGrpDayRMetric1Sh|maxGrpDayRMetric1Abs|grpDayRMetric1Ratio|maxGrpDayRMetric2Ln|maxGrpDayRMetric2Sh|maxGrpDayRMetric3Ln|maxGrpDayRMetric3Sh|maxGrpDayRMetric4Ln|maxGrpDayRMetric4Sh|maxGrpDayRMetric5Ln|maxGrpDayRMetric5Sh|symEmaCxlDDeltaLn|symEmaCxlDDeltaSh|symEmaCxlWtVegaLn|symEmaCxlWtVegaSh|lastFillDttm|userData1|userData2|childData|srcTimestamp|sgwTimestamp|timestamp|includeSRNetwork'

# 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 = 'altOrderId: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsg' \
--data-urlencode 'pkey=ReplaceThisValueForTheQueryToWork' \
--data-urlencode 'msgType=SpdrParentOrder' \
--data-urlencode 'view=sysEnvironment|runStatus|spdrActionType|parentShape|clientSeqNumIn|altOrderId|altPrevOrderId|altAutoHedgeId|altAccnt|altUserName|srcRoutingCode|packageId|secKey|secType|securityDesc|accnt|clientFirm|spdrSource|groupingCode|execBrkrCode|externExDest|externParams|strategy|userName|userSource|orderDttm|orderSide|orderSize|orderActiveSize|curCumFillQuantity|addCumFillQuantity|maxExposureSize|numMakeExchanges|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|progressSliceCnt|progressExposeTime|vwapParticipation|minMktOnClosePct|triggerType|triggerLevel|auctionResponder|maxMakeExchFee|maxTakeExchFee|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minUBid|maxUAsk|minMaxType|minOptionPx|maxChildOrders|exchMask|spdrStageType|marketSession|startDttm|orderDuration|activeDuration|goodTillDttm|startType|triggerGroupId|triggerTimestamp|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|orderPrcLimit|orderRefUPrc|orderRefDelta|orderRefGamma|orderVolLimit|rateOverride|sdivOverride|ddivOverride|overrideCode|orderPrcOffset|stateModel|uStateModel|takeAlphaType|makeAlphaType|takeAlphaFactor|makeAlphaFactor|takeProbability|makeProbability|takeSurfPrcOffset|takeSurfVolOffset|takeSurfWidthOffset|makeSurfPrcOffset|makeSurfVolOffset|makeSurfWidthOffset|orderRefEventMult|orderRefEventDttm|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|externHedgeExDest|externHedgeParams|firmType|orderCapacity|positionType|ssaleFlag|noCrossGroup|exchTraderId|largeTraderId|tradingLocation|leadSide|maxCompletionSlippage|orderRefPremium|noticeNumber|theoVol|clArriveMark|riskGroupId|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|orderRefRMetric1|orderRefRMetric2|orderRefRMetric3|orderRefRMetric4|orderRefRMetric5|orderRefRMetric6|orderRefRMetric7|expDayWtVegaOffset|maxExpDayWtVegaLn|maxExpDayWtVegaSh|maxExpDayRMetric6Ln|maxExpDayRMetric6Sh|symDayDDeltaOffset|maxSymDayDDeltaLn|maxSymDayDDeltaSh|symDayVegaOffset|maxSymDayVegaLn|maxSymDayVegaSh|symDayWtVegaOffset|maxSymDayWtVegaLn|maxSymDayWtVegaSh|maxSymDayRMetric7Ln|maxSymDayRMetric7Sh|maxGrpDayDDeltaLn|maxGrpDayDDeltaSh|maxGrpDayVegaLn|maxGrpDayVegaSh|maxGrpDayVegaAbs|grpDayVegaRatio|maxGrpDayContractsLn|maxGrpDayContractsSh|maxGrpDayContractsAbs|maxGrpDayRMetric1Ln|maxGrpDayRMetric1Sh|maxGrpDayRMetric1Abs|grpDayRMetric1Ratio|maxGrpDayRMetric2Ln|maxGrpDayRMetric2Sh|maxGrpDayRMetric3Ln|maxGrpDayRMetric3Sh|maxGrpDayRMetric4Ln|maxGrpDayRMetric4Sh|maxGrpDayRMetric5Ln|maxGrpDayRMetric5Sh|symEmaCxlDDeltaLn|symEmaCxlDDeltaSh|symEmaCxlWtVegaLn|symEmaCxlWtVegaSh|lastFillDttm|userData1|userData2|childData|srcTimestamp|sgwTimestamp|timestamp|includeSRNetwork' \
--data-urlencode 'where=altOrderId:eq:ExampleString'

Get Msgs API Call

Python

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 = 'SpdrParentOrder'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'sysEnvironment|runStatus|spdrActionType|parentShape|clientSeqNumIn|altOrderId|altPrevOrderId|altAutoHedgeId|altAccnt|altUserName|srcRoutingCode|packageId|secKey|secType|securityDesc|accnt|clientFirm|spdrSource|groupingCode|execBrkrCode|externExDest|externParams|strategy|userName|userSource|orderDttm|orderSide|orderSize|orderActiveSize|curCumFillQuantity|addCumFillQuantity|maxExposureSize|numMakeExchanges|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|progressSliceCnt|progressExposeTime|vwapParticipation|minMktOnClosePct|triggerType|triggerLevel|auctionResponder|maxMakeExchFee|maxTakeExchFee|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minUBid|maxUAsk|minMaxType|minOptionPx|maxChildOrders|exchMask|spdrStageType|marketSession|startDttm|orderDuration|activeDuration|goodTillDttm|startType|triggerGroupId|triggerTimestamp|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|orderPrcLimit|orderRefUPrc|orderRefDelta|orderRefGamma|orderVolLimit|rateOverride|sdivOverride|ddivOverride|overrideCode|orderPrcOffset|stateModel|uStateModel|takeAlphaType|makeAlphaType|takeAlphaFactor|makeAlphaFactor|takeProbability|makeProbability|takeSurfPrcOffset|takeSurfVolOffset|takeSurfWidthOffset|makeSurfPrcOffset|makeSurfVolOffset|makeSurfWidthOffset|orderRefEventMult|orderRefEventDttm|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|externHedgeExDest|externHedgeParams|firmType|orderCapacity|positionType|ssaleFlag|noCrossGroup|exchTraderId|largeTraderId|tradingLocation|leadSide|maxCompletionSlippage|orderRefPremium|noticeNumber|theoVol|clArriveMark|riskGroupId|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|orderRefRMetric1|orderRefRMetric2|orderRefRMetric3|orderRefRMetric4|orderRefRMetric5|orderRefRMetric6|orderRefRMetric7|expDayWtVegaOffset|maxExpDayWtVegaLn|maxExpDayWtVegaSh|maxExpDayRMetric6Ln|maxExpDayRMetric6Sh|symDayDDeltaOffset|maxSymDayDDeltaLn|maxSymDayDDeltaSh|symDayVegaOffset|maxSymDayVegaLn|maxSymDayVegaSh|symDayWtVegaOffset|maxSymDayWtVegaLn|maxSymDayWtVegaSh|maxSymDayRMetric7Ln|maxSymDayRMetric7Sh|maxGrpDayDDeltaLn|maxGrpDayDDeltaSh|maxGrpDayVegaLn|maxGrpDayVegaSh|maxGrpDayVegaAbs|grpDayVegaRatio|maxGrpDayContractsLn|maxGrpDayContractsSh|maxGrpDayContractsAbs|maxGrpDayRMetric1Ln|maxGrpDayRMetric1Sh|maxGrpDayRMetric1Abs|grpDayRMetric1Ratio|maxGrpDayRMetric2Ln|maxGrpDayRMetric2Sh|maxGrpDayRMetric3Ln|maxGrpDayRMetric3Sh|maxGrpDayRMetric4Ln|maxGrpDayRMetric4Sh|maxGrpDayRMetric5Ln|maxGrpDayRMetric5Sh|symEmaCxlDDeltaLn|symEmaCxlDDeltaSh|symEmaCxlWtVegaLn|symEmaCxlWtVegaSh|lastFillDttm|userData1|userData2|childData|srcTimestamp|sgwTimestamp|timestamp|includeSRNetwork'

# 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 = 'altOrderId: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 = 'sysEnvironment: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsgs' \
--data-urlencode 'msgType=SpdrParentOrder' \
--data-urlencode 'view=sysEnvironment|runStatus|spdrActionType|parentShape|clientSeqNumIn|altOrderId|altPrevOrderId|altAutoHedgeId|altAccnt|altUserName|srcRoutingCode|packageId|secKey|secType|securityDesc|accnt|clientFirm|spdrSource|groupingCode|execBrkrCode|externExDest|externParams|strategy|userName|userSource|orderDttm|orderSide|orderSize|orderActiveSize|curCumFillQuantity|addCumFillQuantity|maxExposureSize|numMakeExchanges|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|progressSliceCnt|progressExposeTime|vwapParticipation|minMktOnClosePct|triggerType|triggerLevel|auctionResponder|maxMakeExchFee|maxTakeExchFee|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minUBid|maxUAsk|minMaxType|minOptionPx|maxChildOrders|exchMask|spdrStageType|marketSession|startDttm|orderDuration|activeDuration|goodTillDttm|startType|triggerGroupId|triggerTimestamp|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|orderPrcLimit|orderRefUPrc|orderRefDelta|orderRefGamma|orderVolLimit|rateOverride|sdivOverride|ddivOverride|overrideCode|orderPrcOffset|stateModel|uStateModel|takeAlphaType|makeAlphaType|takeAlphaFactor|makeAlphaFactor|takeProbability|makeProbability|takeSurfPrcOffset|takeSurfVolOffset|takeSurfWidthOffset|makeSurfPrcOffset|makeSurfVolOffset|makeSurfWidthOffset|orderRefEventMult|orderRefEventDttm|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|externHedgeExDest|externHedgeParams|firmType|orderCapacity|positionType|ssaleFlag|noCrossGroup|exchTraderId|largeTraderId|tradingLocation|leadSide|maxCompletionSlippage|orderRefPremium|noticeNumber|theoVol|clArriveMark|riskGroupId|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|orderRefRMetric1|orderRefRMetric2|orderRefRMetric3|orderRefRMetric4|orderRefRMetric5|orderRefRMetric6|orderRefRMetric7|expDayWtVegaOffset|maxExpDayWtVegaLn|maxExpDayWtVegaSh|maxExpDayRMetric6Ln|maxExpDayRMetric6Sh|symDayDDeltaOffset|maxSymDayDDeltaLn|maxSymDayDDeltaSh|symDayVegaOffset|maxSymDayVegaLn|maxSymDayVegaSh|symDayWtVegaOffset|maxSymDayWtVegaLn|maxSymDayWtVegaSh|maxSymDayRMetric7Ln|maxSymDayRMetric7Sh|maxGrpDayDDeltaLn|maxGrpDayDDeltaSh|maxGrpDayVegaLn|maxGrpDayVegaSh|maxGrpDayVegaAbs|grpDayVegaRatio|maxGrpDayContractsLn|maxGrpDayContractsSh|maxGrpDayContractsAbs|maxGrpDayRMetric1Ln|maxGrpDayRMetric1Sh|maxGrpDayRMetric1Abs|grpDayRMetric1Ratio|maxGrpDayRMetric2Ln|maxGrpDayRMetric2Sh|maxGrpDayRMetric3Ln|maxGrpDayRMetric3Sh|maxGrpDayRMetric4Ln|maxGrpDayRMetric4Sh|maxGrpDayRMetric5Ln|maxGrpDayRMetric5Sh|symEmaCxlDDeltaLn|symEmaCxlDDeltaSh|symEmaCxlWtVegaLn|symEmaCxlWtVegaSh|lastFillDttm|userData1|userData2|childData|srcTimestamp|sgwTimestamp|timestamp|includeSRNetwork' \
--data-urlencode 'where=altOrderId:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=sysEnvironment:ASC'

Get Aggregate API Call

Python

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 = 'SpdrParentOrder'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'sysEnvironment|runStatus|spdrActionType|parentShape|clientSeqNumIn|altOrderId|altPrevOrderId|altAutoHedgeId|altAccnt|altUserName|srcRoutingCode|packageId|secKey|secType|securityDesc|accnt|clientFirm|spdrSource|groupingCode|execBrkrCode|externExDest|externParams|strategy|userName|userSource|orderDttm|orderSide|orderSize|orderActiveSize|curCumFillQuantity|addCumFillQuantity|maxExposureSize|numMakeExchanges|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|progressSliceCnt|progressExposeTime|vwapParticipation|minMktOnClosePct|triggerType|triggerLevel|auctionResponder|maxMakeExchFee|maxTakeExchFee|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minUBid|maxUAsk|minMaxType|minOptionPx|maxChildOrders|exchMask|spdrStageType|marketSession|startDttm|orderDuration|activeDuration|goodTillDttm|startType|triggerGroupId|triggerTimestamp|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|orderPrcLimit|orderRefUPrc|orderRefDelta|orderRefGamma|orderVolLimit|rateOverride|sdivOverride|ddivOverride|overrideCode|orderPrcOffset|stateModel|uStateModel|takeAlphaType|makeAlphaType|takeAlphaFactor|makeAlphaFactor|takeProbability|makeProbability|takeSurfPrcOffset|takeSurfVolOffset|takeSurfWidthOffset|makeSurfPrcOffset|makeSurfVolOffset|makeSurfWidthOffset|orderRefEventMult|orderRefEventDttm|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|externHedgeExDest|externHedgeParams|firmType|orderCapacity|positionType|ssaleFlag|noCrossGroup|exchTraderId|largeTraderId|tradingLocation|leadSide|maxCompletionSlippage|orderRefPremium|noticeNumber|theoVol|clArriveMark|riskGroupId|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|orderRefRMetric1|orderRefRMetric2|orderRefRMetric3|orderRefRMetric4|orderRefRMetric5|orderRefRMetric6|orderRefRMetric7|expDayWtVegaOffset|maxExpDayWtVegaLn|maxExpDayWtVegaSh|maxExpDayRMetric6Ln|maxExpDayRMetric6Sh|symDayDDeltaOffset|maxSymDayDDeltaLn|maxSymDayDDeltaSh|symDayVegaOffset|maxSymDayVegaLn|maxSymDayVegaSh|symDayWtVegaOffset|maxSymDayWtVegaLn|maxSymDayWtVegaSh|maxSymDayRMetric7Ln|maxSymDayRMetric7Sh|maxGrpDayDDeltaLn|maxGrpDayDDeltaSh|maxGrpDayVegaLn|maxGrpDayVegaSh|maxGrpDayVegaAbs|grpDayVegaRatio|maxGrpDayContractsLn|maxGrpDayContractsSh|maxGrpDayContractsAbs|maxGrpDayRMetric1Ln|maxGrpDayRMetric1Sh|maxGrpDayRMetric1Abs|grpDayRMetric1Ratio|maxGrpDayRMetric2Ln|maxGrpDayRMetric2Sh|maxGrpDayRMetric3Ln|maxGrpDayRMetric3Sh|maxGrpDayRMetric4Ln|maxGrpDayRMetric4Sh|maxGrpDayRMetric5Ln|maxGrpDayRMetric5Sh|symEmaCxlDDeltaLn|symEmaCxlDDeltaSh|symEmaCxlWtVegaLn|symEmaCxlWtVegaSh|lastFillDttm|userData1|userData2|childData|srcTimestamp|sgwTimestamp|timestamp|includeSRNetwork'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'sysEnvironment|runStatus|spdrActionType|parentShape|secType|spdrSource|userSource|orderSide|addCumFillQuantity|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|triggerType|auctionResponder|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minMaxType|spdrStageType|marketSession|startType|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|overrideCode|stateModel|uStateModel|takeAlphaType|makeAlphaType|autoHedge|hedgeInstrument|hedgeScope|hedgeSession|firmType|orderCapacity|positionType|ssaleFlag|leadSide|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|includeSRNetwork'

# 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 = 'altOrderId: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getaggregate' \
--data-urlencode 'msgType=SpdrParentOrder' \
--data-urlencode 'measure=sysEnvironment|runStatus|spdrActionType|parentShape|clientSeqNumIn|altOrderId|altPrevOrderId|altAutoHedgeId|altAccnt|altUserName|srcRoutingCode|packageId|secKey|secType|securityDesc|accnt|clientFirm|spdrSource|groupingCode|execBrkrCode|externExDest|externParams|strategy|userName|userSource|orderDttm|orderSide|orderSize|orderActiveSize|curCumFillQuantity|addCumFillQuantity|maxExposureSize|numMakeExchanges|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|progressSliceCnt|progressExposeTime|vwapParticipation|minMktOnClosePct|triggerType|triggerLevel|auctionResponder|maxMakeExchFee|maxTakeExchFee|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minUBid|maxUAsk|minMaxType|minOptionPx|maxChildOrders|exchMask|spdrStageType|marketSession|startDttm|orderDuration|activeDuration|goodTillDttm|startType|triggerGroupId|triggerTimestamp|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|orderPrcLimit|orderRefUPrc|orderRefDelta|orderRefGamma|orderVolLimit|rateOverride|sdivOverride|ddivOverride|overrideCode|orderPrcOffset|stateModel|uStateModel|takeAlphaType|makeAlphaType|takeAlphaFactor|makeAlphaFactor|takeProbability|makeProbability|takeSurfPrcOffset|takeSurfVolOffset|takeSurfWidthOffset|makeSurfPrcOffset|makeSurfVolOffset|makeSurfWidthOffset|orderRefEventMult|orderRefEventDttm|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|externHedgeExDest|externHedgeParams|firmType|orderCapacity|positionType|ssaleFlag|noCrossGroup|exchTraderId|largeTraderId|tradingLocation|leadSide|maxCompletionSlippage|orderRefPremium|noticeNumber|theoVol|clArriveMark|riskGroupId|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|orderRefRMetric1|orderRefRMetric2|orderRefRMetric3|orderRefRMetric4|orderRefRMetric5|orderRefRMetric6|orderRefRMetric7|expDayWtVegaOffset|maxExpDayWtVegaLn|maxExpDayWtVegaSh|maxExpDayRMetric6Ln|maxExpDayRMetric6Sh|symDayDDeltaOffset|maxSymDayDDeltaLn|maxSymDayDDeltaSh|symDayVegaOffset|maxSymDayVegaLn|maxSymDayVegaSh|symDayWtVegaOffset|maxSymDayWtVegaLn|maxSymDayWtVegaSh|maxSymDayRMetric7Ln|maxSymDayRMetric7Sh|maxGrpDayDDeltaLn|maxGrpDayDDeltaSh|maxGrpDayVegaLn|maxGrpDayVegaSh|maxGrpDayVegaAbs|grpDayVegaRatio|maxGrpDayContractsLn|maxGrpDayContractsSh|maxGrpDayContractsAbs|maxGrpDayRMetric1Ln|maxGrpDayRMetric1Sh|maxGrpDayRMetric1Abs|grpDayRMetric1Ratio|maxGrpDayRMetric2Ln|maxGrpDayRMetric2Sh|maxGrpDayRMetric3Ln|maxGrpDayRMetric3Sh|maxGrpDayRMetric4Ln|maxGrpDayRMetric4Sh|maxGrpDayRMetric5Ln|maxGrpDayRMetric5Sh|symEmaCxlDDeltaLn|symEmaCxlDDeltaSh|symEmaCxlWtVegaLn|symEmaCxlWtVegaSh|lastFillDttm|userData1|userData2|childData|srcTimestamp|sgwTimestamp|timestamp|includeSRNetwork' \
--data-urlencode 'group=sysEnvironment|runStatus|spdrActionType|parentShape|secType|spdrSource|userSource|orderSide|addCumFillQuantity|publicSize|canOverlapCxlRepl|progressRule|blockVisibility|triggerType|auctionResponder|incTakeExchFee|incMakeExchFee|makeExchRule|cxlUPrcRange|minMaxType|spdrStageType|marketSession|startType|parentOrderHandling|parentBalanceHandling|orderLimitType|takeLimitClass|makeLimitClass|takeReachRule|overrideCode|stateModel|uStateModel|takeAlphaType|makeAlphaType|autoHedge|hedgeInstrument|hedgeScope|hedgeSession|firmType|orderCapacity|positionType|ssaleFlag|leadSide|reqAuxRiskGroupCtrl|refRMetric1Src|refRMetric2Src|refRMetric3Src|refRMetric4Src|refRMetric5Src|refRMetric6Src|refRMetric7Src|includeSRNetwork' \
--data-urlencode 'where=altOrderId:eq:ExampleString'

Get Count API Call

Python

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 = 'SpdrParentOrder'

# 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 = 'altOrderId: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getcount' \
--data-urlencode 'msgType=SpdrParentOrder' \
--data-urlencode 'where=altOrderId:eq:ExampleString'