Get Overview - GOES Core API

cURL

curl --request GET \
  --url https://api.goes.health/v1/risks/overview

{
  "responseId": "123e4567-e89b-12d3-a456-426614174000",
  "activity_intelligence": "For your Half Dome hike today, be prepared for significant elevation gain and exposed terrain. The combination of high altitude, bear activity, and lightning risk requires careful planning. Start early and monitor weather conditions closely.",
  "risks": [
    {
      "id": "sunburn",
      "title": "Sunburn",
      "source": "environment",
      "status": "applicable",
      "score": 2,
      "summary": "<string>",
      "tips": [
        "<string>"
      ]
    }
  ],
  "alerts": []
}

GET

risks

overview

cURL

curl --request GET \
  --url https://api.goes.health/v1/risks/overview

{
  "responseId": "123e4567-e89b-12d3-a456-426614174000",
  "activity_intelligence": "For your Half Dome hike today, be prepared for significant elevation gain and exposed terrain. The combination of high altitude, bear activity, and lightning risk requires careful planning. Start early and monitor weather conditions closely.",
  "risks": [
    {
      "id": "sunburn",
      "title": "Sunburn",
      "source": "environment",
      "status": "applicable",
      "score": 2,
      "summary": "<string>",
      "tips": [
        "<string>"
      ]
    }
  ],
  "alerts": []
}

Coming Soon — This endpoint is under development and will be available at a future date.

Get a comprehensive overview of all risks and alerts for a location, combining environmental risks, wildlife risks, plant risks, and national weather alerts. Available in two formats: a simple cacheable GET request, or an advanced POST request with full personalization options.

Simple Request (GET)

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}.

options

object

Configuration options that control how the response is built.

Show options properties

options.length

string

Controls the length of the Activity Intelligence text. Available options:

brief: 1-2 sentences focusing on the most critical risks
standard: 3-4 sentences with key risks and basic context (default)
detailed: 5-7 sentences with comprehensive risk analysis and detailed recommendations

options.exclude

string

Comma-separated list of sections to exclude from the response. Options: alerts, environment, wildlife, plants, activity_intelligence

Example

# Basic request
curl "http://api.goes.health/v1/risks/overview?location=37.7485,-119.5331" \
  -H "Authorization: Bearer YOUR_API_KEY"

# With options
curl "http://api.goes.health/v1/risks/overview?location=37.7485,-119.5331&options.length=detailed&options.exclude=alerts" \
  -H "Authorization: Bearer YOUR_API_KEY"

Advanced Request (POST)

Headers

Authorization

string

required

Your API key for authentication. Format: Bearer YOUR_API_KEY

Body Parameters

location

string

required

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

options

object

Configuration options that control how the response is built.

Show options properties

options.length

string

Controls the length of the Activity Intelligence text. Available options:

brief: 1-2 sentences focusing on the most critical risks
standard: 3-4 sentences with key risks and basic context (default)
detailed: 5-7 sentences with comprehensive risk analysis and detailed recommendations

options.exclude

array

A list of sections to exclude from the response. Available options:

alerts: Excludes national watches, warnings, and advisories
environment: Excludes environmental risks
wildlife: Excludes wildlife risks
plants: Excludes plant risks
activity_intelligence: Excludes the AI-generated Activity Intelligence

profile

object

Information about who is going outside. This object is extensible - you can add custom fields beyond the standard ones listed below.

Show profile properties

profile.activity

string

The outdoor activity you plan to do (e.g., “hiking”, “camping”, “skiing”). This helps personalize the Activity Intelligence.

profile.age

integer

The age of the person doing the activity. Used to provide age-appropriate risk analysis when summarizing.

profile.outdoor_experience

integer

Experience level with outdoor activities, from 0 (beginner) to 4 (expert).

profile.context

string

Any additional context that may be relevant for risk summarization. This helps provide more personalized recommendations.

Response

responseId

string

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

activity_intelligence

string

An AI-generated summary paragraph that consolidates all risks and alerts, personalized to your activity and experience level.

risks

array

