GET v1/Entities/SummarySimpleFormat/
The same as Summary but returns data in the legacy XML API service compatible format for a given point in time.
Request Information
Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| request | EntityGetSummarySimpleFormatRequest | Container for the Entity Summary Request input parameters. See parameter details below. |
Define this parameter in the request URI. |
Parameter Information
Parameter Name: request
| Property | Type | Description |
|---|---|---|
| Id | String | The PID of the Entity. |
| PointInTime | Nullable`1 | The date for which you want to retrieve data. Optional. If not specified, will use current. |
| SdkVersion | String | If the client is using the SDK, the version number will be passed along with the request. This field is optional. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"edfType": "sample string 1",
"mkmvid": "sample string 2",
"sic": "sample string 3",
"assetVolatility": 1.0,
"commonEquity": 1.0,
"commonDividends": 1.0,
"creditCategory": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"currency": "sample string 4",
"currentDebt": 1.0,
"currentLiabilities": 1.0,
"debtDueYear2": 1.0,
"debtDueYear3": 1.0,
"debtDueYear4": 1.0,
"debtDueYear5": 1.0,
"defaultPoint": 1.0,
"deferredTax": 1.0,
"edf": [
1.1,
2.1,
3.1
],
"equityVolatility": 1.0,
"industryWeights": [
{
"code": "sample string 1",
"name": "sample string 2",
"weight": 3.1
},
{
"code": "sample string 1",
"name": "sample string 2",
"weight": 3.1
},
{
"code": "sample string 1",
"name": "sample string 2",
"weight": 3.1
}
],
"inputDate": "2026-06-05T15:02:08.1806569+00:00",
"longTermDebt": 1.0,
"longTermLiability": 1.0,
"marketCapital": 1.0,
"marketLeverage": 1.0,
"marketValueOfAssets": 1.0,
"minorInterest": 1.0,
"moodysRating": "sample string 5",
"moodysRatingDate": "2026-06-05T15:02:08.1806569+00:00",
"otherLiabilities": 1.0,
"preferredDividends": 1.0,
"preferredStock": 1.0,
"primaryCountry": "sample string 6",
"primaryIndustry": "sample string 7",
"retainedEarnings": 1.0,
"shareEquivalent": 1.0,
"shareOutstanding": 1.0,
"sharePrice": 1.0,
"shortTermLiability": 1.0,
"snpRating": "sample string 8",
"snpRatingDate": "2026-06-05T15:02:08.1806569+00:00",
"statementDate": "2026-06-05T15:02:08.1806569+00:00",
"totalAdjustedLiability": 1.0,
"totalLiability": 1.0,
"tradingDate": "2026-06-05T15:02:08.1806569+00:00",
"errorOccurred": false,
"errorMessages": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"request": {
"id": "sample string 1",
"pointInTime": "2026-06-05T15:02:08.1806569+00:00",
"sdkVersion": "sample string 2"
}
}
application/xml, text/xml
Sample:
<EntityGetSummarySimpleFormatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</ErrorMessages>
<ErrorOccurred>false</ErrorOccurred>
<Request>
<SdkVersion>sample string 2</SdkVersion>
<Id>sample string 1</Id>
<PointInTime>2026-06-05T15:02:08.1806569+00:00</PointInTime>
</Request>
<AssetVolatility>1</AssetVolatility>
<CommonDividends>1</CommonDividends>
<CommonEquity>1</CommonEquity>
<CreditCategory xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
<d2p1:string>sample string 3</d2p1:string>
</CreditCategory>
<Currency>sample string 4</Currency>
<CurrentDebt>1</CurrentDebt>
<CurrentLiabilities>1</CurrentLiabilities>
<DebtDueYear2>1</DebtDueYear2>
<DebtDueYear3>1</DebtDueYear3>
<DebtDueYear4>1</DebtDueYear4>
<DebtDueYear5>1</DebtDueYear5>
<DefaultPoint>1</DefaultPoint>
<DeferredTax>1</DeferredTax>
<EDFType>sample string 1</EDFType>
<Edf xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:double>1.1</d2p1:double>
<d2p1:double>2.1</d2p1:double>
<d2p1:double>3.1</d2p1:double>
</Edf>
<EquityVolatility>1</EquityVolatility>
<InputDate>2026-06-05T15:02:08.1806569+00:00</InputDate>
<LongTermDebt>1</LongTermDebt>
<LongTermLiability>1</LongTermLiability>
<MKMVID>sample string 2</MKMVID>
<MarketCapital>1</MarketCapital>
<MarketLeverage>1</MarketLeverage>
<MarketValueOfAssets>1</MarketValueOfAssets>
<MinorInterest>1</MinorInterest>
<MoodysRating>sample string 5</MoodysRating>
<MoodysRatingDate>2026-06-05T15:02:08.1806569+00:00</MoodysRatingDate>
<OtherLiabilities>1</OtherLiabilities>
<PreferredDividends>1</PreferredDividends>
<PreferredStock>1</PreferredStock>
<PrimaryCountry>sample string 6</PrimaryCountry>
<PrimaryIndustry>sample string 7</PrimaryIndustry>
<RetainedEarnings>1</RetainedEarnings>
<SIC>sample string 3</SIC>
<ShareEquivalent>1</ShareEquivalent>
<ShareOutstanding>1</ShareOutstanding>
<SharePrice>1</SharePrice>
<ShortTermLiability>1</ShortTermLiability>
<SnPRating>sample string 8</SnPRating>
<SnPRatingDate>2026-06-05T15:02:08.1806569+00:00</SnPRatingDate>
<StatementDate>2026-06-05T15:02:08.1806569+00:00</StatementDate>
<TotalAdjustedLiability>1</TotalAdjustedLiability>
<TotalLiability>1</TotalLiability>
<TradingDate>2026-06-05T15:02:08.1806569+00:00</TradingDate>
<industryWeights>
<Industry>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Weight>3.1</Weight>
</Industry>
<Industry>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Weight>3.1</Weight>
</Industry>
<Industry>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Weight>3.1</Weight>
</Industry>
</industryWeights>
</EntityGetSummarySimpleFormatResponse>