CashPro Developer Studio API details

Global Markets – Get Portfolio

Muni Bond Portfolio Services API 2 of 2: Allows a user to retrieve a Muni portfolio through Muni services. This API would be called after a call of the Create Portfolio API.

Method
post
Endpoint
/muni/v1/portfolio/getPortfolio
Parameter type
application/json

Request parameters

Info messageBelow are sample parameters. After access is granted, a full set of parameters will be shared.
Parameter nameDescription

Content-Type

(Header, required)
Identify the content of the payload as JSON. Use 'Content-Type: application/json'. This is the only content type supported as of now. Content-Types cannot be negotiated programmatically at this time. Future versions might provide that facility

Authorization

(Header, required)
A unique access token to be used for a single request (ex. “Bearer [value])

userId

(Header, required)
User who is interacting with this service from a company. User should be on boarded on the Bofa Securities Mercury™ platform and obtain userId

clientRequestId

(Header, required)
A token provided by client to identify their request
{
 "portfolioName": "MyCustomPortfolio 1.0",
 "token": "9572d7f4e812df12cd8c0d26e7308864c33cbb51b004cbe962ad545bc377a4a2"
}

Responses

Response code (12)
{
 "clientRequestId": "4a251a2ef9bbf4ccc35f97aba2c9cbda",
 "errorMessage": null,
 "portfolio": {
  "analytics": "{'parValue': 930000, 'principalValue,: 989136.799,'accruedInterest': 7298.611,'portfolioValue': 996435.411,'annualIncome':45350,'averageMaturity': {'dateStr':2021/11/23},'averagePrice':106.532,'averageYTW': 2.165, 'averageYTM': 2.165 }",
  "createdTime": "1567528206380",
  "holdingsAccountNumber": null,
  "modifiedTime": "1567528206380",
  "optimizerCriteria": null,
  "optimizerGenerated": true,
  "portfolioName": "MyCustomPortfolio 1.0",
  "portfolioType": "My Active",
  "productionCredit": null,
  "userId": "user123",
  "username": "john bob"
 },
 "portfolioName": "MyCustomPortfolio 1.0",
 "status": "COMPLETED",
 "token": "9572d7f4e812df12cd8c0d26e7308864c33cbb51b004cbe962ad545bc377a4a2"
}