GuidesRecipesAPI Reference
Log In
Guides

Asset summary

Asset summary provides the key statistics of an individual asset as of a selected date

Asset summary

API Reference : Get Asset summary

Definition

Asset summary consists of standard fieldsets of output calculation from Quantium CORE.

Output is asset specific as of a selected date.

The following is a list of standard fieldsets returned from Quantium API.

FieldTypeDescription
internalIdstringAsset's unique external identifier
assetIdintegerAsset's internal numeric ID
assetNamestringAsset name
assetLegalNamestringLegal name of the asset
assetSectorNamestringSector classification
assetCountryNamestringCountry of the asset
stockTickerstringStock ticker symbol
fairValueHierachystringFair value hierarchy level
dealIdlongDeal ID. 0 when asset spans multiple deals
dealNamestringDeal name. null when asset spans multiple deals
dealSerialNumberstringDeal serial number. null when asset spans multiple deals
dealCurrencyCodestringNative currency of the deal. null when asset spans multiple deals
entityNamestringName of the investing entity. null when asset spans multiple deals
entityIdintegerID of the investing entity
entityTypestringType of the investing entity
totalInitialInvestmentCostdecimalTotal investment cost(s) of an asset
totalProceedsdecimalTotal investment return (realized gain/loss plus investment cost)
totalRealizedAmountdecimalTotal realized return of an asset
totalRemainingFmvdecimalTotal fair market value of an asset
totalCommitmentReservedecimalTotal committed but not yet invested amount(s)
totalRemainingInvestmentCostdecimalTotal current investment cost. Treat values within ±0.000001 as zero
totalDealExpensedecimalTotal investment-related expenses
totalDealIncomedecimalTotal investment-related income, excluding dividends and interest
totalDividendInterestdecimalTotal dividends and interest of an asset
totalRealizedGainLossdecimalSum of all realized gain/loss from equity/loan sales and income
totalUnrealizedGainLossdecimalSum of all unrealized gain/loss
totalFullyDilitedOwnershipPercentdecimalTotal fully diluted ownership percentage
totalValuedecimalTotal value = proceeds + FMV
totalNumberOfUnitsRemainingdecimal or nullTotal number of units/shares remaining
grossMultipledecimalTotal value / total investment cost
grossIrrdecimalInternal rate of return using all cash flows and FMV as of selected date
isGrossIrrNotAvailablebooleantrue when IRR cannot be calculated
initialDatestringEarliest initial investment date across all deals (YYYY-MM-DD)
initialInvestmentDatestringInitial date of a new deal transaction (YYYY-MM-DD)
investmentRoundsstring[]Aggregated distinct investment rounds across all deals (for example, ["Series A"])
detailsobject[]Per-instrument/tranche breakdown. See the following table.

details[] fields

FieldTypeDescription
instrumentTypestringFor example, Equity or Loan
instrumentSubTypestringFor example, - Preferred shares
descriptionstringDescription
stagestringInvestment stage
initialDatestringInitial date for this tranche (YYYY-MM-DD)
commitmentReservedecimalCommitment reserve
initialInvestmentCostdecimalInitial investment cost
proceedsdecimalProceeds
remainingInvestmentCostdecimalRemaining investment cost
dealExpensedecimalDeal expense
dealIncomedecimalDeal income
dividendInterestdecimalDividend interest
realizedGainLossdecimalRealized gain/loss
unrealizedGainLossdecimalUnrealized gain/loss
fmvdecimalFair market value
numberOfUnitsRemainingdecimalNumber of units/shares remaining
fullyDilutedPercentOwnershipdecimalFully diluted ownership percentage
valuePerUnitdecimalValue per unit
realizedAmountdecimalRealized amount
dealTotalValuedecimalTotal deal value
dealGrossMultipledecimalGross multiple
dealGrossIrrdecimalGross IRR
isGrossIrrNotAvailablebooleantrue when IRR cannot be calculated
investmentRoundsstring[]Investment rounds for this tranche
currencystringCurrency code for this tranche
dealSerialNumbersstring[]Deal serial numbers, populated when the detail row is aggregated across multiple deals
entityNamesstring[]Investing entity names, populated when the detail row is aggregated across multiple deals

