# IonoFlux

> IonoFlux is a free REST API and website (English and Korean) for space weather, ionosphere maps, observed propagation and HF radio path predictions. Live solar and geomagnetic data, global ionosphere maps, and path predictions between any two places — checked against millions of real FT8 and WSPR reception reports.

- All data is JSON; times are ISO 8601 UTC; frequencies are MHz. Every dataset reports its upstream `source`, `attribution` (license) and `last_updated` time.
- Authentication: Every call needs an API key. Sign in, create a free key on your account page and send it in the X-API-Key header. Keys are free; create one at https://ionoflux.runvia.app/account.
- Free keys: 1,000 requests per UTC day. Every response includes X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
- Prediction model: Predictions use a simplified ITU-R P.533 method driven by the GloTEC ionosphere model; see the API docs for details and known limitations. Predictions are physics-based; a machine-learning model is in development and not in service. A reliability value is a model estimate, not a promise of a contact.
- Responses include the upstream source and license. Please credit the original providers (NOAA SWPC, GFZ, SILSO, GIRO, PSK Reporter, WSPRnet, OpenStreetMap) when you publish the data.
- Korean pages live under /ko (for example /ko/developers).

## API

- [Developer Center](https://ionoflux.runvia.app/developers): API documentation, the Python SDK and free API keys
- [API overview and examples](https://ionoflux.runvia.app/developers/api): quick start in curl, JavaScript and Python
- [Python SDK](https://ionoflux.runvia.app/developers/python): official synchronous client, `pip install ionoflux` (Python 3.11+, Server key)
- [OpenAPI specification](https://ionoflux.runvia.app/openapi.json): every endpoint, parameter and response schema (machine-readable)
- [Interactive docs (Swagger UI)](https://ionoflux.runvia.app/docs)
- [Reference (ReDoc)](https://ionoflux.runvia.app/redoc)

Main endpoints (base URL https://ionoflux.runvia.app, header `X-API-Key: <key>`):

- `GET /v1/propagation/path?from=Seoul&to=New%20York&frequency=14.074`: Predict a path between two places (coordinates, Maidenhead locator or place name)
- `GET /v1/propagation/forecast?from=PM37&to=FN20&hours=24`: Hour-by-hour band reliability for a path (up to 72 h)
- `GET /v1/space-weather/current`: All current indicators in one call
- `GET /v1/ionosphere/muf?format=geojson`: Global MUF / foF2 grid (JSON or GeoJSON)
- `GET /v1/observations/live?minutes=15&band=20m`: Paths heard in the last minutes (PSK Reporter + WSPR)
- `GET /v1/geomagnetic/kp`: Kp history and the 3-day forecast
- `GET /v1/alerts`: NOAA alerts and detected sporadic-E openings

## Website

- [Home](https://ionoflux.runvia.app/): current conditions and global band conditions
- [Dashboard](https://ionoflux.runvia.app/dashboard): live solar, geomagnetic and ionosphere charts and maps
- [Path prediction](https://ionoflux.runvia.app/propagation): reliability and best frequencies between two places, with live FT8/WSPR evidence
- [Data status](https://ionoflux.runvia.app/data-status): what is collected and how fresh it is
- [Data sources and licenses](https://ionoflux.runvia.app/data-sources)
- [FAQ](https://ionoflux.runvia.app/faq): HF radio and space weather FAQ

## Guides

- [Solar flux (SFI / F10.7)](https://ionoflux.runvia.app/docs/sfi): A rough measure of the Sun's radio energy. Higher values often support higher HF bands.
- [Sunspot number](https://ionoflux.runvia.app/docs/sunspots): A count of visible active regions on the Sun, used as a simple indicator of solar activity.
- [Kp index](https://ionoflux.runvia.app/docs/kp): A 0–9 measure of global geomagnetic disturbance. Lower is usually calmer for HF.
- [GOES X-ray class](https://ionoflux.runvia.app/docs/xray): A near-real-time measure of solar X-rays; strong flares can cause short radio blackouts.
- [Solar wind and Bz](https://ionoflux.runvia.app/docs/solar-wind): Charged particles from the Sun; the Bz direction helps show how strongly they may disturb Earth's magnetic field.
- [NOAA R, S and G scales](https://ionoflux.runvia.app/docs/noaa-scales): Three 0–5 scales for radio blackouts, solar radiation storms and geomagnetic storms.
- [MUF (maximum usable frequency)](https://ionoflux.runvia.app/docs/muf): The highest frequency expected to return to Earth for a particular path and time.
- [TEC (total electron content)](https://ionoflux.runvia.app/docs/tec): The amount of free electrons along a column of the ionosphere; it describes ionization, not a band forecast by itself.
- [Path reliability](https://ionoflux.runvia.app/docs/reliability): The model's estimated chance that a path works at a selected frequency, time and mode.
- [Global band conditions](https://ionoflux.runvia.app/docs/band-conditions): The share of sampled 3,000 km paths where each amateur band is estimated to be open on the day or night side.

## Embeddable widgets

Free iframe widgets at https://ionoflux.runvia.app/embed/{id}: `invite` (IonoFlux introduction banner), `map` (Live ionosphere & propagation map), `bands` (Global band conditions), `path` (HF path prediction), `kp` (Kp index), `sfi` (Solar flux (F10.7)), `xray` (GOES X-ray flux), `indices` (Kp + solar flux + X-ray), `alerts` (Recent alerts), `dashboard` (Full dashboard).

## Optional

- [Full text of every guide and the FAQ](https://ionoflux.runvia.app/llms-full.txt)