A comprehensive array of all risks from environmental, wildlife, and plant sources.

Show child attributes

string

The unique identifier for the risk.

title

string

The human-readable title of the risk.

source

string

The source of this risk (“environment”, “wildlife”, or “plants”).

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

integer

A number from 0-3 representing the risk level or prevalence:

For environmental risks: risk level from 0 (None) to 3 (High)
For wildlife and plant risks: prevalence score from 0 (None) to 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.

alerts

array

An array of active NOAA weather alerts for the United States.

Show child attributes

event

string

The type of weather event. Example: Severe Thunderstorm Warning.

severity

string

The severity level of the alert as specified by NOAA. Example: Severe.

senderName

string

The NWS office that issued the alert. Example: NWS Riverton WY.

headline

string

A complete headline of the alert including timing and issuing office.

description

string

Detailed description of the weather event, including specific hazards, source of information, and impacts.

instruction

string

Safety instructions and recommended actions for the public.

Example

curl -X POST "http://api.goes.health/v1/risks/overview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "location": "37.7485,-119.5331",
    "options": {
      "length": "standard",
      "exclude": []
    },
    "profile": {
      "activity": "hiking",
      "age": 32,
      "outdoor_experience": 2,
      "context": "First time hiker"
    }
  }'

Response

Both the GET and POST methods return the same response format. The POST method provides more personalized content in the Activity Intelligence field.

{
  "responseId": "123e4567-e89b-12d3-a456-426614174000",
  "activity_intelligence": "For your Half Dome hike today, be prepared for significant elevation gain and exposed terrain. The combination of high altitude, bear activity, and lightning risk requires careful planning. Start early and monitor weather conditions closely.",
  "risks": [
    {
      "id": "high-altitude",
      "title": "High Altitude",
      "source": "environment",
      "status": "applicable",
      "score": 3,
      "summary": "...",
      "tips": [
        "..."
      ]
    },
    {
      "id": "sunburn",
      "title": "Sun Exposure",
      "source": "environment",
      "status": "applicable",
      "score": 2,
      "summary": "...",
      "tips": [
        "..."
      ]
    },
    {
      "id": "lightning",
      "title": "Lightning",
      "source": "environment",
      "status": "applicable",
      "score": 1,
      "summary": "...",
      "tips": [
        "..."
      ]
    },
    {
      "id": "bears",
      "title": "Bears",
      "source": "wildlife",
      "status": "applicable",
      "score": 2,
      "summary": "...",
      "tips": [
        "..."
      ]
    },
    {
      "id": "frostbite",
      "title": "Frostbite",
      "source": "environment",
      "status": "not_applicable",
      "score": 0,
      "summary": "...",
      "tips": [
        "..."
      ]
    },
    {
      "id": "poison-sumac",
      "title": "Poison Sumac",
      "source": "plants",
      "status": "unavailable"
    }
  ],
  "alerts": []
}

Query Parameters

location

string

required

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

Pattern: ^-?\d+(\.\d+)?,-?\d+(\.\d+)?$

options.length

enum<string>

default:standard

Controls the length of the Activity Intelligence text.

Available options:

brief,

standard,

detailed

options.exclude

string

Comma-separated list of sections to exclude from the response. Options: alerts, environment, wildlife, plants, activity_intelligence

Response

A basic overview of all risks with default settings.

responseId

string<uuid>

required

A unique identifier for this response

activity_intelligence

string

required

An AI-generated summary paragraph that consolidates all risks and alerts

risks

object[]

required

A comprehensive array of all risks from environmental, wildlife, and plant sources

Option 1
Option 2

Show child attributes

alerts

object[]

An array of active NOAA weather alerts for the United States

Show child attributes

Get Plants Get Environmental Forecast

Documentation Index

​Simple Request (GET)

​Headers

​Query Parameters

​Example

​Advanced Request (POST)

​Headers

​Body Parameters

​Response

​Example

​Response

Query Parameters

Response

Simple Request (GET)

Headers

Query Parameters

Example

Advanced Request (POST)

Headers

Body Parameters

Response

Example

Response