EagleView Request Property Summary Data (Bulk) API
The Request Property Summary Data (Bulk) API from EagleView — 1 operation(s) for request property summary data (bulk).
The Request Property Summary Data (Bulk) API from EagleView — 1 operation(s) for request property summary data (bulk).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eagleview:eagleview-request-property-summary-data-bulk-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 0.0.1
title: Property Data Request Property Summary Data (Bulk) API
description: '# Introduction
## About
EagleView''s Property Data API provides data elements that characterize the composition and condition of a requested property.'
servers:
- url: https://apis.eagleview.com
description: Basepath
tags:
- name: Request Property Summary Data (Bulk)
paths:
/property-summary/v2/batch/request:
post:
tags:
- Request Property Summary Data (Bulk)
security:
- bearerAuth: []
summary: Request Property Summary Data (Bulk)
description: 'Supported formats include complete addresses (single-line), multi-line addresses in US (street, city, state, zip), Canadian (street, city, province, postal), or Global (line1, locality, admin1, postal) formats with optional country field, coordinates (lat/lon), and AOI (area of interest) via geometry file (GeoJSON or CSV). Maximum of 10,000 properties per request for non-AOI formats; AOI requests limited to 1 record.
This endpoint initiates an asynchronous batch process and returns a batch ID with a 202 Accepted response. Use the batch ID with GET /property-summary/v2/batch/result/{batchId} to check status or retrieve results. Optionally, (1) provide a callback URL for automatic result delivery and (2) specify the response format (CSV or JSON) via the requestFile parameter. Results are always delivered as ZIP.'
operationId: POST/property-summary/v2/batch/request
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- requestFile
- locationType
properties:
requestFile:
type: string
format: binary
description: File containing property location data for bulk processing in CSV, JSON, or ZIP format; format and validation rules depend on the locationType value (coordinates, complete_address, multiline_address, or aoi); only one file per request is accepted and mixing location types will be rejected.
oneOf:
- $ref: '#/components/schemas/CoordinatesCSVFormat'
- $ref: '#/components/schemas/CoordinatesJSONFormat'
- $ref: '#/components/schemas/CompleteAddressCSVFormat'
- $ref: '#/components/schemas/CompleteAddressJSONFormat'
- $ref: '#/components/schemas/MultiLineAddressCSVFormat'
- $ref: '#/components/schemas/MultiLineAddressJSONFormat'
- $ref: '#/components/schemas/AOIGeoJSONFormat'
- $ref: '#/components/schemas/AOICSVFormat'
locationType:
type: string
enum:
- coordinates
- complete_address
- multiline_address
- aoi
description: Indicates how property location information is supplied in the requestFile . Allowed values are coordinates (lat/lon pairs), complete_address (single-line address), multiline_address (structured address), or aoi (area-of-interest polygon geometry); requests mixing different types will be rejected.
example: coordinates
callbackUrl:
type: string
description: Optional callback URL to receive results when processing is complete.
example: https://api.example.com/callback
responseFileType:
type: string
enum:
- csv
- json
description: Desired format for the result file when the batch completes. If no format specified, then default is same as that of the request file.
example: csv
encoding:
requestFile:
contentType: application/octet-stream
examples:
coordinates_csv:
summary: Coordinates CSV Request
description: Upload a CSV file records of geo coordinates.
value:
locationType: coordinates
responseFileType: csv
callbackUrl: https://api.example.com/callback
coordinates_json:
summary: Coordinates JSON Request
description: Upload a JSON file with an addresses array of geo coordinates.
value:
locationType: coordinates
responseFileType: json
callbackUrl: https://api.example.com/callback
address_csv:
summary: Multi-line Address CSV Request
description: Upload a CSV with multi-line addresses using region-specific columns (US, Canada, or global), with an optional but recommended country field.
value:
locationType: multiline_address
responseFileType: csv
callbackUrl: https://api.example.com/callback
address_json:
summary: Multi-line Address JSON Request
description: Upload a JSON file with multi-line addresses using region-specific fields (US, Canada, or global), with an optional but recommended country field.
value:
locationType: multiline_address
responseFileType: json
callbackUrl: https://api.example.com/callback
complete_address_csv:
summary: Complete Address CSV Request
description: Upload a CSV file with records of complete addresses.
value:
locationType: complete_address
responseFileType: csv
callbackUrl: https://api.example.com/callback
complete_address_json:
summary: Complete Address JSON Request
description: Upload a JSON file with array of complete addresses.
value:
locationType: complete_address
responseFileType: json
callbackUrl: https://api.example.com/callback
aoi_geojson:
summary: AOI GeoJSON Request
description: Upload a GeoJSON file with polygon geometry of a closed AOI.
value:
locationType: aoi
responseFileType: json
callbackUrl: https://api.example.com/callback
aoi_csv:
summary: AOI CSV Request
description: Upload a CSV file containing a single closed AOI polygon geometry.
value:
locationType: aoi
responseFileType: json
callbackUrl: https://api.example.com/callback
callbacks:
Get batch status Callback:
'{$request.body.callbackUrl}':
post:
requestBody:
description: The callback is a POST request with the batch results payload.
content:
application/json:
schema:
$ref: '#/components/schemas/GetBatchStatusResponse'
responses:
'200':
description: Your server implementation should return this HTTP status code if the data was received successfully
responses:
'202':
description: Accepted
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SummaryBatchStatusResponseV2'
- $ref: '#/components/schemas/AOIBatchSubmissionResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/model.Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/model.Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/model.Error'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/model.Error'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/model.Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/model.Error'
'503':
description: Service Unavailable
x-operation-id-source: normalized
x-operation-id-original: POST /property-summary/v2/batch/request
components:
schemas:
CompleteAddressCSVFormat:
type: string
format: binary
description: 'CSV file with complete address data containing refId and completeAddress columns.
**File Content Example:**
```
refId,completeAddress
PROP_001,123 Main St New York NY 10001 US
PROP_002,456 Oak Ave Los Angeles CA 90210 US
```'
MultiLineAddressJSONFormat:
type: string
format: binary
description: "JSON file with multi-line addresses supporting US, Canadian, and Global formats.\n\n**Format Guidelines:**\n- Street address: 'street' (US/Canada) or 'line1' (global)\n- City/locality: 'city' (US/Canada) or 'locality' (global)\n- Administrative area: 'state' (US) or 'province' (Canada) or 'admin1' (global)\n- Postal code: 'zip' (US) or 'postal' (Canada/global)\n- The 'country' field is optional, but recommended.\n\n**File Content Example:**\n```json\n{\n \"addresses\": [\n {\n \"refId\": \"PROP_001\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\"\n }\n },\n {\n \"refId\": \"PROP_002\",\n \"address\": {\n \"street\": \"189 Brookside Dr\",\n \"city\": \"Toronto\",\n \"province\": \"ON\",\n \"postal\": \"M4E 2M5\",\n \"country\": \"Canada\"\n }\n },\n {\n \"refId\": \"PROP_003\",\n \"address\": {\n \"line1\": \"33 Kingsway\",\n \"locality\": \"London\",\n \"admin1\": \"London\",\n \"postal\": \"WC2B 6UF\",\n \"country\": \"United Kingdom\"\n }\n }\n ]\n}\n```"
CoordinatesJSONFormat:
type: string
format: binary
description: "JSON file with addresses array containing objects with refId, lat, and lon.\n\n**File Content Example:**\n```json\n{\n \"addresses\": [\n {\n \"refId\": \"PROP_001\",\n \"lat\": 40.7589,\n \"lon\": -73.9851\n },\n {\n \"refId\": \"PROP_002\",\n \"lat\": 34.0522,\n \"lon\": -118.2437\n }\n ]\n}\n```"
MultiLineAddressCSVFormat:
type: string
format: binary
description: 'CSV file with multi-line address data supporting US, Canadian, and Global formats.
**Format Guidelines:**
- Street address: ''street'' (US/Canada) or ''line1'' (global)
- City/locality: ''city'' (US/Canada) or ''locality'' (global)
- Administrative area: ''state'' (US) or ''province'' (Canada) or ''admin1'' (global)
- Postal code: ''zip'' (US) or ''postal'' (Canada/global)
- The ''country'' field is optional, but recommended.
**Example 1:**
```csv
refId,street,city,state,zip,country
PROP_001,123 Main St,New York,NY,10001,US
```
**Example 2:**
```csv
refId,street,city,province,postal,country
PROP_002,189 Brookside Dr,Toronto,ON,M4E 2M5,Canada
```
**Example 3:**
```csv
refId,line1,locality,admin1,postal,country
PROP_003,33 Kingsway,London,London,WC2B 6UF,GB
```
**Note:** You can use any one label from each field group (e.g., ''street'' OR ''line1''), but don''t use both in the same file.'
GetBatchStatusResponse:
type: object
description: Response for completed bulk summary batch - results available for download
properties:
batchId:
type: string
example: 5decd115-771d-4fcc-9d13-0e357a1cacb3
description: Unique reference identifier for batch request, in UUID v4 format
batchStatus:
type: string
example: completed
description: 'Processing state of the batch. Possible values: ''processing'', ''completed'', ''failed'''
data:
$ref: '#/components/schemas/BatchData'
requestSubmittedTime:
type: string
example: '2026-05-14T11:41:53Z'
description: Timestamp when the batch request was submitted
input:
$ref: '#/components/schemas/BatchInput'
BatchInput:
type: object
description: URLs for the original input files submitted with the batch request
properties:
fileUrl:
type: string
example: https://input_file_url
description: URL to download the original input file provided with the batch request
requestDetailUrl:
type: string
example: https://request_details_file_url
description: URL to download the request details file (locationType, callbackUrl, responseFileType, etc.)
SummaryBatchStatusResponseV2:
type: object
description: Response for bulk summary request creation
properties:
href:
type: string
example: /property-summary/v2/batch/result/5decd115-771d-4fcc-9d13-0e357a1cacb3
description: Relative URL path to retrieve the batch status
batchId:
type: string
example: 5decd115-771d-4fcc-9d13-0e357a1cacb3
description: System-generated batch ID, in UUID v4 format, to uniquely identify the batch request
batchStatus:
type: string
example: processing
description: 'Processing state of the batch. Possible values: ''processing'', ''completed'', ''failed'''
total:
type: integer
example: 100
description: Total number of records in the batch request
AOIGeoJSONFormat:
type: string
format: binary
description: "Request for bulk data by submitting an AOI by uploading a single .geojson (optionally zipped containing exactly one file) that defines an AOI. Only 1 AOI is allowed in a request.\n\nSupports both **Polygon** and **MultiPolygon** geometry types. Properties `aoiRefId` and `aoiRefName` are optional identifiers on each feature.\n\n**Example — Polygon:**\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"aoiRefId\": \"aoi_sample\",\n \"aoiRefName\": \"aoi_test_zone\"\n },\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [-95.98883738717981, 41.25051910100504],\n [-95.98888377206586, 41.24958248563834],\n [-95.9882211308413, 41.249632305942356],\n [-95.98824101007766, 41.25059383037666],\n [-95.98883738717981, 41.25051910100504]\n ]\n ]\n }\n }\n ]\n}\n```\n\n**Example — MultiPolygon:**\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"aoiRefId\": \"aoi_sample\",\n \"aoiRefName\": \"aoi_test_zone\"\n },\n \"geometry\": {\n \"type\": \"MultiPolygon\",\n \"coordinates\": [\n [\n [\n [-95.98883738717981, 41.25051910100504],\n [-95.98888377206586, 41.24958248563834],\n [-95.9882211308413, 41.249632305942356],\n [-95.98824101007766, 41.25059383037666],\n [-95.98883738717981, 41.25051910100504]\n ]\n ],\n [\n [\n [-95.98611242739636, 41.248901590642674],\n [-95.98537745174536, 41.248901590642674],\n [-95.98537745174536, 41.25015470345761],\n [-95.98611242739636, 41.25015470345761],\n [-95.98611242739636, 41.248901590642674]\n ]\n ]\n ]\n }\n }\n ]\n}\n```"
CompleteAddressJSONFormat:
type: string
format: binary
description: "JSON file with an addresses array where each object contains a refId and a nested address object with a completeAddress field (single-line full address).\n\n**File Content Example:**\n```json\n{\n \"addresses\": [\n {\n \"refId\": \"PROP_001\",\n \"address\": {\n \"completeAddress\": \"123 Main St New York NY 10001 US\"\n }\n },\n {\n \"refId\": \"PROP_002\",\n \"address\": {\n \"completeAddress\": \"456 Oak Ave Los Angeles CA 90210 US\"\n }\n }\n ]\n}\n```"
CoordinatesCSVFormat:
type: string
format: binary
description: 'CSV file with coordinate data containing refId, lat, and lon columns.
**File Content Example:**
```
refId,lat,lon
PROP_001,40.7589,-73.9851
PROP_002,34.0522,-118.2437
```'
BatchData:
type: object
description: Result data for a completed batch, broken into downloadable chunks
properties:
total:
type: integer
example: 10
description: Total number of records in the batch result
chunkDetail:
type: array
description: List of result chunks, each containing a download URL and pagination metadata
items:
$ref: '#/components/schemas/BatchChunkDetail'
BatchChunkDetail:
type: object
description: Details for a single result chunk
properties:
chunkId:
type: string
example: '1'
description: Identifier of the chunk
chunkUrl:
type: string
example: https://chunk1_download_url
description: Pre-signed URL to download this chunk's result file
offset:
type: integer
example: 0
description: Zero-based record offset of the first record in this chunk
limit:
type: integer
example: 10
description: Maximum number of records in this chunk
model.Error:
type: object
properties:
errorCode:
type: integer
description: Machine-readable code that identifies the type of error.
errorDescription:
type: string
description: Human-readable message that describes the error condition.
AOICSVFormat:
type: string
format: binary
description: 'Request for bulk data by submitting an AOI by uploading a single .csv (optionally zipped containing exactly one file) that defines an AOI. Only 1 AOI is allowed in a request.
Required column: `geometry` (WKT format — POLYGON or MULTIPOLYGON). Optional column: `aoiRefId`.
**Example — Polygon:**
```
aoiRefId,geometry
aoi_sample,"POLYGON ((-95.98883738717981 41.25051910100504, -95.98888377206586 41.24958248563834, -95.9882211308413 41.249632305942356, -95.98824101007766 41.25059383037666, -95.98883738717981 41.25051910100504))"
```
**Example — MultiPolygon:**
```
aoiRefId,geometry
aoi_sample,"MULTIPOLYGON (((-95.98883738717981 41.25051910100504, -95.98888377206586 41.24958248563834, -95.9882211308413 41.249632305942356, -95.98824101007766 41.25059383037666, -95.98883738717981 41.25051910100504)), ((-95.98611242739636 41.248901590642674, -95.98537745174536 41.248901590642674, -95.98537745174536 41.25015470345761, -95.98611242739636 41.25015470345761, -95.98611242739636 41.248901590642674)))"
```'
AOIBatchSubmissionResponse:
type: object
description: Response for AOI bulk batch request submission
properties:
href:
type: string
description: Relative URL path to retrieve the batch status
batchId:
type: string
description: System-generated batch ID, in UUID v4 format, to uniquely identify the batch request
batchStatus:
type: string
example: processing
description: 'Processing state: ''processing'', ''completed'', or ''failed'''
area:
$ref: '#/components/schemas/AOIArea'
total:
type: integer
description: Total number of records in the batch request
example: 42
AOIArea:
type: object
description: Polygon area for the requested aoi
properties:
value:
type: number
format: double
example: 2.5
unit:
type: string
example: square miles
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-tagGroups:
- name: PROPERTY DATA API
tags:
- Request Property Data
- Get Results
- Request Property Data (Bulk)
- Get Property Data (Bulk)
- name: IMAGE API
tags:
- Image Retrieval
- name: Property Summary Data API
tags:
- Request Property Summary Data
- Get Property Summary Data
- Request Property Summary Data (Bulk)
- Get Property Summary Data (Bulk)