The API methods are organized by categories such as accounts, batch, divisions, and test. Each category contains related methods, like batch.upload (to upload your data in XML format) and batch.download (to download your data in XML format).

Methods are referred to in dot notation: batch.download refers to the download method in the batch category of methods.

For more detailed information on each method, see the API Methods documentation.

Every call made to the New Home Feed API must include the "api_key" parameter. This parameter identifies you and ensures that no one else can see your data. Your API key can be found on your connections page. If you do not have an account with us or have trouble locating your API key, please contact support.

The base path to the API is:

http://api.newhomefeed.com/v1

To call a specific method, add the method category and name as follows:

http://api.newhomefeed.com/v1/$method_category/$method_name?$parameter_list

To fetch all your listings in New Home Feed formatted XML, use:

http://api.newhomefeed.com/v1/batch/download?api_key=your_api_key&builder_id=123

To fetch all your listings in New Home Source (BDX) formatted XML, use:

http://api.newhomefeed.com/v1/batch/download?api_key=your_api_key&builder_id=123&format=bdx

To post your listings to New Home Feed using New Home Source (BDX) formatted XML, use:

http://api.newhomefeed.com/v1/batch/upload?api_key=your_api_key&format=bdx&data=...

The API accepts calls sent as both HTTP GET and POST. However, due to GET's data size limits, any calls sending significant amounts of data should use POST.

The New Home Feed API expects all data to be UTF-8 encoded. Checks are made for valid UTF-8 sequences. If an invalid sequence is found, the data is presumed to be ISO-8859-1 and converted accordingly to UTF-8. Sending data in any other encoding will result in garbage into New Home Feed. It won't be dangerous garbage (we will always store valid UTF-8) but it may have unintended consequences.

Each inventory item in New Home Feed has two dates - the 'created' date and the 'updated' date. These are system-generated read-only values and can't be changed by the user. The 'created' date represents the time at which the inventory item was added to New Home Feed. The 'updated' date represents the time at which the inventory item was last changed in New Home Feed. This is set at the time the item is saved. Dates are supplied in GMT as a unix timestamp, which is an unsigned integer specifying the number of seconds since Jan 1st 1970 GMT.