Page tree
Skip to end of metadata
Go to start of metadata
The list margins request returns the status and results of margin requests based on query parameters.

 

EntityMargin
ActionGet
URL/margins
HTTP MethodGET
Parameter InputYes
XML InputNo
Multiple OutputYes
SynchronousYes

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

ParameterNameTypeRequiredNotes
portfolioIdPortfolio IDStringNo 
reqUserIdRequesting User IDStringNo 

Response

XPathNameTypeRequiredNotes
/marginRpt@statusStatusAsync StatusYes 
/marginRpt/error@codeError CodeStringNo 
/marginRpt/error@msgError MessageStringNo 
/marginRpt/margin@asOfTimeAs-of TimeDate/TimeNo 
/marginRpt/margin@createTimeCreate TimeDate/TimeYes 
/marginRpt/margin@idIDStringYes 
/marginRpt/margin@portfolioIdPortfolio IDStringYes 
/marginRpt/margin@settleQualSettlement QualiferSettlement QualiferNo 
/marginRpt/margin@settleIndSettlement IndicatorSettlement IndicatorNo 
/marginRpt/margin@updateTimeUpdate TimeDate/TimeYes 
/marginRpt/margin/amounts@ccyAmount CurrencyCurrencyYes 
/marginRpt/margin/amounts@concConcentration AmountDecimalYes 
/marginRpt/margin/amounts@initInitial Margin AmountDecimalYes 
/marginRpt/margin/amounts@maintMaintenance Margin AmountDecimal Yes 
/marginRpt/margin/amounts@nonOptValNon-option Value AmountDecimal Yes 
/marginRpt/margin/amounts@optValOption Value AmountDecimal Yes 
/marginRpt/margin/amounts/scPt@amtScenario Point AmountDecimalNo 

Errors

CodeDescription
403Returned if the user does not have permission to access the specified margin.
500The 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>
  • No labels