Methods

Accounts

Batch

Divisions

Test

batch.download

Arguments

api_key (Required)

Your API application key.

builder_id (Optional)

If your account type supports multiple builders, you may pass in the New Home Feed ID of a single builder you want to retrieve information for. Otherwise, all data for all builders will be returned, subject to permissions.

format (Optional, see below. Default: 'nhf')

Format of returned inventory data packet. See here for allowed values. Data returned in New Home Feed XML schema by default for builders; channels will receive data in their preferred format.

Sample Request

// Return listings for builder 123 in New Home Feed XML format
http://api.newhomefeed.com/v1/batch/download?api_key=your_api_key&builder_id=123

// Return listings for all allowed builders in BDX format
http://api.newhomefeed.com/v1/batch/download?api_key=your_api_key&format=bdx

Example Response

See XML Specifications for possible return schemas

Error Codes

See here for a complete list of error codes.