logo
Welcome
Overview
Getting Started
Data Formats
Examples
API Reference
Authentication
Map Tiles
Esri Integration
Map Layer Tiles
Query
Daily
Hourly
Last 48 Hours
Recent Rain
powered by zuplo
Sign in

Precip API

See below for our available endpoints.

BASE URL
https://api.precip.ai

Authentication

Sign into view and manage your API credentials

Map Tiles

ENDPOINTS
GET/api/v1/map/:serviceName/ImageServer
GET/api/v1/map/:serviceName/ImageServer/tile/:z/:y/:x
GET/api/v1/map/:serviceName/ImageServer/getSamples

Esri Integration

Image Service compatible with Esri products. This url eg https://api.precip.ai/api/v1/map/last-48/ImageServer can be added to ArcGIS Online, ArcGIS Pro or QGIS.

Path Parameters

serviceName

required, string

The layer or service name.

  • last-48 - total precipitation in the last 48 hours
  • hourly - total hourly precipitation
  • wind-speed-hourly - average hourly wind speed
  • wind-direction-hourly - average hourly wind direction
  • temperature-hourly - average hourly temperature
GET
/api/v1/map/:serviceName/ImageServer
1

Map Layer Tiles

Map tiles compatible with most web mapping or GIS tools. Software such as Mapbox, Google Maps, ArcGIS, Leaflet, OpenLayers or QGIS will require an x/y/z url eg https://api.precip.ai/api/v1/map/last-48/ImageServer/tile/{z}/{y}/{x}. See the examples for more details.

Query Parameters

time

optional, string

<start timestamp>,<end timestamp>

Path Parameters

serviceName

required, string

The layer or service name.

  • last-48 - total precipitation in the last 48 hours
  • hourly - total hourly precipitation
  • wind-speed-hourly - average hourly wind speed
  • wind-direction-hourly - average hourly wind direction
  • temperature-hourly - average hourly temperature

x

required, integer

map tile id x

y

required, integer

map tile id y

z

required, integer

map tile id z

GET
/api/v1/map/:serviceName/ImageServer/tile/:z/:y/:x
1

Query

Query value of map tiles at point(s).

Query Parameters

geometry

required, object

points to query

geometryType

required, string

time

optional, string

<start timestamp>,<end timestamp>

Path Parameters

serviceName

required, string

The layer or service name.

  • last-48 - total precipitation in the last 48 hours
  • hourly - total hourly precipitation
  • wind-speed-hourly - average hourly wind speed
  • wind-direction-hourly - average hourly wind direction
  • temperature-hourly - average hourly temperature
GET
/api/v1/map/:serviceName/ImageServer/getSamples
1

Daily

Returns daily precipitation data for the given time range and location(s). Includes historical and/or forecast data depending on the time range requested.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

start

required, string

ISO 8601 date %Y-%m-%d or datetime %Y-%m-%dT%H:%M:%S

end

required, string

ISO 8601 date %Y-%m-%d or datetime %Y-%m-%dT%H:%M:%S

longitude

required, string

comma separated list of longitudes

latitude

required, string

comma separated list of latitudes

timeZoneId

optional, string

IANA timezone identifier e.g. America/Chicago

format

optional, default: geojson

Output format: geojson, json or csv

GET
/api/v1/daily
1

Hourly

Returns hourly precipitation data for the given time range and location(s). Includes historical and/or forecast data depending on the time range requested.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

start

required, string

ISO 8601 date %Y-%m-%d or datetime %Y-%m-%dT%H:%M:%S

end

required, string

ISO 8601 date %Y-%m-%d or datetime %Y-%m-%dT%H:%M:%S

longitude

required, string

comma separated list of longitudes

latitude

required, string

comma separated list of latitudes

timeZoneId

optional, string

IANA timezone identifier e.g. America/Chicago

format

optional, default: geojson

Output format: geojson, json or csv

GET
/api/v1/hourly
1

Last 48 Hours

Total precipitation in the last 48 hours for the given location(s).

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

longitude

required, string

comma separated list of longitudes

latitude

required, string

comma separated list of latitudes

timeZoneId

optional, string

IANA timezone identifier e.g. America/Chicago

format

optional, default: geojson

Output format: geojson, json or csv

GET
/api/v1/last-48
1

Recent Rain

Returns the most recent rain event for the given location(s). How long ago and how much it rained. An event is defined as more than 1/10 inch of rain with less than a 24 hour gap.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

longitude

required, string

comma separated list of longitudes

latitude

required, string

comma separated list of latitudes

timeZoneId

optional, string

IANA timezone identifier e.g. America/Chicago

format

optional, default: geojson

Output format: geojson, json or csv

GET
/api/v1/recent-rain
1