Waterfall API overview
Endpoint URL
https://equity-api.diligentoneplatform.com/api/v2/reports/waterfall
Authentication
The Diligent Equity API uses JSON web token for authentication. The token must be sent in the header of the request.
To get a token, contact our support team at equity@diligent.com.
After you have received the token, add the following text in the header of all requests:
Authorization: Bearer {your token}
Query parameters
|
Name |
Type |
Description |
|---|---|---|
|
docId |
String |
The document ID that identifies the company that is queried. |
|
proceeds |
String |
The total proceeds amount to use for the waterfall calculations. |
|
calculationType (optional) |
String |
The type of calculation to return the results for. The following types are available:
|
|
date (optional) |
String |
The effective date for which the waterfall is calculated. |
|
effectiveScenario (optional) |
String |
Sets the waterfall calculation to include the requested scenario. |
|
groupBy (optional) |
String |
Specifies the way the waterfall results are grouped. You can group by:
|
Example request
curl --location --request GET 'https://equity-api.diligentoneplatform.com/api/v2/reports/waterfall?docId=[DOCUMENT_ID]&proceeds=2602084787.' \
--header 'Authorization: Bearer [API_TOKEN]'
Response fields
General fields
Example response
Note
This example shows only the relevant parts of the response. You can view the example in full here.
"message": {
"details": {
"calculationType": "M&A",
"effectiveDate": "2022-03-21T00:00:00.000Z",
"effectiveScenario": "",
"totalProceeds": 2602084787,
"lastUpdated": "2022-03-03T01:24:13.000Z",
"updatedBy": "email@email.com""
},[...]
|
Name |
Type |
Description |
|---|---|---|
|
calculationType |
String |
The type of calculation. |
|
effectiveDate |
Date |
The effective date of the calculation. |
|
effectiveScenario |
The effective scenario of the calculation. |
|
|
totalProceeds |
Number |
The total proceeds of the calculation. |
|
lastUpdated |
Date |
The date when the cap table was last updated. |
|
updatedBy |
String |
The user who last updated the cap table. |
Holders
Example Response
Note
This example shows only the relevant parts of the response. You can view the example in full here.
[...]
"holders": {
"1": {
"name": "Founder 1",
"group": "Founders",
"firstInvestmentDate": "2018-09-27T00:00:00.000Z",
"irr": 4.794542907622873,
"multiple": 451.740121624701,
"equityHoldings": 23446653.980483208,
"exerciseHoldings": 0,
"optionHoldings": 0
},
"2": {
"name": "Founder 2",
"group": "Founders",
"firstInvestmentDate": "2018-09-27T00:00:00.000Z",
"irr": 4.794542907622873,
"multiple": 451.740121624701,
"equityHoldings": 117233265.38501482,
"exerciseHoldings": 0,
"optionHoldings": 0
},
"3": {
"name": "Founder 3",
"group": "Founders",
"firstInvestmentDate": "2018-09-27T00:00:00.000Z",
"irr": 4.794542907622873,
"multiple": 451.740121624701,
"equityHoldings": 29308316.346253704,
"exerciseHoldings": 0,
"optionHoldings": 0
},
"4": {
"name": "Yellow Investor",
"group": "",
"firstInvestmentDate": "2018-09-27T00:00:00.000Z",
"irr": 4.186782986922514,
"multiple": 273.4067608307973,
"equityHoldings": 631128374.5500396,
"exerciseHoldings": 0,
"optionHoldings": 0
},
"5": {
"name": "Teal Investor",
"group": "",
"firstInvestmentDate": "2018-09-27T00:00:00.000Z",
"irr": 4.794542907622873,
"multiple": 451.740121624701,
"equityHoldings": 54708859.28779415,
"exerciseHoldings": 0,
"optionHoldings": 0
}
}, [...]
|
Name |
Type |
Description |
|---|---|---|
|
name |
String |
The name of the holder. |
|
group |
String |
The group of the holder is in. If the holder is not in any group, this field is empty. |
|
firstInvestmentDate |
Date |
The first investment date for this holder. |
|
irr |
Number |
The IRR percentage for all the investments of the holder. |
|
multiple |
Number |
The multiple for all the investments of the holder. |
|
equityHoldings |
Number |
|
|
exerciseHoldings |
Number |
The total amount of proceeds distributed to this holder from exercised options. |
|
optionHoldings |
Number |
The total amount of proceeds distributed to this holder from options. |
Classes and rounds fields
Example Response
Note
This example shows only the relevant parts of the response. You can view the example in full here.
"classes": {
"0": {
"name": "Common",
"rounds": {
"0": {
"name": "Common",
"holdings": {
"equity": {
"1": {
"shares": 5190297,
"investment": 51902.97,
"exercise": 0,
"proceeds": 23446653.980483208,
"preferences": 0,
"prorata": 23446653.980483208,
"dividend": 0,
"carveout": 0,
"irr": 4.794542907622873,
"multiple": 451.740121624701
},
"2": {
"shares": 25951484,
"investment": 259514.84,
"exercise": 0,
"proceeds": 117233265.38501482,
"preferences": 0,
"prorata": 117233265.38501482,
"dividend": 0,
"carveout": 0,
"irr": 4.794542907622873,
"multiple": 451.740121624701
},
"3": {
"shares": 6487871,
"investment": 64878.71,
"exercise": 0,
"proceeds": 29308316.346253704,
"preferences": 0,
"prorata": 29308316.346253704,
"dividend": 0,
"carveout": 0,
"irr": 4.794542907622873,
"multiple": 451.740121624701
},
"4": {
"shares": 130838613,
"investment": 1308386.1300000001,
"exercise": 0,
"proceeds": 591050509.4982718,
"preferences": 0,
"prorata": 591050509.4982718,
"dividend": 0,
"carveout": 0,
"irr": 4.794542907622873,
"multiple": 451.7401216247009
},
"5": {
"shares": 12110693,
"investment": 121106.93000000001,
"exercise": 0,
"proceeds": 54708859.28779415,
"preferences": 0,
"prorata": 54708859.28779415,
"dividend": 0,
"carveout": 0,
"irr": 4.794542907622873,
"multiple": 451.740121624701
},
"6": {
"shares": 130838613,
"investment": 1308386.1300000001,
"exercise": 0,
"proceeds": 591050509.4982718,
"preferences": 0,
"prorata": 591050509.4982718,
"dividend": 0,
"carveout": 0,
"irr": 4.794542907622873,
"multiple": 451.7401216247009
},
"167": {
"shares": 37629652,
"investment": 376294,
"exercise": 0,
"proceeds": 169988234,
"preferences": 0,
"prorata": 169988234,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 451.74314233019925
}
}
},
"proceeds": 1576786349.7078414,
"shares": 349047223
},
"4": {
"name": "New Note",
"holdings": {
"equity": {
"10": {
"shares": 277734,
"investment": 250000,
"exercise": 0,
"proceeds": 1254635.909393147,
"preferences": 0,
"prorata": 1254635.909393147,
"dividend": 0,
"carveout": 0,
"irr": 0.7319535970372066,
"multiple": 5.018543637572589
}
}
},
"proceeds": 1254635.909393147,
"shares": 277734
},
"5": {
"name": "New warrants issuance",
"holdings": {
"warrant": {
"12": {
"shares": 343101,
"investment": 0,
"exercise": 87147.654,
"proceeds": 1462777.2206955652,
"preferences": 0,
"prorata": 1549924.8746955653,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 0
}
}
},
"proceeds": 1462777.2206955652,
"shares": 343101
},
"6": {
"name": "2019 Equity Incentive Plan",
"holdings": {
"options": {
"13": {
"shares": 3002138,
"investment": 0,
"exercise": 0,
"proceeds": 13561861,
"preferences": 0,
"prorata": 13561861,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 0
},
"14": {
"shares": 428018,
"investment": 0,
"exercise": 0,
"proceeds": 1933529.0337756127,
"preferences": 0,
"prorata": 1933529.0337756127,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 0
},
"15": {
"shares": 171207,
"investment": 0,
"exercise": 0,
"proceeds": 773410.7100300018,
"preferences": 0,
"prorata": 773410.7100300018,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 0
},
"16": {
"shares": 856037,
"investment": 0,
"exercise": 0,
"proceeds": 3867062.584952442,
"preferences": 0,
"prorata": 3867062.584952442,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 0
},
"17": {
"shares": 171207,
"investment": 0,
"exercise": 0,
"proceeds": 773410.7100300018,
"preferences": 0,
"prorata": 773410.7100300018,
"dividend": 0,
"carveout": 0,
"irr": 0,
"multiple": 0
}
}
},
"proceeds": 20909274.891329426,
"shares": 4628607
}
},
"proceeds": 1430424802.0175078,
"equityProceeds": 1408052749.9054828,
"equityShares": 311695305
},
|
Name |
Type |
Description |
|---|---|---|
|
classes |
Object |
This object contains details about the classes. |
|
name |
String |
The name of the class. |
|
rounds |
Object |
This object contains details about the rounds. |
|
name |
String |
The name of the round. |
|
holdings |
Object |
This object contains one or more objects of the following list:
Each item in the list is an object itself and contains information about holders and what the amounts distributed to the holder in the round. |
|
shares |
Number |
|
|
investment |
Number |
|
|
exercise |
Number |
|
|
proceeds |
Number |
|
|
preferences |
Number |
|
|
prorata |
Number |
|
|
dividend |
Number |
|
|
carveout |
Number |
|
|
irr |
Number |
|
|
multiple |
Number |
|
|
proceeds |
Number |
The total proceeds distributed in the round. |
|
shares |
Number |
The total shares participated in this round. |
|
equityProceeds |
Number |
|
|
equityShares |
Number |
|
|
classesOrdered |
The order of classes resulted by preference. |
|
|
debt |
Number |
The amount of debt. |
|
additionalBalances |
Number |
The amount of additional balances included in the calculation. |
