Equity

The generic equity endpoints provide a way to access deal data using a common equity view. All equity deal types can be accessed and only those data fields that are applicable to all equity deal types will be returned.

It is expected that these endpoints are used to provide functionality where searches and data views are required across any equity deal type, for example to show an equity only calendar. Deals cannot be created at the generic level, in order to create deals you must use the relevant deal type endpoint.

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 Deals	Get	/v1/deals/equity	Get all equity deals with optional search criteria

Get Deals

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

Authorization

In order to access the deal information, it is required to have the deals-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
sourceId	string	Querystring	A comma delimited list of source ids to search for	null
criteria	array[object]	Querystring	See Search Criteria	null
accessType	string	Querystring	A comma delimited list of Access Type.	Private
sortField	string	Querystring	See Sort
sortDirection	string	Querystring	See Sort	Asc

Response

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

Schema

The generic equity deal object builds on the generic deal schema described in Generic Deal and extends it with properties that apply to all equity deal types. This deal object structure is shown below, and underneath the json example, each element is described in detail. It is important to note that only the additional fields not in the generic model are shown below, to avoid duplication.

Example json

{
        "equityDealClass": "string",
        "expectedOfferDate": {
                "date": "2019-08-25T10:34:53.189Z",
                "qualifier": "Date"
        },
        "activeValue": {
                "amount": "1MM",
                "type": "Quantity"
        },
        "products": [
                {
                        "offerPrice": 0,
                        "activePrice": 0
                }
        ]
}

Deal Object

equityDealClass

An indicator showing the class of the equity deal. Valid values are IPO or AddOn.

expectedOfferDate

A complex type showing the expected offer date of the deal. For full details see Complex Date Object.

activeValue

Used by Syndicate to relay the most relevant Size at the current Deal State.

Product Object

offerPrice:

The offering price of the security.

activePrice

Used by Syndicate to relay the most relevant Price at the current deal state.