Overview

Base URL

All requests go to the same host these docs are served from:

https://app.flashweather.ai

A sandbox environment is available at https://test.app.flashweather.ai for integration testing. Paths and payloads are identical; the data is not production data.

Because the reference is served from the same origin as the API, the Send Request button on any operation issues a real call against the environment you are reading the docs on.

Before your first request

1. Get credentials. Either a bearer token (for user-scoped access) or an API key (for server-to-server). See Authentication.
2. Send a request. Every operation page has a live playground, fill in the parameters and press Send Request.
3. Mind the limits. See Rate limits.

Machine-readable schema

These docs are generated from an OpenAPI 3.0 document, and that document is served from /openapi-schema/ on the same host, no authentication required. It returns YAML by default, or JSON with ?format=json.

Point a generator at it to build a typed client, or import it into Postman or Insomnia rather than hand-writing requests:

# Production
curl -o flash-openapi.yaml  https://app.flashweather.ai/openapi-schema/
curl -o flash-openapi.json "https://app.flashweather.ai/openapi-schema/?format=json"

# Sandbox
curl -o flash-openapi.yaml  https://test.app.flashweather.ai/openapi-schema/

It is the same document this reference is built from, so anything documented here is in the schema.

Conventions

• All responses are JSON unless an operation documents otherwise. Several hail and severe-weather endpoints return GeoJSON.
• Coordinates are decimal degrees, lat then lon, WGS84.
• Times are ISO 8601 in UTC.