CSV Builder
CSV Builder runs a Property Search and returns a CSV instead of JSON, with a column map you control. Point it at a webhook URL and it will deliver the finished file there.
POST/v2/CSVBuilder
Build a CSV export
Request attributes
- Name
file_name- Type
- string
- Description
Name for the generated file.
- Name
map- Type
- array
- Description
The columns to include, in order.
- Name
webcomplete_url- Type
- string
- Description
URL to call when the file is ready.
- Name
ids- Type
- array
- Description
Restrict the export to specific property IDs.
- Name
count- Type
- boolean
- Description
Return the match count instead of building a file.
- Name
size- Type
- integer
- Description
Number of records to include.
- Name
resultIndex- Type
- integer
- Description
Offset to start from.
- Name
city- Type
- string
- Description
City to search.
- Name
state- Type
- string
- Description
Two-character state code.
- Name
county- Type
- string
- Description
County to search.
- Name
zip- Type
- string
- Description
Five-digit ZIP code.
- Name
latitude- Type
- number
- Description
Latitude for a radius search.
- Name
longitude- Type
- number
- Description
Longitude for a radius search.
- Name
radius- Type
- number
- Description
Radius in miles.
- Name
polygon- Type
- array
- Description
Polygon bounding the search area.
Request
POST
/v2/CSVBuildercurl -X POST https://api.realestateapi.com/v2/CSVBuilder \
-H "x-api-key: $REALESTATEAPI_KEY" \
-H "Content-Type: application/json" \
-d '{"file_name": "austin-list", "city": "Austin", "state": "TX", "map": ["address", "owner1LastName"]}'
The full response schema for this endpoint — every field and enum — lives in the canonical reference. That content has not been ported to this site yet.