This endpoint allows you to check for various outdoor health risks based on a specific location. You can check for all environmental risks or specify particular ones.
Request
Your API key for authentication. Format: Bearer YOUR_API_KEY
Query Parameters
The latitude and longitude for the location to check, formatted as {latitude},{longitude}.
A comma-separated list of risk IDs to check. If you do not provide this, all risks will be checked.
The available ids are:
sunburn
high-altitude
heat-illness
breathing-problems
frostbite
hypothermia
lightning
Response
The response is a JSON object containing a risks array. Each object in the array represents a specific risk and includes an id, a title, a score, and a list of tips.
A unique identifier for this response. Use this ID if submitting feedback about the response.
An array of risk objects. The unique identifier for the risk. Example: heat-illness.
The human-readable title of the risk. Example: Heat Illness.
The status of this risk assessment:
applicable: Risk is present and relevant for this location
not_applicable: Risk is not present or relevant for this location
unavailable: Risk data is unavailable for this location
error: An error occurred while assessing this risk
A number from 0-3 representing the risk level:
0: None
1: Low
2: Medium
3: High
A collection of 1-2 sentence strings with tips and recommendations.
A 1-2 sentence summary of the tips and key information.
Error message describing what went wrong. Only present when status is error.
Example
Request
curl "http://api.goes.health/v1/risks/environmental?ids=sunburn,heat-illness,frostbite&location=34.0522,-118.2437" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
{
"responseId" : "123e4567-e89b-12d3-a456-426614174000" ,
"risks" : [
{
"id" : "sunburn" ,
"title" : "Sunburn" ,
"status" : "applicable" ,
"score" : 2 ,
"summary" : "..." ,
"tips" : [
"..."
]
},
{
"id" : "heat-illness" ,
"title" : "Heat Illness" ,
"status" : "applicable" ,
"score" : 3 ,
"summary" : "..." ,
"tips" : [
"..."
]
},
{
"id" : "frostbite" ,
"title" : "Frostbite" ,
"status" : "not_applicable" ,
"score" : 0 ,
"summary" : "..." ,
"tips" : [
"..."
]
}
]
}
The latitude and longitude, formatted as {latitude},{longitude} .
A comma-separated list of environmental risk IDs.
Comma-separated list of sections to exclude from the response. Options: tips , summary , score
A list of environmental risks.
A unique identifier for this response