---
title: "`GET /v1/space-weather`: the aurora forecast and Kp."
method: GET
path: "/v1/space-weather"
tags: ["live"]
---

# \`GET /v1/space-weather\`: the aurora forecast and Kp.

`GET /v1/space-weather`

## Request

- Base URL: `https://api.mapmap.ai`
- URL: `https://api.mapmap.ai/v1/space-weather`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `api_key`

The NOAA SWPC OVATION aurora forecast and the planetary Kp index, with a link to the probability grid. A forecast of where the aurora is likely, about 30 to 90 minutes ahead, not an observation. `status` is `ok`, `unavailable` (the forecast is older than an hour: the times and Kp are still reported, `aurora` is null) or `unknown` (no data); never an error. No endorsement by or affiliation with NOAA is implied. One Standard unit per request; a browser (`maps`) key may call it.

## Response `200`

Aurora forecast and Kp

- SpaceWeatherResponse: `GET /v1/space-weather` answer.
  - `age_s` integer, nullable: Seconds since `forecast_time`. `null` when unknown.
  - `attribution` string, required: The credit, verbatim.
  - `aurora` AuroraGrid: The aurora probability grid.
    - `column0` string, nullable: Which longitude column 0 is.
    - `forecast_time` string, nullable: The forecast time the grid is for (RFC 3339).
    - `height` integer, nullable: Grid height in pixels.
    - `png` string, required: URL of the grey PNG (key stamped when the key came as `?api_key=`).
    - `row0` string, nullable: Which latitude row 0 is.
    - `value` string, nullable: What a pixel value means.
    - `width` integer, nullable: Grid width in pixels.
  - `endorsement` string, required: No endorsement by or affiliation with NOAA is implied.
  - `forecast_time` string, nullable: The time the aurora forecast is for (RFC 3339).
  - `generated_at` string, required: When this answer was assembled (RFC 3339).
  - `kp` number, double, nullable: Planetary Kp index.
  - `kp_time` string, nullable: When Kp was measured (RFC 3339).
  - `label` string, required: Forecast, not an observation.
  - `max_probability` number, double, nullable: Highest aurora probability in the grid, percent.
  - `observation_time` string, nullable: The observation time the forecast was made from (RFC 3339).
  - `status` string, required: `ok`, `unavailable` or `unknown`.
  - `threshold_s` integer, required: The age after which the forecast is `unavailable`, seconds.

## Other responses

- `501`: Space weather not enabled (`SN_LIVE_DIR` unset). Not billed

---

[API](https://skmtc.dev/mapmap/apis/sn-gateway.md) · [All operations](https://skmtc.dev/mapmap/apis/sn-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/mapmap/apis/sn-gateway/revisions/2293be8b4c38?raw)