Get Environmental Forecast

Precision hourly and extended daily forecast of environmental risks for a location.

Get 48-hour hourly and 8-day daily forecasts of environmental risks for a location.

Request

Headers

Authorization · string · required

Your API key for authentication. Format: Bearer YOUR_API_KEY

Query Parameters

location · string · required

The latitude and longitude for the location to check, formatted as {latitude},{longitude}.

Response

responseId · string

A unique identifier for this response. Use this ID if submitting feedback about the forecast.

hourly · array

48 hourly entries, each containing the set of environmental risks for that hour.

Show child attributes

time · string

ISO 8601 timestamp (UTC) representing the forecast hour.

risks · array

The environmental risks predicted for this hour.

Show child attributes

id · string

The unique identifier for the environmental risk.

title · string

The human-readable title of the risk.

status · enum

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

score · number

A number from 0-3 representing the risk level:

• 0: None
• 1: Low
• 2: Medium
• 3: High

tips · array

A collection of 1-2 sentence strings with tips and recommendations.

summary · string

A 1-2 sentence summary of the tips and key information.

error · string

Error message describing what went wrong. Only present when status is error.

daily · array

32 daily entries over 8 days. 4 timestamps per day: morning (06:00), noon (12:00), evening (18:00), midnight (00:00), each containing the set of environmental risks.

Show child attributes

time · string

ISO 8601 timestamp (UTC) representing the forecast time.

risks · array

The environmental risks predicted for this time.

Show child attributes

id · string

The unique identifier for the environmental risk.

title · string

The human-readable title of the risk.

status · enum

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

score · number

A number from 0-3 representing the risk level:

• 0: None
• 1: Low
• 2: Medium
• 3: High

tips · array

A collection of 1-2 sentence strings with tips and recommendations.

summary · string

A 1-2 sentence summary of the tips and key information.

error · string

Error message describing what went wrong. Only present when status is error.

Example

curl "http://api.goes.health/v1/risks/environmental/forecast?location=34.0522,-118.2437" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "responseId": "123e4567-e89b-12d3-a456-426614174000",
  "hourly": [
    {
      "time": "2024-06-27T00:00:00Z",
      "risks": [
        {
          "id": "sunburn",
          "title": "Sunburn",
          "status": "applicable",
          "score": 2,
          "summary": "...",
          "tips": [
            "..."
          ]
        }
      ]
    }
  ],
  "daily": [
    {
      "time": "2024-06-27T06:00:00Z",
      "risks": [
        {
          "id": "sunburn",
          "title": "Sunburn",
          "status": "applicable",
          "score": 2,
          "summary": "...",
          "tips": [
            "..."
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Enter your API key

Query Parameters

location · string · required

The latitude and longitude, formatted as {latitude},{longitude}.

ids · string

A comma-separated list of environmental risk IDs to include in the forecast.

exclude · string

Comma-separated list of forecast types to exclude from the response. Options: hourly, daily

exclude_risk_fields · string

Comma-separated list of sections to exclude from the response. Options: tips, summary, score

Response

200

application/json

A forecast of environmental risks with hourly and/or daily data.

responseId · string<uuid> · required

A unique identifier for this response

hourly · object[]

48 hourly entries, each containing the set of environmental risks for that hour.

Show child attributes

daily · object[]

32 daily entries over 8 days. 4 timestamps per day: morning (06:00), noon (12:00), evening (18:00), midnight (00:00), each containing the set of environmental risks.

Show child attributes