> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goes.health/llms.txt
> Use this file to discover all available pages before exploring further.

# API Introduction

> Introduction to the GOES Health API

## Overview

The GOES API uses REST endpoints with JSON responses. Each endpoint is:

* Location-aware: latitude/longitude in every request
* Real-time: continuously updated location risks for time-sensitive decisions
* Developer-friendly: predictable query parameters and standard HTTP status codes
* Mobile-ready: lightweight responses designed for low-latency cell networks

Whether you are displaying a compact widget or powering a full-featured trip-planning assistant, the API lets you select exactly the data you need and nothing more.

## Location Based Health Risks

Our API monitors a comprehensive set of outdoor health risks across multiple categories:

<CardGroup cols={2}>
  <Card title="Weather & Climate" icon="cloud-sun">
    <div className="space-y-2">
      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-red-500" />

        <div>Sunburn</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-yellow-500" />

        <div>Heat Illness</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-blue-500" />

        <div>Hypothermia</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-blue-300" />

        <div>Frostbite</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-purple-500" />

        <div>Lightning</div>
      </div>
    </div>
  </Card>

  <Card title="Terrain & Air Quality" icon="mountain">
    <div className="space-y-2">
      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-indigo-500" />

        <div>High Altitude Illness</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-cyan-500" />

        <div>Breathing Problems</div>
      </div>
    </div>
  </Card>

  <Card title="Flora Hazards" icon="leaf">
    <div className="space-y-2">
      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-green-600" />

        <div>Poison Ivy</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-green-500" />

        <div>Poison Oak</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-green-400" />

        <div>Poison Sumac</div>
      </div>
    </div>
  </Card>

  <Card title="Wildlife & Insects" icon="paw">
    <div className="space-y-2">
      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-amber-700" />

        <div>Bears</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-orange-500" />

        <div>Venomous Snakes</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-gray-500" />

        <div>Mosquitoes</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-amber-800" />

        <div>Ticks</div>
      </div>
    </div>
  </Card>

  <Card title="National Alerts" icon="triangle-exclamation">
    <div className="space-y-2">
      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-red-600" />

        <div>Severe Thunderstorm Warning</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-orange-600" />

        <div>Red Flag Warning</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-blue-600" />

        <div>Winter Storm Warning</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-purple-600" />

        <div>Flash Flood Warning</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-slate-600" />

        <div>Air Quality Alert</div>
      </div>

      <div className="flex items-center gap-2">
        <div className="w-2 h-2 rounded-full bg-rose-600" />

        <div>Tornado Warning</div>
      </div>

      <div className="mt-2 text-sm text-gray-600 dark:text-gray-400">
        +104 more alert types...
      </div>
    </div>
  </Card>
</CardGroup>

## API Endpoints

Our API provides six core endpoints to access outdoor risk intelligence:

<CardGroup cols={3}>
  <Card title="Environmental Risks">
    Use when only environment risks (e.g. Heat Illness, Breathing Problems) and tips are needed.

    <code className="inline-block bg-slate-100 dark:bg-slate-800 px-2 py-0.5 rounded text-xs">
      GET /environmental
    </code>

    <a href="/api-reference/risks" className="mt-4 inline-flex items-center gap-1 text-gray-700 dark:text-gray-300 hover:text-black dark:hover:text-white hover:underline decoration-[#E7C136] underline-offset-4">
      View endpoint →
    </a>
  </Card>

  <Card title="Wildlife Risks">
    Use when only wildlife risks (e.g. Bears, Venomous Snakes) and tips are needed.

    <code className="inline-block bg-slate-100 dark:bg-slate-800 px-2 py-0.5 rounded text-xs">
      GET /wildlife
    </code>

    <a href="/api-reference/wildlife" className="mt-4 inline-flex items-center gap-1 text-gray-700 dark:text-gray-300 hover:text-black dark:hover:text-white hover:underline decoration-[#E7C136] underline-offset-4">
      View endpoint →
    </a>
  </Card>

  <Card title="Plant Risks">
    Use when only plant risks (e.g. Poison Ivy, Poison Oak) and tips are needed.

    <code className="inline-block bg-slate-100 dark:bg-slate-800 px-2 py-0.5 rounded text-xs">
      GET /plants
    </code>

    <a href="/api-reference/plants" className="mt-4 inline-flex items-center gap-1 text-gray-700 dark:text-gray-300 hover:text-black dark:hover:text-white hover:underline decoration-[#E7C136] underline-offset-4">
      View endpoint →
    </a>
  </Card>

  <Card title="Overview & Summary">
    Use for a complete understanding of risks and recommendations. Includes all previous endpoint data and more.

    <code className="inline-block bg-slate-100 dark:bg-slate-800 px-2 py-0.5 rounded text-xs">
      GET /overview
    </code>

    <a href="/api-reference/overview" className="mt-4 inline-flex items-center gap-1 text-gray-700 dark:text-gray-300 hover:text-black dark:hover:text-white hover:underline decoration-[#E7C136] underline-offset-4">
      View endpoint →
    </a>
  </Card>

  <Card title="Environmental Forecast">
    Use for 48-hour and 8-day environmental risk forecasts to plan ahead.

    <code className="inline-block bg-slate-100 dark:bg-slate-800 px-2 py-0.5 rounded text-xs">
      GET /environmental/forecast
    </code>

    <a href="/api-reference/environmental-forecast" className="mt-4 inline-flex items-center gap-1 text-gray-700 dark:text-gray-300 hover:text-black dark:hover:text-white hover:underline decoration-[#E7C136] underline-offset-4">
      View endpoint →
    </a>
  </Card>

  <Card title="Overview Forecast">
    Use for comprehensive extended forecasts with all risks, alerts, and AI-generated insights.

    <code className="inline-block bg-slate-100 dark:bg-slate-800 px-2 py-0.5 rounded text-xs">
      GET /overview/forecast
    </code>

    <a href="/api-reference/overview-forecast" className="mt-4 inline-flex items-center gap-1 text-gray-700 dark:text-gray-300 hover:text-black dark:hover:text-white hover:underline decoration-[#E7C136] underline-offset-4">
      View endpoint →
    </a>
  </Card>
</CardGroup>

## Authentication

All API requests require an API key in the Authorization header:

```bash theme={null}
curl "https://api.goes.health/v1/risks/environmental?location=37.7325,-119.5581" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

[Request an API key here](mailto:api@goes.health?subject=API%20Key%20Request)

## Rate Limits

* 600 requests per minute by default
* Contact us for higher volume needs

Ready to start? Check out our [Quickstart Guide](/documentation/quickstart) or dive into the [API Reference](/api-reference/risks).
