Precipitation & Weather Data API

Bulk Export

Endpointhttps://api.precip.ai

Bulk data export for multiple locations

Create Bulk Export

POST

https://api.precip.ai

/api/v1/reports

Create an async export job for weather data across multiple locations. For small requests (< 30s processing), returns download URL immediately. For larger requests, sends email notification when export is ready.

Requires API key with orgId/userId metadata to use allLocations option.

Create Bulk Export › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key.

Example: Bearer YOUR_API_KEY

Create Bulk Export › Request Body

models

string[] · required

Weather models to include in export

Enum values:

precip

soil-moisture

temp-0-10cm

temperature

specific-humidity

relative-humidity

wind-speed

wind-speed-gust

Example: {"0":"precip","1":"temperature"}

Default: ["precip"]

start

string · date · required

Start date in ISO 8601 format

Example: 2024-01-01

Default: 2024-01-01

end

string · date · required

End date in ISO 8601 format

Example: 2024-03-01

Default: 2024-03-01

aggregations

string[] · required

Time aggregations to include

Enum values:

hourly

daily

weekly

monthly

Example: {"0":"daily","1":"monthly"}

Default: ["monthly"]

units

string · enum

Unit system for measurements

Enum values:

imperial

metric

Default: imperial

format

string · enum

Export file format

Enum values:

xlsx

json

Default: xlsx

allLocations

boolean

Export all locations associated with your API key (requires orgId/userId metadata)

locationIds

string[]

Specific location IDs to export (alternative to allLocations)

webhookUrl

string · uri

Optional webhook URL to call when export completes

Create Bulk Export › Responses

Export created successfully

status

string · enum

completed = download URL ready, processing = will email when done

Enum values:

completed

processing

downloadUrl

string

Signed URL to download export (only when status=completed)

message

string

Status message (when processing)

format

string

Export format

POST/api/v1/reports

curl --request POST \
  --url https://api.precip.ai/api/v1/reports \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "models": [
    "precip"
  ],
  "start": "2024-08-25",
  "end": "2024-08-25",
  "aggregations": [
    "hourly"
  ],
  "units": "imperial",
  "format": "xlsx",
  "allLocations": true,
  "locationIds": [
    "string"
  ],
  "webhookUrl": "https://www.example.com/path/to/resource"
}
'

shell

Example Request Body

{
  "models": [
    "precip"
  ],
  "start": "2024-08-25",
  "end": "2024-08-25",
  "aggregations": [
    "hourly"
  ],
  "units": "imperial",
  "format": "xlsx",
  "allLocations": true,
  "locationIds": [
    "string"
  ],
  "webhookUrl": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "status": "completed",
  "downloadUrl": "https://storage.googleapis.com/precip-exports/...",
  "format": "xlsx"
}

json

application/json

Atmospheric Data Map Services

Precipitation & Weather Data API

Bulk Export

Endpointhttps://api.precip.ai

Bulk data export for multiple locations

Create Bulk Export

POST

https://api.precip.ai

/api/v1/reports

Requires API key with orgId/userId metadata to use allLocations option.

Create Bulk Export › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key.

Example: Bearer YOUR_API_KEY

Create Bulk Export › Request Body

models

string[] · required

Weather models to include in export

Enum values:

precip

soil-moisture

temp-0-10cm

temperature

specific-humidity

relative-humidity

wind-speed

wind-speed-gust

Example: {"0":"precip","1":"temperature"}

Default: ["precip"]

start

string · date · required

Start date in ISO 8601 format

Example: 2024-01-01

Default: 2024-01-01

end

string · date · required

End date in ISO 8601 format

Example: 2024-03-01

Default: 2024-03-01

aggregations

string[] · required

Time aggregations to include

Enum values:

hourly

daily

weekly

monthly

Example: {"0":"daily","1":"monthly"}

Default: ["monthly"]

units

string · enum

Unit system for measurements

Enum values:

imperial

metric

Default: imperial

format

string · enum

Export file format

Enum values:

xlsx

json

Default: xlsx

allLocations

boolean

Export all locations associated with your API key (requires orgId/userId metadata)

locationIds

string[]

Specific location IDs to export (alternative to allLocations)

webhookUrl

string · uri

Optional webhook URL to call when export completes

Create Bulk Export › Responses

Export created successfully

status

string · enum

completed = download URL ready, processing = will email when done

Enum values:

completed

processing

downloadUrl

string

Signed URL to download export (only when status=completed)

message

string

Status message (when processing)

format

string

Export format

POST/api/v1/reports

curl --request POST \
  --url https://api.precip.ai/api/v1/reports \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "models": [
    "precip"
  ],
  "start": "2024-08-25",
  "end": "2024-08-25",
  "aggregations": [
    "hourly"
  ],
  "units": "imperial",
  "format": "xlsx",
  "allLocations": true,
  "locationIds": [
    "string"
  ],
  "webhookUrl": "https://www.example.com/path/to/resource"
}
'

shell

Example Request Body

{
  "models": [
    "precip"
  ],
  "start": "2024-08-25",
  "end": "2024-08-25",
  "aggregations": [
    "hourly"
  ],
  "units": "imperial",
  "format": "xlsx",
  "allLocations": true,
  "locationIds": [
    "string"
  ],
  "webhookUrl": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "status": "completed",
  "downloadUrl": "https://storage.googleapis.com/precip-exports/...",
  "format": "xlsx"
}

json

application/json

Atmospheric Data Map Services