CountryRisk.io API documentation

Risk scores

GET /riskscores/{model}/

Get risk scores by model.

Path parameters

model string Required

Risk score model (see values below) or custom model (if you have access to bespoke risk scores)

Values are aml, esg, sdg, sovereign, or supplychainrisk.

Query parameters

country_code string

Country code
country_name string

Country name
ordering string

Ordering

Values are country_code, -country_code, country_name, or -country_name. Default value is country_code.

Responses

• 200

A list of risk scores.
Hide response attributes Show response attributes object
- model object
  
  Risk model definition.
  
  Hide model attributes Show model attributes
  
  type string
  
  Risk model type.
  
  version string
  
  Risk model version number.
  
  updateDate string(date)
  
  Date of update.
  
  description string
  
  Risk model description.
  
  source string
  
  Risk model source.
  
  url string(uri)
  
  Risk model url for further information.
- data array[object]
  
  Hide data attributes Show data attributes
  
  entity object
  
  Geographical information.
  
  Hide entity attributes Show entity attributes
  
  geoType string
  
  Geographic type (e.g. country, region, municipality, ...).
  
  countryCode string
  
  Country code following the ISO 3166-1 alpha-3 codes.
  
  countryName string
  
  Country name.
  
  regionName string
  
  Region name (e.g. Asia, Latin America, ...).
  
  worldBankClassification string
  
  World Bank income classification (e.g. low-income economy, lower-middle-income economy, ...).
  
  oecdMember boolean
  
  Flag if country is an OECD member.
  
  resultsTimeSeriesAvailable boolean
  
  Flag if there is a time series available for the data result.
  
  results array[object]
  
  Risk score information.
  
  Hide results attributes Show results attributes
  
  timestamp string(date)
  
  Date.
  
  type string
  
  Flag if the data is based on historic, current or projected/forecasted data.
  
  Values are history, current, or projection.
  
  score number
  
  Model risk score where higher values indicate higher risk with the exception of the SDG Index where a higher value indicates better SDG performance.
  
  Minimum value is 0, maximum value is 100.
  
  regionalScore number
  
  Regional model risk score. Only available for the SDG Index.
  
  Minimum value is 0, maximum value is 100.
  
  riskClassificationNumeric integer
  
  Model risk category (numeric) where higher values indicate higher risk.
  
  Values are 1, 2, 3, 4, or 5.
  
  riskClassificationCategorical string
  
  Model risk category from very low to very high risk.
  
  Values are Very Low, Low, Medium, High, or Very High.
  
  riskPoints integer
  
  Absolut number of risk points.
  
  Minimum value is 0.
  
  riskPointsMax integer
  
  Maximum number of risk points possible based on available underlying data.
  
  Minimum value is 0.
  
  ratingNumeric integer
  
  Numeric rating.
  
  Minimum value is 1, maximum value is 21.
  
  ratingLetter string
  
  Letter rating.
  
  Values are AAA, AA+, AA, AA-, A+, A, A-, BBB+, BBB, BBB-, BB+, BB, BB-, B+, B, B-, CCC+, CCC, CCC-, CC - C, or D.
  
  shareIndicatorsAvailable number
  
  Share of available data used for calculating the model risk score.
  
  Minimum value is 0, maximum value is 1.
  
  dataQualityNumeric integer
  
  Data quality score where higher values indicate better data quality.
  
  Values are 1, 2, 3, 4, or 5.
  
  dataQualityCategorical string
  
  Data quality category.
  
  Values are Very Poor, Poor, Medium, Good, or Very Good.
  
  countryRank integer
  
  Risk rank.
  
  countryUniverse integer
  
  Number of countries considered for risk rank.

GET /riskscores/{model}/

curl \
 -X GET https://app.countryrisk.io/api/v1/riskscores/aml/ \
 -H "Authorization: $API_KEY"

Response examples (200)

{
  "model": {
    "description": "ESG Risk Score",
    "url": "https://www.countryrisk.io",
    "source": "CountryRisk.io Ltd",
    "version": "v1",
    "updateDate": "2019-11-20",
    "type": "ESG Risk Score"
  },
  "data": [
    {
      "entity": {
        "geoType": "country",
        "worldBankClassification": "High income",
        "countryCode": "SWE",
        "resultsTimeSeriesAvailable": true,
        "countryName": "Sweden",
        "regionName": "Europe & Central Asia",
        "oecdMember": true
      },
      "results": [
        {
          "dataQualityCategorical": "Very Good",
          "shareIndicatorsAvailable": 0.888,
          "score": 11.831,
          "countryUniverse": 186,
          "timestamp": "2019-12-31",
          "riskClassificationCategorical": "Very Low",
          "ratingLetter": "AA+",
          "ratingNumeric": 2,
          "riskClassificationNumeric": 1,
          "type": "current",
          "dataQualityNumeric": 5,
          "countryRank": 3
        }
      ]
    }
  ]
}