Path parameters
-
Risk score model (see values below) or custom model (if you have access to bespoke risk scores)
Values are
aml
,esg
,sdg
,sovereign
, orsupplychainrisk
.
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 iscountry_code
.
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
}
]
}
]
}
Response examples (200)
{
"model": {
"type": "string",
"version": "string",
"updateDate": "2024-05-04",
"description": "string",
"source": "string",
"url": "https://example.com"
},
"data": [
{
"entity": {
"geoType": "string",
"countryCode": "string",
"countryName": "string",
"regionName": "string",
"worldBankClassification": "string",
"oecdMember": true,
"resultsTimeSeriesAvailable": true
},
"results": [
{
"timestamp": "2024-05-04",
"type": "history",
"score": 42.0,
"regionalScore": 42.0,
"riskClassificationNumeric": 1,
"riskClassificationCategorical": "Very Low",
"riskPoints": 42,
"riskPointsMax": 42,
"ratingNumeric": 42,
"ratingLetter": "AAA",
"shareIndicatorsAvailable": 42.0,
"dataQualityNumeric": 1,
"dataQualityCategorical": "Very Poor",
"countryRank": 42,
"countryUniverse": 42
}
]
}
]
}