docs/api reference/Property Batch
Home ↗
POST

Property Batch

Runs multiple property detail lookups in one request. Each item is processed independently, the response preserves input order, returns partial failures inline, and charges exactly 1 credit only for each successful item.

Path

/api/property/batch

Parameters

itemsarrayrequired

Array of 1 to 25 lookup items.

items[].idstring

Client-provided identifier echoed back in the result row.

items[].addressstringrequired

Property address for that item.

items[].countystringrequired

County for that item. Batch does not geocode counties automatically.

items[].latnumber

Optional latitude hint passed to the property resolver.

items[].lonnumber

Optional longitude hint passed to the property resolver.

items[].floodboolean

Set false to skip FEMA flood enrichment for that item.

items[].multiple_lossboolean

Set false to skip OpenFEMA multiple-loss enrichment for that item.

items[].crimeboolean

Set true to include crime enrichment for that item when supported.

items[].crime_radiusnumber

Crime radius in meters for that item when crime is enabled.

options.continueOnErrorboolean

Accepted for forward compatibility. Items already continue independently.

options.includeMetaboolean

Accepted for forward compatibility. Current response always includes summary metadata.

Sample Request Body

{
  "items": [
    {
      "id": "row-1",
      "address": "17136 Knoll Dale Trl",
      "county": "Montgomery",
      "flood": true,
      "multiple_loss": true
    },
    {
      "id": "row-2",
      "address": "999 Missing St",
      "county": "Harris",
      "flood": false,
      "multiple_loss": false
    }
  ],
  "options": {
    "continueOnError": true,
    "includeMeta": true
  }
}

Sample Response

{
  "ok": true,
  "requestId": "3f5304e5-87a5-4f4e-88c6-6db5647c9733",
  "summary": {
    "total": 2,
    "succeeded": 1,
    "failed": 1,
    "billed": 1,
    "creditsCharged": 1
  },
  "results": [
    {
      "id": "row-1",
      "ok": true,
      "status": 200,
      "billed": true,
      "creditsCharged": 1,
      "data": {
        "id": "TX-MONT-426661",
        "address": "17136 KNOLL DALE TRL, CONROE, TX 77385",
        "county": "Montgomery",
        "cadName": "MCAD",
        "owner": "MICHALSKI, JEFFREY & KATARZYNA MICHALSKI",
        "appraisedValue": 614446,
        "landValue": 36213,
        "improvementValue": 578233,
        "taxEstimate": 12903,
        "isSupported": true,
        "source": "live_api"
      }
    },
    {
      "id": "row-2",
      "ok": false,
      "status": 404,
      "billed": false,
      "creditsCharged": 0,
      "error": {
        "code": "PROPERTY_NOT_FOUND",
        "message": "Failed to fetch property details: provider_returned_no_property"
      }
    }
  ]
}