MUNI Client Data API¶

This API is meant to give insight to Firms on what deals their users are participating in on the MUNI Deal Monitor UI. It will provide data on various forms of deal following, internal metrics, comments as well as some basic deal data.

API Endpoints¶

The full list of available API endpoints is show below, with links to the detailed documentation for each. For a concise, structured definition please reference the Swagger/Open API specification.

Name	Method	Url	Description
Get client data	Get	/v1/deals/fixed-income/municipal/client-data	Get client data deals with optional search criteria

Get client data¶

The get client data endpoint provides a way of accessing a collection of client data deal objects based on the input parameters.

Authorization¶

In order to access the deal information, it is required to have the buyside-muni-deals-client-data-read scope in the access token.

Parameters¶

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Querystring	See Pagination	1
pageSize	integer	Querystring	See Pagination	250
criteria	array[object]	Querystring	See Search Criteria	null

If no search criteria present, deals for the current week will be returned.

Response¶

The endpoint returns a json payload containing an paginated array of Client Data Deal Object. The pagination is in the standard CAS format as described in Pagination.

Example Search Criteria¶

The table below shows some example search criteria used for client data deals search to show how the search criteria can be used for some common workflows: (Please note, these queries must be URL encoded before use - they are shown without encoding for readability).

Description	Query
Filter for deals with global ID	?criteria=[{“field”:”GlobalId”,”operator”:”In”,”value”:[“12345”]}]
Deals in date range (1-7 days)	?criteria=[[{“field”:”StartDate”,”operator”:”=”,”value”:”2020-08-17”}, {“field”:”EndDate”,”operator”:”=”,”value”:”2020-08-22”}]]
WeekOf deals for a given week	?criteria=[{“field”:”WeekOf”,”operator”:”=”,”value”:”2020-08-17”}]

Schema¶

Example json¶

{
       "id": "39f389c5-f152-8627-f5db-e8527543033b",
       "globalId": "718a5a57-5522-4928-a7db-cc325b351e89",
       "description": "City of Westlake, Ohio\r\nGeneral Obligation Limited Tax Community Services Center Improvement Bond Anticipation Notes, Series 2020",
       "methodOfSale": "Negotiated",
       "amount": 1000000000.0,
       "leadManager": "Test Customer for PC5",
       "state": "AZ",
       "issuer": "Test Issuer",
       "obligor": null,
       "isGroupFollowed": true,
       "comments": [
           {
               "content": "string",
               "createdByName": "string",
               "createdByRole": null,
               "creationDate": "2020-07-27T09:04:16.5115+00:00"
           }
       ],
       "followers": [
           {
               "firstName": "string",
               "lastName": "string"
           }
       ],
       "assignedUsers": [
           {
               "firstName": "string",
               "lastName": "string",
               "role": "string",
               "assignedBy": "string"
           }
       ],
       "metrics": {
           "internalRating": "AAA",
           "internalScore": "12",
           "internalStatus": "Approved",
           "hasOwnership": false
       }
   }

Client Data Deal Object¶

id: Unique ID Used to Identify deal within CAS Database.
globalId: Unique ID used to Identify deal on the Buyside.
description: The Name of the deal.
methodOfSale: Deal type. Valid values are Competitive, Negotiated.
amount: Deal Size.
leadManager: Name of the Lead Manager for the deal.
state: State of the US.
issuer: Issuer Name.
obligor: The Bond Issuer who is contractually obligated to pay any outstanding payments related to the security.
isGroupFollowed: This indicator is used to convey whether or not the deal is group followed.

Comment Object¶

content: Comment body.
createdByName: Full name of the user who has created comment.
createdByRole: Role of the user who has created comment.
creationDate: The date of the comment creation.

Follower Object¶

firstName: First name of the user in the company who is following the deal.
lastName: Last name of the user in the company who is following the deal.

Assigned User Object¶

firstName: First name of the user assigned to the deal.
lastName: Last name of the user assigned to the deal.
role: User role.
assignedBy: Full name of the user who has assigned current user to the deal.

Metrics Object¶

internalRating: What the Buyside firm believes the Issue Rating to be for the deal internally.
internalScore: An open-ended internal scoring schema to be used by a firm.
internalStatus: Portrays where the deal sits in the Buyside firm’s analysis cycle as it pertains to whether or not there is approval to participate in the deal.
hasOwnership: This indicator is used to record whether or not the Buyside Firm already has ownership (a position) with the Issuer of the Deal.