Skip to main content
GET
/
api
/
v1
/
fields
/
{provider_field_id}
/
reports
/
runoff
Runoff Report
curl --request GET \
  --url https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff \
  --header 'X-API-Key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.acreblitz.com/llms.txt

Use this file to discover all available pages before exploring further.

Download the EPA Runoff Mitigation compliance report as a PDF for a specific field. The report includes runoff-specific limitation details, selected mitigations, soil data, and regulatory references.

​
Path Parameters

​
provider_field_id
string
required
The provider’s field identifier. This is the provider_field_id you submitted to /esa-check. If you didn’t provide a provider_field_id, use the application_id instead.

​
Query Parameters

​
year
integer
Report year. Defaults to the current year if not specified.

​
Response

On success, returns the PDF file as an application/pdf stream with appropriate Content-Disposition headers for download.

​
Error Codes

CodeDescription
400Invalid report parameters
401Invalid or missing API key
404Field not found or report not available
502Upstream report generation failed
504Report generation timed out

​
Example

cURL
curl -X GET "https://esa.acreblitz.com/api/v1/fields/job-2024-06-15-002/reports/runoff" \
  -H "X-API-Key: your_api_key_here" \
  -o runoff-report.pdf
cURL with year
curl -X GET "https://esa.acreblitz.com/api/v1/fields/job-2024-06-15-002/reports/runoff?year=2025" \
  -H "X-API-Key: your_api_key_here" \
  -o runoff-report-2025.pdf
The field must belong to your authenticated provider account and have completed an ESA check with a portal link before reports can be downloaded.