GET v1/Entities/CAEScenarios/
Retrieves climate adjusted credit risk scenarios for a given entity.
Request Information
Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| request | EntityGetCAERequest | Container for the Entity Climate Adjusted EDf 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 ID - Identifier of the entity of the Entity. Identifiers are case insenstitive. |
| IdType | String | Specifies the type of entity identifier to search for. This field is optional. If not specified, then PID is assumed.
Identifier types are case insenstitive. The following types can be used: PID Name, or CompanyName Cusip, or EquityCusip ISIN, or EquityISIN Ticker Ticker and Exchange, specify query value in Ticker@Exchange format Sedol LEI FiGi, or Bloomberg MoodysOrgID, Moody's organization identifier can be used with rated entities BvdID - both Bvd9 and BvdCompanyId can be used |
| PointInTime | Nullable`1 | RESERVED FOR FUTURE USE. Do not specify this parameter. |
| UserId | Nullable`1 | The user identifier - Identifier of the creditEdge user. |
| ScenarioCategory | String | Gets or sets the scenario category. |
| ResultDetailMain | Boolean | Shows to the users the main Climate EDF drivers. Possible values; true/false |
| ResultDetailTransition | Boolean | Shows to the users additional drivers to explain the transition risk side of the climate adjustment. Possible values; true/false |
| 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:
{
"results": [
{
"baseline": {
"edf": [
1.0,
2.0,
3.0
],
"impliedRating": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"fvs": 1.0,
"bondPrice": 2.0,
"bondDuration": 3.0
},
"physicalRisk": null,
"transitionRisk": null,
"combinedRisk": null,
"entity": {
"id": "sample string 1",
"name": "sample string 2",
"organizationType": "Public",
"organizationEntityType": "sample string 3",
"organizationEntityRatioType": "sample string 4",
"tickerSymbol": "sample string 5",
"tickerExchange": "sample string 6",
"countryCode": "sample string 7",
"industryCode": "sample string 8",
"sector": "sample string 9",
"sectorCode": "sample string 10",
"sicCode": "sample string 11",
"naicsCode": "sample string 12",
"naicsText": "sample string 13",
"cusip": "sample string 14",
"moodysOrgId": "sample string 15",
"industryName": "sample string 16",
"countryName": "sample string 17",
"regionCode": "sample string 18",
"address": "sample string 19",
"isin": "sample string 20",
"reutersId": "sample string 21",
"sicName": "sample string 22",
"sectorName": "sample string 23",
"regionName": "sample string 24",
"region": "sample string 25",
"requiresSubscription": false,
"cincCode": 27,
"sedol": "sample string 28",
"figi": "sample string 29",
"lei": "sample string 30",
"corporateInstitutionGroupId": "sample string 31",
"financialInstitutionGroupId": "sample string 32",
"hasQuarterlyFinancials": false,
"hasAnnualFinancials": false,
"hasSemiAnnualFinancials": false,
"impliedRatingEntityType": "Corporation",
"pageHitCount": 36,
"lastEDFDate": "2026-06-05T14:54:06.953666+00:00",
"bvdId": "sample string 38",
"bvdName": "sample string 39",
"dataErrorType": "None",
"dataErrorMessage": "sample string 40"
},
"edfDate": "2026-06-05T14:54:06.953666+00:00",
"requiresSubscription": false,
"resultData": [
{},
{},
{}
]
},
{
"baseline": {
"edf": [
1.0,
2.0,
3.0
],
"impliedRating": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"fvs": 1.0,
"bondPrice": 2.0,
"bondDuration": 3.0
},
"physicalRisk": null,
"transitionRisk": null,
"combinedRisk": null,
"entity": {
"id": "sample string 1",
"name": "sample string 2",
"organizationType": "Public",
"organizationEntityType": "sample string 3",
"organizationEntityRatioType": "sample string 4",
"tickerSymbol": "sample string 5",
"tickerExchange": "sample string 6",
"countryCode": "sample string 7",
"industryCode": "sample string 8",
"sector": "sample string 9",
"sectorCode": "sample string 10",
"sicCode": "sample string 11",
"naicsCode": "sample string 12",
"naicsText": "sample string 13",
"cusip": "sample string 14",
"moodysOrgId": "sample string 15",
"industryName": "sample string 16",
"countryName": "sample string 17",
"regionCode": "sample string 18",
"address": "sample string 19",
"isin": "sample string 20",
"reutersId": "sample string 21",
"sicName": "sample string 22",
"sectorName": "sample string 23",
"regionName": "sample string 24",
"region": "sample string 25",
"requiresSubscription": false,
"cincCode": 27,
"sedol": "sample string 28",
"figi": "sample string 29",
"lei": "sample string 30",
"corporateInstitutionGroupId": "sample string 31",
"financialInstitutionGroupId": "sample string 32",
"hasQuarterlyFinancials": false,
"hasAnnualFinancials": false,
"hasSemiAnnualFinancials": false,
"impliedRatingEntityType": "Corporation",
"pageHitCount": 36,
"lastEDFDate": "2026-06-05T14:54:06.953666+00:00",
"bvdId": "sample string 38",
"bvdName": "sample string 39",
"dataErrorType": "None",
"dataErrorMessage": "sample string 40"
},
"edfDate": "2026-06-05T14:54:06.953666+00:00",
"requiresSubscription": false,
"resultData": [
{},
{},
{}
]
},
{
"baseline": {
"edf": [
1.0,
2.0,
3.0
],
"impliedRating": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"fvs": 1.0,
"bondPrice": 2.0,
"bondDuration": 3.0
},
"physicalRisk": null,
"transitionRisk": null,
"combinedRisk": null,
"entity": {
"id": "sample string 1",
"name": "sample string 2",
"organizationType": "Public",
"organizationEntityType": "sample string 3",
"organizationEntityRatioType": "sample string 4",
"tickerSymbol": "sample string 5",
"tickerExchange": "sample string 6",
"countryCode": "sample string 7",
"industryCode": "sample string 8",
"sector": "sample string 9",
"sectorCode": "sample string 10",
"sicCode": "sample string 11",
"naicsCode": "sample string 12",
"naicsText": "sample string 13",
"cusip": "sample string 14",
"moodysOrgId": "sample string 15",
"industryName": "sample string 16",
"countryName": "sample string 17",
"regionCode": "sample string 18",
"address": "sample string 19",
"isin": "sample string 20",
"reutersId": "sample string 21",
"sicName": "sample string 22",
"sectorName": "sample string 23",
"regionName": "sample string 24",
"region": "sample string 25",
"requiresSubscription": false,
"cincCode": 27,
"sedol": "sample string 28",
"figi": "sample string 29",
"lei": "sample string 30",
"corporateInstitutionGroupId": "sample string 31",
"financialInstitutionGroupId": "sample string 32",
"hasQuarterlyFinancials": false,
"hasAnnualFinancials": false,
"hasSemiAnnualFinancials": false,
"impliedRatingEntityType": "Corporation",
"pageHitCount": 36,
"lastEDFDate": "2026-06-05T14:54:06.953666+00:00",
"bvdId": "sample string 38",
"bvdName": "sample string 39",
"dataErrorType": "None",
"dataErrorMessage": "sample string 40"
},
"edfDate": "2026-06-05T14:54:06.953666+00:00",
"requiresSubscription": false,
"resultData": [
{},
{},
{}
]
}
],
"errorOccurred": false,
"errorMessages": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"request": {
"id": "sample string 1",
"idType": "sample string 2",
"pointInTime": "2026-06-05T14:54:06.953666+00:00",
"userId": 1,
"scenarioCategory": "sample string 3",
"resultDetailMain": false,
"resultDetailTransition": false,
"sdkVersion": "sample string 6"
}
}
application/xml, text/xml
Sample:
<EntityGetCAEResponse 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 6</SdkVersion>
<Id>sample string 1</Id>
<IdType>sample string 2</IdType>
<PointInTime>2026-06-05T14:54:06.953666+00:00</PointInTime>
<ResultDetailMain>false</ResultDetailMain>
<ResultDetailTransition>false</ResultDetailTransition>
<ScenarioCategory>sample string 3</ScenarioCategory>
<UserId>1</UserId>
</Request>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.ClimateAdjustedEdf">
<d2p1:EntityCAEScenariosResult>
<d2p1:Baseline>
<d2p1:BondDuration>3</d2p1:BondDuration>
<d2p1:BondPrice>2</d2p1:BondPrice>
<d2p1:Edf xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:decimal>1</d5p1:decimal>
<d5p1:decimal>2</d5p1:decimal>
<d5p1:decimal>3</d5p1:decimal>
</d2p1:Edf>
<d2p1:Fvs>1</d2p1:Fvs>
<d2p1:ImpliedRating xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
<d5p1:string>sample string 3</d5p1:string>
</d2p1:ImpliedRating>
</d2p1:Baseline>
<d2p1:CombinedRisk i:nil="true" />
<d2p1:EdfDate>2026-06-05T14:54:06.953666+00:00</d2p1:EdfDate>
<d2p1:Entity xmlns:d4p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects">
<DataErrorMessage xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.Abstract">sample string 40</DataErrorMessage>
<DataErrorType xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.Abstract">None</DataErrorType>
<d4p1:Address>sample string 19</d4p1:Address>
<d4p1:BvDId>sample string 38</d4p1:BvDId>
<d4p1:BvDName>sample string 39</d4p1:BvDName>
<d4p1:CincCode>27</d4p1:CincCode>
<d4p1:CorporateInstitutionGroupId>sample string 31</d4p1:CorporateInstitutionGroupId>
<d4p1:CountryCode>sample string 7</d4p1:CountryCode>
<d4p1:CountryName>sample string 17</d4p1:CountryName>
<d4p1:Cusip>sample string 14</d4p1:Cusip>
<d4p1:Figi>sample string 29</d4p1:Figi>
<d4p1:FinancialInstitutionGroupId>sample string 32</d4p1:FinancialInstitutionGroupId>
<d4p1:HasAnnualFinancials>false</d4p1:HasAnnualFinancials>
<d4p1:HasQuarterlyFinancials>false</d4p1:HasQuarterlyFinancials>
<d4p1:HasSemiAnnualFinancials>false</d4p1:HasSemiAnnualFinancials>
<d4p1:Id>sample string 1</d4p1:Id>
<d4p1:ImpliedRatingEntityType>Corporation</d4p1:ImpliedRatingEntityType>
<d4p1:IndustryCode>sample string 8</d4p1:IndustryCode>
<d4p1:IndustryName>sample string 16</d4p1:IndustryName>
<d4p1:Isin>sample string 20</d4p1:Isin>
<d4p1:LastEDFDate>2026-06-05T14:54:06.953666+00:00</d4p1:LastEDFDate>
<d4p1:Lei>sample string 30</d4p1:Lei>
<d4p1:MoodysOrgId>sample string 15</d4p1:MoodysOrgId>
<d4p1:NaicsCode>sample string 12</d4p1:NaicsCode>
<d4p1:NaicsText>sample string 13</d4p1:NaicsText>
<d4p1:Name>sample string 2</d4p1:Name>
<d4p1:OrganizationEntityRatioType>sample string 4</d4p1:OrganizationEntityRatioType>
<d4p1:OrganizationEntityType>sample string 3</d4p1:OrganizationEntityType>
<d4p1:OrganizationType>Public</d4p1:OrganizationType>
<d4p1:PageHitCount>36</d4p1:PageHitCount>
<d4p1:Region>sample string 25</d4p1:Region>
<d4p1:RegionCode>sample string 18</d4p1:RegionCode>
<d4p1:RegionName>sample string 24</d4p1:RegionName>
<d4p1:RequiresSubscription>false</d4p1:RequiresSubscription>
<d4p1:ReutersId>sample string 21</d4p1:ReutersId>
<d4p1:Sector>sample string 9</d4p1:Sector>
<d4p1:SectorCode>sample string 10</d4p1:SectorCode>
<d4p1:SectorName>sample string 23</d4p1:SectorName>
<d4p1:Sedol>sample string 28</d4p1:Sedol>
<d4p1:SicCode>sample string 11</d4p1:SicCode>
<d4p1:SicName>sample string 22</d4p1:SicName>
<d4p1:TickerExchange>sample string 6</d4p1:TickerExchange>
<d4p1:TickerSymbol>sample string 5</d4p1:TickerSymbol>
</d2p1:Entity>
<d2p1:PhysicalRisk i:nil="true" />
<d2p1:RequiresSubscription>false</d2p1:RequiresSubscription>
<d2p1:ResultData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
<d4p1:anyType />
</d2p1:ResultData>
<d2p1:TransitionRisk i:nil="true" />
</d2p1:EntityCAEScenariosResult>
<d2p1:EntityCAEScenariosResult>
<d2p1:Baseline>
<d2p1:BondDuration>3</d2p1:BondDuration>
<d2p1:BondPrice>2</d2p1:BondPrice>
<d2p1:Edf xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:decimal>1</d5p1:decimal>
<d5p1:decimal>2</d5p1:decimal>
<d5p1:decimal>3</d5p1:decimal>
</d2p1:Edf>
<d2p1:Fvs>1</d2p1:Fvs>
<d2p1:ImpliedRating xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
<d5p1:string>sample string 3</d5p1:string>
</d2p1:ImpliedRating>
</d2p1:Baseline>
<d2p1:CombinedRisk i:nil="true" />
<d2p1:EdfDate>2026-06-05T14:54:06.953666+00:00</d2p1:EdfDate>
<d2p1:Entity xmlns:d4p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects">
<DataErrorMessage xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.Abstract">sample string 40</DataErrorMessage>
<DataErrorType xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.Abstract">None</DataErrorType>
<d4p1:Address>sample string 19</d4p1:Address>
<d4p1:BvDId>sample string 38</d4p1:BvDId>
<d4p1:BvDName>sample string 39</d4p1:BvDName>
<d4p1:CincCode>27</d4p1:CincCode>
<d4p1:CorporateInstitutionGroupId>sample string 31</d4p1:CorporateInstitutionGroupId>
<d4p1:CountryCode>sample string 7</d4p1:CountryCode>
<d4p1:CountryName>sample string 17</d4p1:CountryName>
<d4p1:Cusip>sample string 14</d4p1:Cusip>
<d4p1:Figi>sample string 29</d4p1:Figi>
<d4p1:FinancialInstitutionGroupId>sample string 32</d4p1:FinancialInstitutionGroupId>
<d4p1:HasAnnualFinancials>false</d4p1:HasAnnualFinancials>
<d4p1:HasQuarterlyFinancials>false</d4p1:HasQuarterlyFinancials>
<d4p1:HasSemiAnnualFinancials>false</d4p1:HasSemiAnnualFinancials>
<d4p1:Id>sample string 1</d4p1:Id>
<d4p1:ImpliedRatingEntityType>Corporation</d4p1:ImpliedRatingEntityType>
<d4p1:IndustryCode>sample string 8</d4p1:IndustryCode>
<d4p1:IndustryName>sample string 16</d4p1:IndustryName>
<d4p1:Isin>sample string 20</d4p1:Isin>
<d4p1:LastEDFDate>2026-06-05T14:54:06.953666+00:00</d4p1:LastEDFDate>
<d4p1:Lei>sample string 30</d4p1:Lei>
<d4p1:MoodysOrgId>sample string 15</d4p1:MoodysOrgId>
<d4p1:NaicsCode>sample string 12</d4p1:NaicsCode>
<d4p1:NaicsText>sample string 13</d4p1:NaicsText>
<d4p1:Name>sample string 2</d4p1:Name>
<d4p1:OrganizationEntityRatioType>sample string 4</d4p1:OrganizationEntityRatioType>
<d4p1:OrganizationEntityType>sample string 3</d4p1:OrganizationEntityType>
<d4p1:OrganizationType>Public</d4p1:OrganizationType>
<d4p1:PageHitCount>36</d4p1:PageHitCount>
<d4p1:Region>sample string 25</d4p1:Region>
<d4p1:RegionCode>sample string 18</d4p1:RegionCode>
<d4p1:RegionName>sample string 24</d4p1:RegionName>
<d4p1:RequiresSubscription>false</d4p1:RequiresSubscription>
<d4p1:ReutersId>sample string 21</d4p1:ReutersId>
<d4p1:Sector>sample string 9</d4p1:Sector>
<d4p1:SectorCode>sample string 10</d4p1:SectorCode>
<d4p1:SectorName>sample string 23</d4p1:SectorName>
<d4p1:Sedol>sample string 28</d4p1:Sedol>
<d4p1:SicCode>sample string 11</d4p1:SicCode>
<d4p1:SicName>sample string 22</d4p1:SicName>
<d4p1:TickerExchange>sample string 6</d4p1:TickerExchange>
<d4p1:TickerSymbol>sample string 5</d4p1:TickerSymbol>
</d2p1:Entity>
<d2p1:PhysicalRisk i:nil="true" />
<d2p1:RequiresSubscription>false</d2p1:RequiresSubscription>
<d2p1:ResultData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
<d4p1:anyType />
</d2p1:ResultData>
<d2p1:TransitionRisk i:nil="true" />
</d2p1:EntityCAEScenariosResult>
<d2p1:EntityCAEScenariosResult>
<d2p1:Baseline>
<d2p1:BondDuration>3</d2p1:BondDuration>
<d2p1:BondPrice>2</d2p1:BondPrice>
<d2p1:Edf xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:decimal>1</d5p1:decimal>
<d5p1:decimal>2</d5p1:decimal>
<d5p1:decimal>3</d5p1:decimal>
</d2p1:Edf>
<d2p1:Fvs>1</d2p1:Fvs>
<d2p1:ImpliedRating xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
<d5p1:string>sample string 3</d5p1:string>
</d2p1:ImpliedRating>
</d2p1:Baseline>
<d2p1:CombinedRisk i:nil="true" />
<d2p1:EdfDate>2026-06-05T14:54:06.953666+00:00</d2p1:EdfDate>
<d2p1:Entity xmlns:d4p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects">
<DataErrorMessage xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.Abstract">sample string 40</DataErrorMessage>
<DataErrorType xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.Abstract">None</DataErrorType>
<d4p1:Address>sample string 19</d4p1:Address>
<d4p1:BvDId>sample string 38</d4p1:BvDId>
<d4p1:BvDName>sample string 39</d4p1:BvDName>
<d4p1:CincCode>27</d4p1:CincCode>
<d4p1:CorporateInstitutionGroupId>sample string 31</d4p1:CorporateInstitutionGroupId>
<d4p1:CountryCode>sample string 7</d4p1:CountryCode>
<d4p1:CountryName>sample string 17</d4p1:CountryName>
<d4p1:Cusip>sample string 14</d4p1:Cusip>
<d4p1:Figi>sample string 29</d4p1:Figi>
<d4p1:FinancialInstitutionGroupId>sample string 32</d4p1:FinancialInstitutionGroupId>
<d4p1:HasAnnualFinancials>false</d4p1:HasAnnualFinancials>
<d4p1:HasQuarterlyFinancials>false</d4p1:HasQuarterlyFinancials>
<d4p1:HasSemiAnnualFinancials>false</d4p1:HasSemiAnnualFinancials>
<d4p1:Id>sample string 1</d4p1:Id>
<d4p1:ImpliedRatingEntityType>Corporation</d4p1:ImpliedRatingEntityType>
<d4p1:IndustryCode>sample string 8</d4p1:IndustryCode>
<d4p1:IndustryName>sample string 16</d4p1:IndustryName>
<d4p1:Isin>sample string 20</d4p1:Isin>
<d4p1:LastEDFDate>2026-06-05T14:54:06.953666+00:00</d4p1:LastEDFDate>
<d4p1:Lei>sample string 30</d4p1:Lei>
<d4p1:MoodysOrgId>sample string 15</d4p1:MoodysOrgId>
<d4p1:NaicsCode>sample string 12</d4p1:NaicsCode>
<d4p1:NaicsText>sample string 13</d4p1:NaicsText>
<d4p1:Name>sample string 2</d4p1:Name>
<d4p1:OrganizationEntityRatioType>sample string 4</d4p1:OrganizationEntityRatioType>
<d4p1:OrganizationEntityType>sample string 3</d4p1:OrganizationEntityType>
<d4p1:OrganizationType>Public</d4p1:OrganizationType>
<d4p1:PageHitCount>36</d4p1:PageHitCount>
<d4p1:Region>sample string 25</d4p1:Region>
<d4p1:RegionCode>sample string 18</d4p1:RegionCode>
<d4p1:RegionName>sample string 24</d4p1:RegionName>
<d4p1:RequiresSubscription>false</d4p1:RequiresSubscription>
<d4p1:ReutersId>sample string 21</d4p1:ReutersId>
<d4p1:Sector>sample string 9</d4p1:Sector>
<d4p1:SectorCode>sample string 10</d4p1:SectorCode>
<d4p1:SectorName>sample string 23</d4p1:SectorName>
<d4p1:Sedol>sample string 28</d4p1:Sedol>
<d4p1:SicCode>sample string 11</d4p1:SicCode>
<d4p1:SicName>sample string 22</d4p1:SicName>
<d4p1:TickerExchange>sample string 6</d4p1:TickerExchange>
<d4p1:TickerSymbol>sample string 5</d4p1:TickerSymbol>
</d2p1:Entity>
<d2p1:PhysicalRisk i:nil="true" />
<d2p1:RequiresSubscription>false</d2p1:RequiresSubscription>
<d2p1:ResultData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
<d4p1:anyType />
<d4p1:anyType />
</d2p1:ResultData>
<d2p1:TransitionRisk i:nil="true" />
</d2p1:EntityCAEScenariosResult>
</Results>
</EntityGetCAEResponse>