Runoff Report

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

import requests

url = "https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

GET

api

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>'

import requests

url = "https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://esa.acreblitz.com/api/v1/fields/{provider_field_id}/reports/runoff")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

Code	Description
`400`	Invalid report parameters
`401`	Invalid or missing API key
`404`	Field not found or report not available
`502`	Upstream report generation failed
`504`	Report 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.

Enlist Report

​Path Parameters

​Query Parameters

​Response

​Error Codes

​Example

Path Parameters

Query Parameters

Response

Error Codes

Example