Common Stock¶

Common Stock

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 Common Stock Deals	Get	/v1/deals/equity/common-stock	Get all common stock deals with optional search criteria
Get a Common Stock Deal	Get	/v1/deals/equity/common-stock/{id}	Get a specific common stock deal
Create a Common Stock Deal	Post	/v1/deals/equity/common-stock	Create a common stock deal
Update a Common Stock Deal	Put	/v1/deals/equity/common-stock/{id}	Update a specific common stock deal
Update a Common Stock Deal by Source Id	Put	/v1/deals/equity/common-stock	Update a specific common stock deal by source application id
Patch a Common Stock Deal	Patch	/v1/deals/equity/common-stock/{id}	Update a subset of the attributes of an existing Deal
Search For Common Stock Deals	Post	/v1/deals/equity/common-stock/search	Find Common Stock Deals that match a given search criteria
Create Tranches For a Common Stock Deal	Post	/v1/tranches/equity/common-stock	Create a tranche for a common stock deal

Get Common Stock Deals¶

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

See Get Deals

Get a Common Stock Deal¶

The get deal endpoint provides a way of accessing a specific common stock deal object by its id.

See Get Deal

Create a Common Stock Deal¶

The create a common stock deal endpoint provides a way of creating a common stock deal object in the CAS system.

Authorization

In order to create the deal information, it is required to have the deals-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a common stock deal

Response

The endpoint returns a json payload containing a common stock deal object reflecting the deal object that was just created.

Update a Common Stock Deal¶

The update a common stock deal endpoint provides a way of updating a specific common stock deal object given its id.

Authorization

In order to update the deal information, it is required to have the deals-write scope in the access token.

Parameters

Name	Type	Format	Description	Required
id	UUID	URL path	The unique CAS id of the deal to update	Yes

The body of the call to this endpoint is a common stock deal

Response

The endpoint returns a json payload containing a common stock deal object reflecting the deal object that was just updated.

Update a Common Stock Deal by Source Id¶

The update a common stock deal by source id endpoint provides a way of updating a specific common stock deal object given its source application id.

Authorization

In order to update the deal information, it is required to have the deals-write scope in the access token.

Parameters

Name	Type	Format	Description	Required
sourceId	string	Querystring	The source application id of the deal to update	Yes

The body of the call to this endpoint is a common stock deal

Response

The endpoint returns a json payload containing a common stock deal object reflecting the deal object that was just updated.

Patch a Common Stock Deal¶

The patch deal endpoint provides a way of updating specific fields of an existing Deals object.

Authorization

In order to access the Deals information, it is required to have the deals-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a list of fields for the Deals object to be updated.

[
    {
        "value": {},
        "path": "string",
        "op": "string",
        "from": "string"
    }
]

Response

The endpoint returns a JSON payload containing the new, updated Deal Object if successful.

Create Tranches For a Common Stock Deal¶

The create tranche endpoint provides a way of creating one or more tranche objects in the CAS system for an existing common stock deal object in the CAS system.

Authorization

In order to create the tranche information, it is required to have the deals-write scope in the access token.

Parameters

N/A

Response

The endpoint returns a json payload containing one or more Tranche Objects reflecting the objects that were just created.

Search For Common Stock Deals¶

The Search endpoint provides a way of retrieving one or more Common Stock Deals that match the criteria that has been passed by the caller

Authorization

In order to search for Common Stock Deals, it is required to have the deals-read scope in the access token.

Parameters

The body of the incoming call must contain a SearchParameter object that conforms to this schema:

{
    "criteria": {
        "condition": "string",
        "field": "string",
        "operator": "string",
        "value": "string",
        "operands": [
            {
                "condition": "string",
                "field": "string",
                "operator": "string",
                "value": "string",
                "operands": [
                ]
            }
        ]
    },
    "sortFields": [
        {
            "sortField": "string",
            "sortDirection": "string"
        }
    ],
    "page": "integer",
    "pageSize": "integer",
    "projection": "string"
}

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	A Payload Projection that allows a caller to specify the list of fields to be returned in each object in the response.	null
criteria	object	Form Data	See Advanced Search Criteria	null
sortFields	array[object]	Form Data	Sorts the search results using specified columns in the data.	null

Response

The endpoint returns a json payload containing one or more Common Stock Deal Objects reflecting the objects that match the given search criteria.

{
    "items": [
    ],
    "sortFields": [
        {
            "sortField": "string",
            "sortDirection": "string"
        }
    ],
    "total": "integer",
    "page": "integer",
    "pageSize": "integer"
}

Name	Type	Description	Default
total	integer	Returns the total number of deals that match the given search criteria. This can be more than the maximum number of items on a page	1
page	integer	Returns the number of the page that the caller requested, or the Default if the caller did not specify a page number in their request	1
pageSize	integer	Returns the maximum number of items that can be contained on a page of results. As specified by the caller, or by the Default if the caller has not specified a pageSize in their request	250
items	array[object]	The list of common stock deals that match the given search criteria. This can be empty if there are no matches to the search criteria.	NA NA

Schema¶

The common stock deal object builds on the equity deal schema described in Equity and extends it with properties that apply to all common stock deals only. 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 common equity model are shown below, to avoid duplication.

Example json

{

  "launchPrice": 0,
  "filePrice": 0,
  "initialFileRangeLow": 0,
  "initialFileRangeHigh": 0,
  "revisedFileRangeLow": 0,
  "revisedFileRangeHigh": 0,
  "priceTalk": "string"
}

launchPrice: The price at which the security is expected to Launch.
filePrice: The price at which the security offer will be.
initialFileRangeLow: The Lower End of the Price Range at which the product is filed.
initialFileRangeHigh: The Higher End of the Price Range at which the product is filed.
revisedFileRangeLow: An updated Lower End of the Price Range at which the product is filed.
revisedFileRangeHigh: An updated Higher End of the Price Range at which the product is filed.
priceTalk: Discussion on the appropriate range of prices for a new security before it is issued.