Margin Service API - Margin - List

The list margins request returns the status and results of margin requests based on query parameters.

Entity	Margin
Action	Get
URL	`/margins`
HTTP Method	`GET`
Parameter Input	Yes
XML Input	No
Multiple Output	Yes
Synchronous	Yes

Description

The purpose of this request is to allow the client to list the margins of the specified portfolios which have been added and margined previously in CME CORE on the current date (Add Portfolio and Calculate Margin). Here the Client must submit the query criteria (portfolio identifiers,margin type, etc.) An error is sent back if applicable otherwise the identifier along with the status and the results for all matching requests is returned back.

Request

Parameter	Name	Type	Required	Notes
`portfolioId`	Portfolio ID	String	No
`reqUserId`	Requesting User ID	String	No

Response

XPath	Name	Type	Required
`/marginRpt@status`	Status	Async Status	Yes
`/marginRpt/error@code`	Error Code	String	No
`/marginRpt/error@msg`	Error Message	String	No
`/marginRpt/margin@asOfTime`	As-of Time	Date/Time	No
`/marginRpt/margin@createTime`	Create Time	Date/Time	Yes
`/marginRpt/margin@id`	ID	String	Yes
`/marginRpt/margin@portfolioId`	Portfolio ID	String	Yes
`/marginRpt/margin@settleQual`	Settlement Qualifer	Settlement Qualifer	No
`/marginRpt/margin@settleInd`	Settlement Indicator	Settlement Indicator	No
`/marginRpt/margin@updateTime`	Update Time	Date/Time	Yes
`/marginRpt/margin/amounts@ccy`	Amount Currency	Currency	Yes
`/marginRpt/margin/amounts@conc`	Concentration Amount	Decimal	Yes
`/marginRpt/margin/amounts@init`	Initial Margin Amount	Decimal	Yes
`/marginRpt/margin/amounts@maint`	Maintenance Margin Amount	Decimal	Yes
`/marginRpt/margin/amounts@nonOptVal`	Non-option Value Amount	Decimal	Yes
`/marginRpt/margin/amounts@optVal`	Option Value Amount	Decimal	Yes
`/marginRpt/margin/amounts/scPt@amt`	Scenario Point Amount	Decimal	No

Errors

Code	Description
`403`	Returned if the user does not have permission to access the specified margin.
`500`	The server was not able to process the request. More information (if available) will be provided in the error message.

Examples

Basic

Request

GET /margins?portfolioId=123

Response

<marginRpt>
  <margin id="123" portfolioId="1234" asOfTime="2013-01-02 13:23:01" settleQual="FINAL" settleInd="N" createTime="2013-01-02 14:24:32" updateTime="2013-01-02 14:24:32">
    <amounts ccy="USD" conc="123.45" init="234.56" maint="234.56" nonOptVal="345.67" optVal="456.78" />
  </margin>
  <margin id="124" portfolioId="1234" asOfTime="2013-01-02 13:23:01" settleQual="FINAL" settleInd="N" createTime="2013-01-02 16:24:32" updateTime="2013-01-02 16:24:32">
    <amounts ccy="USD" conc="1123.45" init="1234.56" maint="1234.56" nonOptVal="1345.67" optVal="1456.78">
      <scPt amt="123.45" />
      <scPt amt="234.56" />
      <!-- Snip 1,255 entries -->
      <scPt amt="345.67" />
      <scPt amt="456.78" />
      <scPt amt="567.89" />
    </amounts>
  </margin>
</marginRpt>