Margin Service API - Portfolio - List

The list portfolios request returns a list of portfolios from the CME CORE database based on search criteria.

Entity	Portfolio
Action	List
URL	`/portfolios`
HTTP Method	`GET`
Parameter Input	Yes
XML Input	No
Multiple Output	Yes
Synchronous	Yes

Description

The request allows the Client to list all portfolios specified which have been added to CME CORE (Add Portfolio and Update Portfolio). The client can optionally submit the search criteria for only the portfolios and not transactions or other data. The server returns all the portfolios matching the search criteria synchronously. When a user specifies a single portfolio ID in the GET portfolios request, only a single portfolio will be returned, matching the CME CORE-assigned portfolio ID.

Request

Parameter	Name	Type	Required
`clrMbrFirmId`	Clearing Member Firm ID	String	No
`custAcctId`	Customer Account ID	String	No
`reqUserId`	Requesting User ID	String	No

Response

XPath	Name	Type	Required
`/portfolioRpt/error@code`	Error Code	String	No
`/portfolioRpt/error@msg`	Error Message	String	No
`/portfolioRpt/portfolio@createTime`	Create Time	Date/Time	Yes
`/portfolioRpt/portfolio@desc`	Description	String	No
`/portfolioRpt/portfolio@id`	Portfolio ID	String	Yes
`/portfolioRpt/portfolio@name`	Name	String	No
`/portfolioRpt/portfolio@rptCcy`	Reporting Currency	String	Yes
`/portfolioRpt/portfolio@updateTime`	Update Time	Date/Time	Yes
`/portfolioRpt/portfolio/entities@clrMbrFirmId`	Clearing Member Firm ID	String	Yes
`/portfolioRpt/portfolio/entities@custAcctId`	Customer Account ID	String	Yes

Errors

Code	Description
`400`	Bad XML syntax or missing content. More information will be provided in the error message.
`500`	The server was not able to process the request. More information (if available) will be provided in the error message.

Examples

Valid

This request queries for all portfolios. Two portfolios exist in the CME CORE database.

Request

GET /portfolios

Response

<portfolioRpt status="SUCCESS">
  <portfolio id="12" name="My Name" desc="My Desc" rptCcy="USD" createTime="2012-12-20 13:12:01" updateTime="2012-12-20 13:14:22">
    <entities clrMbrFirmId="123" custAcctId="ABC" /> 
  </portfolio>
  <portfolio id="13" name="My Other Name" desc="My Other Desc" rptCcy="USD" createTime="2012-12-20 13:13:01" updateTime="2012-12-20 13:13:01">
    <entities clrMbrFirmId="123" custAcctId="DEF" /> 
  </portfolio>
</portfolioRpt>

Valid

Request

This request queries for a single portfolio with Portfolio ID 12. Only one matching portfolio exists in the CME CORE database.

GET /portfolios/12

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:portfolioRpt 
    xmlns:ns2="http://cmegroup.com/schema/core/1.2" status="SUCCESS">
    <portfolio desc="My Desc" name="My Name" rptCcy="USD" id="12" createTime="2014-11-06T10:15:08+00:00" updateTime="2014-11-06T10:15:08+00:00">
        <entities clrMbrFirmId="My Firm" custAcctId="My Account"/>
    </portfolio>
</ns2:portfolioRpt>