Generating asset summary output

HTTP MethodGET
Path/api/summary/asset/{scopeId}/{assetId}/{asOfDate}/{currencyCode}
Request parameters

Scope ID (string): An ID of the selected scope which can be acquired by the [Scope list API]

fundVehicleId: unique ID of fund vehicle

asOfDate: "YYYY-MM'DD" format

currencyCode:

"USD" - USD dollars
"CNY" - Chinese Renminbi

ReferenceAPI Reference : [Get Asset summary]
{
    "internalId": "5faf91c11f339730e48e6ca5",
    "dealId": 0,
    "dealName": null,
    "dealSerialNumber": null,
    "dealCurrencyCode": null,
    "entityName": null,
    "entityId": 0,
    "entityType": null,
    "assetId": 421,
    "assetName": "Asset_1",
    "assetLegalName": null,
    "assetSectorName": null,
    "assetCountryName": null,
    "stockTicker": null,
    "fairValueHierachy": null,
    "totalInitialInvestmentCost": 1000000,
    "totalProceeds": 0.0,
    "totalRealizedAmount": 0.00000000000,
    "totalRemainingFmv": 0.0,
    "totalCommitmentReserve": 0.0,
    "totalRemainingInvestmentCost": 0.0,
    "totalDealExpense": 0.0,
    "totalDealIncome": 0.0,
    "totalDividendInterest": 0.0,
    "totalRealizedGainLoss": 0.0,
    "totalUnrealizedGainLoss": 0.0,
    "totalFullyDilitedOwnershipPercent": 0.0,
    "totalValue": 0.00000000000,
    "initialInvestmentDate": null,
    "grossMultiple": 0.0,
    "grossIrr": 0.0,
    "isGrossIrrNotAvailable": true,
    "totalNumberOfUnitsRemaining": 0.0,
    "ownershipPercent": 0.0,
    "initialDate": "2011-06-26",
    "investmentRounds": [
        "Series A"
    ],
    "details": [
        {
            "assetId": 0,
            "dealId": 0,
            "dealDetailId": 0,
            "trancheInfoId": 0,
            "conversionFromId": null,
            "instrumentType": "Equity",
            "instrumentSubType": " - Preferred shares",
            "description": null,
            "stage": null,
            "initialDate": "2011-06-26",
            "commitmentReserve": 0.0,
            "initialInvestmentCost": 1000000.0,
            "proceeds": 0.0,
            "remainingInvestmentCost": 0.0,
            "dealExpense": 0.0,
            "dealIncome": 0.0,
            "dividendInterest": 0.0,
            "realizedGainLoss": 0.0,
            "unrealizedGainLoss": 0.0,
            "fmv": 0.0,
            "numberOfUnitsRemaining": 0.0,
            "fullyDilutedPercentOwnership": 0.0,
            "valuePerUnit": 0.0,
            "isJointVenture": false,
            "isNotShowNoOfShare": false,
            "isNotShowInvestmentRound": false,
            "transactionId": 0,
            "dealSerialNumbers": [
                "0947",
                "0948"
            ],
            "entityNames": [
                "Fund I",
                "Fund II"
            ],
            "investmentRounds": [
                "Series A"
            ],
            "currency": "usd",
            "uniqueId": null,
            "excludedFromRemainingCostRollup": false,
            "realizedAmount": 0.0,
            "dealTotalValue": 0.0,
            "dealGrossMultiple": 0.0,
            "isGrossIrrNotAvailable": false,
            "dealGrossIrr": 0.0
        }
    ],
    "dealIrrVm": null,
    "isLightView": false
}