Skip to main content
POST
/
batch-lookups
cURL
curl -X POST "https://api.incentives.leap.energy/alpha/batch-lookups" -H "x-api-key: leap_live_..." -H "Content-Type: application/json" -d '{"items":[{"reference_id":"deal-001","address":{"street_1":"123 Main St","city":"San Francisco","state_or_province_code":"CA","postal_code":"94102","country_code":"US"},"building_type":"RESIDENTIAL","device_ids":[1]}]}'
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "total_items": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "report": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "processing",
    "report_type": "bulk_lookup",
    "total_sites": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>"
  },
  "message": "<string>"
}

​
Overview

Create a batch job with multiple addresses and device lookups. Items are validated upfront, then processed by a worker that runs every 5 minutes. A report is created immediately and sites are added as each item completes.
Include webhook_custom_fields on each item when your organization has a webhook URL configured; the backend merges them into the webhook payload for each completed lookup.
Poll GET /batch-lookups/{job_id} for job status and use GET /batch-lookups/{job_id}/items to retrieve results.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Include your Leap API key in the x-api-key header: x-api-key: leap_live_...

Body

application/json
​
items
object[]
required
Required array length: 1 - 10000 elements

Response

Batch job created successfully

​
job_id
string<uuid>
​
status
enum<string>
Available options:
pending
​
total_items
integer
​
created_at
string<date-time>
​
report
object
​
message
string