CreditEdge API Help Page
Introduction
Welcome to the CreditEdge API. Below you will find descriptions of the resources currently available.
AdvancedSearch
| API | Description |
|---|---|
| POST v1/AdvancedSearch/AdvancedSearch |
Advanced search using company name or bond issuer name, and in additon one or more data series based filters. For example, you can search for a bond issuer having name containing "northern" and bond duration greater than 1. |
Authentication
| API | Description |
|---|---|
| GET v1/Authentication/ExternalLogin |
Login to Creditedge.com externally by providing an API public and private key. |
BondPortfolios
| API | Description |
|---|---|
| DELETE v1/BondPortfolios/Delete |
Deletes a bond portfolio. |
| DELETE v1/BondPortfolios/DeleteItems |
Deletes items from a bond portfolio. |
| PUT v1/BondPortfolios/AddItems |
Add items to a bond portfolio. |
| PUT v1/BondPortfolios/UpdateName |
Update bond portfolio name |
| POST v1/BondPortfolios/Create |
Creates a bond portfolio. |
| GET v1/BondPortfolios/All |
Retrieves all bond portfolios associated to the logged in user. |
| GET v1/BondPortfolios/Bonds/ |
Retrieves all entities for the specified portfolio. |
Bonds
| API | Description |
|---|---|
| GET v1/Bonds/Search |
Search for a bond using the CUSIP or ISIN. |
| POST v1/Bonds/SearchBatch |
The same as Search but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Bonds/Series/ |
Retrieves time series data for an bond based on the instrument id, CUSIP, or ISIN. For a list of series types available, refer to the Series Types API. |
| GET v1/Bonds/SeriesBatch |
The same as Series but you can enter multiple requests as a single batch to send to the server. |
| GET v1/Bonds/PointInTime |
Retrieves data for an bond based on the instrument id, one or more series types, and a specific point in time. For a list of series types available, refer to the Series Types API. |
Currencies
| API | Description |
|---|---|
| GET v1/Currencies/Get |
Retunrs currencies lookup list containing currency ISO codes and names. |
EdfCalculator
| API | Description |
|---|---|
| GET v1/EdfCalculator/Current/ |
Returns the current calculator data which includes the most recent market data, drivers, and financial statement data. |
| POST v1/EdfCalculator/CurrentBatch |
The same as Current but you can enter multiple requests as a single batch to post to the server. |
| POST v1/EdfCalculator/AssetValue |
Recalculate the EDF Term Structure and Market Cap by modifying the Market Value of Assets. |
| POST v1/EdfCalculator/AssetValuePercent |
Recalculate the EDF Term Structure by shocking the Market Value of Assets by a percentage. |
| POST v1/EdfCalculator/AssetValuePercentBatch |
The same as AssetValuePercent but you can enter multiple requests as a single batch to post to the server. |
| POST v1/EdfCalculator/EquityValue |
Recalculate the EDF Term Structure and Market Value of Assets by modifying any Market Data or Income Statement field besides Market Value of Assets. |
| POST v1/EdfCalculator/EquityPercent |
Recalculate the EDF Term Structure and Market Value of Assets by shocking any Market Data or Income Statement field besides Market Value of Assets by a percentage. |
| POST v1/EdfCalculator/EquityPercentBatch |
The same as EquityPercent but you can enter multiple requests as a single batch to post to the server. |
| POST v1/EdfCalculator/BalanceSheet |
Recalculate the EDF Term Structure by modifying any Balance Sheet or Income Statement fields. |
| POST v1/EdfCalculator/BalanceSheetPercent |
Recalculate the EDF Term Structure by shocking any Balance Sheet or Income Statement fields by a percentage. |
| POST v1/EdfCalculator/BalanceSheetPercentBatch |
The same as BalanceSheetPercent but you can enter multiple requests as a single batch to post to the server. |
| POST v1/EdfCalculator/SimpleCalc |
Recalculate the EDF Term Structure by shocking any fields. |
Entities
| API | Description |
|---|---|
| GET v1/Entities/Search |
Search for an entity using name, PID, MoodysOrgId, ticker, ticker@exchange, CUSIP, ISIN, Figi, Lei, or Sedol. |
| POST v1/Entities/SearchBatch |
The same as Search but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Entities/Mapping |
The same as Search but instead of using a broad search you can enter request identifier of specific type to post to the server. Mapping entity by a specific identifier type is generally faster than using a broad search. |
| POST v1/Entities/MappingBatch |
The same as SearchBatch but instead of using a broad search you can enter multiple request identifiers of specific type as a single batch to post to the server. Mapping entity by a specific identifier type is generally faster than using a broad search. |
| GET v1/Entities/Summary/ |
Retrieves the credit risk summary, market data summary, entity data and profile data based on the PID of an entity. |
| 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. |
| GET v1/Entities/SummaryMonthlySimpleFormat/ |
The same as Summary but returns data in the legacy XML API service compatible format for a given range of dates. |
| POST v1/Entities/SummaryBatchSimpleFormat |
Similar to SummaryBatch but returns data in the legacy XML API service compatible format. |
| POST v1/Entities/SummaryBatch |
The same as Summary but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Entities/Series/ |
Retrieves time series data for an entity based on the PID. For a list of series types available, refer to the Series Types API. |
| POST v1/Entities/SeriesBatch |
The same as Series but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Entities/PointInTime |
Retrieves data for an entity based on the PID, one or more series types, and a specific point in time. For a list of series types available, refer to the Series Types API. |
| POST v1/Entities/PointInTime |
Retrieves data for one or more entities based on the PID, one or more series types, and a specific point in time. Accepts large lists of entities. For a list of series types available, refer to the Series Types API. |
| GET v1/Entities/News/ |
WARNING: The News API has been deprecated. Please do not use it |
| GET v1/Entities/Research/ |
Retrieves moodys.com research data for an entity based on the PID. |
| GET v1/Entities/CAEScenarios/ |
Retrieves climate adjusted credit risk scenarios for a given entity. |
| POST v1/Entities/CalculateCAEScenariosByBatch |
Calculates the cae scenarios by batch. |
EntityPortfolios
| API | Description |
|---|---|
| DELETE v1/EntityPortfolios/Delete |
Deletes an entity portfolio. |
| DELETE v1/EntityPortfolios/DeleteItems |
Deletes items from an entity portfolio. |
| PUT v1/EntityPortfolios/AddItems |
Add items to an entity portfolio. |
| PUT v1/EntityPortfolios/UpdateName |
Update entity portfolio name |
| POST v1/EntityPortfolios/Create |
Creates an entity portfolio. |
| GET v1/EntityPortfolios/All |
Retrieves all entity portfolios associated with the logged in user. |
| GET v1/EntityPortfolios/Entities/ |
Retrieves all entities for the specified portfolio. |
FvsCalculator
| API | Description |
|---|---|
| GET v1/FvsCalculator/Current/ |
Returns the current calculator data. |
| POST v1/FvsCalculator/CurrentBatch |
The same as Current but you can enter multiple requests as a single batch to post to the server. |
| POST v1/FvsCalculator/OverrideValue |
Recalculate the Fvs Term Structure and Fair Value Spread using absolute changes. |
| POST v1/FvsCalculator/OverridePercent |
Recalculate the Fvs Term Structure and Fair Value Spread using percent changes. |
| POST v1/FvsCalculator/OverridePercentBatch |
The same as OverridePercent but you can enter multiple requests as a single batch to post to the server. |
Groups
| API | Description |
|---|---|
| GET v1/Groups/Search |
Search for a group by name. |
| POST v1/Groups/SearchBatch |
The same as Search but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Groups/Summary/ |
Retrieves the credit risk summary and group data based on the ID of a group. |
| POST v1/Groups/SummaryBatch |
The same as Summary but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Groups/Details/ |
Retrieves the ID, Name, and Entity Type for each Entity in the requested group. |
| POST v1/Groups/DetailsBatch |
The same as Details but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Groups/Series/ |
Retrieves time series data for a group based on the Group ID. For a list of series types available, refer to the Series Types API. |
| POST v1/Groups/SeriesBatch |
The same as Series but you can enter multiple requests as a single batch to post to the server. |
| GET v1/Groups/PointInTime |
Retrieves aggregate data for an group based on the group id, one or more series types, and a specific point in time. For a list of series types available, refer to the Series Types API. |
Overrides
| API | Description |
|---|---|
| GET v1/Overrides/Pid/ |
Retrieves what-if calculator overrides for a specific PID associated to the API account. |
| GET v1/Overrides/All |
Retrieves all what-if calculator overrides associated to the API account. |
| GET v1/Overrides/Alerts |
This is for Moody's internal use only. |
Ping
| API | Description |
|---|---|
| GET v1/Ping/Get |
Simple connectivity test to confirm you can connect to the API and have set up the authentication headers properly. |
SeriesTypes
| API | Description |
|---|---|
| GET v1/SeriesTypes/Get/ |
Retrieve available Series Types for Entities, Groups, Portfolios and Bonds. This should be used in conjunction with Get Entity Series and Get Group Series (and the associated batch requests). |
UserAccount
| API | Description |
|---|---|
| GET v1/UserAccount/GetAuthorizedSeriesTypes |
Retrieves list of data series available in the user's subscription |
Version
| API | Description |
|---|---|
| GET v1/Version/Get |
Get the current version of the API. |