Daft.ie API V1 documentation and reference
Table of contents
Prerequisites
This document assumes the reader is familiar with web development and programming for the web. Also, that API users have accepted the terms & conditions expressed on the API terms page.
Overview
Aim
The aim of the Daft.ie API is to open up a subset of Daft.ie's property data to third-party developers.
- Commercial users, such as estate agent clients of Daft.ie, who would like to build their own property search applications.
Structure
The Daft.ie API uses the XML-based SOAP protocol over HTTP.
Back to topUsing the API
Authentication
Each request to the API must be accompanied by an "API key". These keys are in the form of a hex string, not more than 40 characters in length.
Obtaining an API key
- Users of agent accounts will need to contact their Daft.ie account manager. Contact details can be found on the main Daft.ie website.
Generic errors
In addition to specific errors for each request, there are a number of generic errors that any request can return.
Error type | Message | Reason |
---|---|---|
PermissionFailure | You do not have permission to perform this action. | This can have a number of causes, but it may typically occur because your account:
|
AuthenticationFailure | Authentication failed. | This error usually means that your API key is invalid, malformed, or that you are attempting to use the API from a network not agreed upon with Daft.ie support. |
UnknownFailure | Request failed for an unknown reason. | Something went wrong, and the cause was not apparent. You will need to contact Daft.ie support to resolve this problem. |
Request reference
ad_types
Overview
ad_types
: List all the ad types and their associated alternative texts.
Examples
Code samples are available for this request.
Arguments
No arguments.
Return value
ad_types
returns an array of ad types. Each ad type has four values:
Name | Type | Description |
---|---|---|
name | string | Identifier for this ad type. Examples: "sale", "rental" |
desc | string | Long description of this ad type. Example: "property for sale" |
desc_plural | string | Long plural description of this ad type. Example: "properties for sale" |
desc_short | string | Short description of this ad type. Example: "for sale" |
Errors
There are no extra errors specific to this request.
Back to topproperty_types
Overview
property_types
: List the property types (house, apartment, bungalow, etc) for a particular ad type.
Examples
Code samples are available for this request.
Arguments
Name | Type | Required | Description |
---|---|---|---|
ad_type | string | Required | A valid ad type. Ad types are available from the ad_types request, or from the table in Appendix 1. |
Return value
property_types
returns an array of property types. Each property type contains the following elements:
Name | Type | Description |
---|---|---|
name | string | Long singular form of the name. Example: "Apartment For Sale" |
plural | string | Long plural form of the name. Example: "Apartments For Sale" |
short | string | Short singular form of the name. Lowercase. Example: "apartment" |
short_plural | string | Short plural form of the name. Lowercase. Example: "apartments" |
Errors
Error type | Message | Reason |
---|---|---|
NoMatchFailure | Invalid ad type: | You specified an invalid ad_type . Correct values can be found by using the ad_types function, or by consulting the table in Appendix 1 |
areas
Overview
areas
: Look up areas, counties, cities, postcodes, etc.
Examples
Code samples are available for this request.
Arguments
Name | Type | Required | Description |
---|---|---|---|
area_type | string | Required | A valid area_type :
|
ad_type | string | Optional |
A valid Examples: "sale", "rental" - full listing in the reference table in Appendix 1 |
county | integer array | Optional |
Limit areas to those inside a county, or set of counties. A list of counties and associated IDs can be found by querying the areas request with an area_type of county .
This argument is valid for the following
|
city | integer array | Optional |
Limit areas to those inside a city, or set of cities. A list of cities and associated IDs can be found by querying the areas request with an area_type of city .
This argument is valid for the following
|
general | integer array | Optional |
Limit areas to those inside a general area, or set of general areas. A list of general areas and associated IDs can be found by querying the areas request with an area_type of general .
This argument is valid for the following
|
Return value
If successful, areas
returns an array of areas. Each "area" is an array with three elements:
Name | Type | Description |
---|---|---|
name | string | Area name, like "Tallaght", "Dublin 9", "Belfast Commuter Towns" |
id | integer | The ID of this area. This ID can be used for the 'county', 'city' and 'general' arguments to narrow your search. |
properties | integer | A count of the number of properties matching ad_type in this area. If no ad_type is supplied, this value is -1. |
Errors
Error type | Message | Reason |
---|---|---|
NoMatchFailure | Invalid area type: | You specified an invalid area_type . Correct values can be found in the description for the area_type argument above. |
NoMatchFailure | Invalid ad type: | You specified an invalid ad_type . Correct values can be obtained from the ad_types function. |
features
Overview
features
: List the predefined features (parking, heating, TV, etc) for a particular ad type.
N.B. This function does note return the list of features associated with a particular ad, but rather the list of possible features.
Examples
Code samples are available for this request.
Arguments
Name | Type | Required | Description |
---|---|---|---|
ad_type | string | Required | A valid ad type. Ad types are available from the ad_types request, or from the table in Appendix 1.
Note: The 'sale' ad type does not have a predefined set of features. Each sale ad has it's own user-generated set of features, so the |
Return value
features
returns an array. Each entry in the array has the following elements:
Name | Type | Description |
---|---|---|
id | integer | Numeric ID for this features on this ad_type. Note that the features vary for different ad_types. |
name | integer | Examples: "Parking", "Central Heating", "House Alarm", "Pets Allowed" |
Errors
Error type | Message | Reason |
---|---|---|
NoMatchFailure | Invalid ad type: | You specified an invalid ad_type . Correct values can be found by using the ad_types function, or by consulting the table in Appendix 1 |
search_sale
Overview
search_sale
: Perform a search for "for sale" property.
Examples
Code samples are available for this request.
Search Arguments
The arguments are common for all property search requests, and are listed in the table below. All property search requests use a common set of arguments. Not all arguments apply to all ad types, and these are marked as such.
Name | Type | Required | Description |
---|---|---|---|
id | integer | Optional | The ID number of a sale ad. This can be used to retrieve data for just one ad. |
property_type | string array | Optional |
The short names of any property types to include in the search. Valid short names can be found by using the property_types request for the appropriate ad type. Examples: 'house', 'apartment', 'site'
|
bedrooms | integer | Optional | The exact number of bedrooms. |
min_bedrooms | integer | Optional | The minimum number of bedrooms. |
max_bedrooms | integer | Optional | The maximum number of bedrooms. |
min_price | integer | Optional | The minimum price in euro. |
max_price | integer | Optional | The maximum price in euro. |
txt | string | Optional | Perform a case-insensitive match on property descriptions. Search terms are delimited by spaces. Examples: "mantelpiece", "attic" |
agreed | integer | Optional | The "sale agreed" or "rental agreed" status. Values:
|
days_old | integer | Optional |
The maximum number of days since the property ad was made live. For example, to search for properties added in the last week, set days_old to 7.
|
images | integer | Optional |
Whether an ad has any images or not.
Values:
|
features | integer array | Optional |
The id numbers of any features a property must have. The list of valid features is available from the features request.
This argument applies only to rental and commercial ads. |
available_date | integer | Optional |
A UNIX-timestamp formatted date for the earliest date that properties should be available from.
This argument applies only to rental ads. |
lease_length | integer | Optional |
An integer number of months for the lease. Common lease lengths are 3, 6, 9, 12, 18, etc.
This argument applies only to rental ads. |
rent_allowance | integer | Optional | This item is deprecated |
furnished | integer array | Optional |
The furnished state of the property.
This argument applies only to rental ads. |
single_beds | integer | Optional |
The number of single bedrooms.
This argument applies only to rental ads. |
twin_beds | integer | Optional |
The number of twin bedrooms. (Two single beds in one room)
This argument applies only to rental ads. |
double_beds | integer | Optional |
The number of double bedrooms. (One double bed)
This argument applies only to rental ads. |
Location | |||
counties | integer array | Optional | The ID number of a county to include in the search. Valid IDs can be found by using the areas request.
Forward-compatibility warning: This value is an array of integers, and only the first one is used. In future releases of the Daft API, all values will be considered, allowing multiple counties to be searched at once.
Conflict warning: If the |
cities | integer array | Optional | The ID number of a city to include in the search. Valid IDs can be found by using the areas request.
Forward-compatibility warning: This value is an array of integers, and only the first one is used. In future releases of the Daft API, all values will be considered, allowing multiple cities to be searched at once.
Conflict warning: If the |
general_areas | integer array | Optional |
The ID numbers of any general areas to include in the search. Valid IDs can be found by using the areas request.
|
areas | integer array | Optional |
The ID numbers of any areas to include in the search. Valid IDs can be found by using the areas request.
|
postcodes | integer array | Optional |
The ID number of any postcodes to include in the search. Valid IDs can be found by using the areas request.
|
address | string | Optional | Perform a case-insensitive match on street names. Examples: "Bridge St", "Main st" |
Pagination options | |||
perpage | integer | Optional | The number of properties to return for one page. Default: 10
Limitation warning: Most users will be limited to specifying values no larger than the default. If this causes a problem for you, contact Daft Support to remove this restriction. |
page | integer | Optional | Which page of results to return. Valid page numbers can be found from the 'pagination' section of a set of property results. Default: 1 |
Sorting options | |||
sort_by | string | Optional | How to sort the property results. Values:
|
sort_ascending | boolean | Optional | Controls the sort order for use with the sort_by parameter. Default: true |
distance_sort_latitude | float | Optional | A latitude to use with the distance_custom sort type above. |
distance_sort_longitude | float | Optional | A longitude to use with the distance_custom sort type above. |
Return value
If successful, search_sale
returns three elements:
- pagination: an array with data about the number of results, number of pages, etc.
- search_sentence: a string with a short sentence summarising the search. Example: "properties for sale anywhere in Ireland"
- ads: an array of matching properties
Pagination
Name | Type | Description |
---|---|---|
total_results | integer | The total number of property ads matched by your search. |
results_per_page | integer | The number of results per "page" of results. You may be able to adjust this with the perpage query argument. |
num_pages | integer | The number of pages of results, based on total_results and results_per_page |
current_page | integer | The current page of results. |
first_on_page | integer | The index number of the first result on this page. For the first page it is 1, second page is 11, etc. (Example assumes ten results per page) |
last_on_page | integer | The index number of the last result on this page. For the first page it is 10, second page is 20, etc. (Example assumes ten results per page) |
Results
Name | Type | Description |
---|---|---|
ad_id | integer | The ID number of this sale ad. |
daft_url | string | A URL to this property on Daft.ie. |
property_type | string | Examples: 'house', 'apartment', 'site' |
house_type | string | The type of house. Possible values:
|
selling_type | string | The sale method. Examples: 'auction', 'private-treaty' |
price_type | string | The type of price. Examples: 'region', 'excess', 'on-application' |
agreed | integer |
Whether a sale has been agreed for this property or not.
|
priority | integer |
The priority of this ad.
|
description | string | A full-text description of this property. Example: "This lovely property is situated beside ..." |
price | integer | The price of this property, in euro. |
bathrooms | integer | The number of bathrooms in this property. |
bedrooms | integer | The number of bedrooms in this property. |
tax_section | string | The section of the tax code this property falls under. Examples: "Section 23", "Section 27" |
square_metres | float | The amount of internal floor space. Examples: 158.0, 187.19 |
acres | float | The number of acres associated with this property. Examples: 1.25, 10 |
Location | ||
address | string | A short form of the property address. Example: "50 Old Mill Lane, Townsville" |
full_address | string | A long form of the property address. Example: "50 Old Mill Lane, Townsville, Dublin 4, South Dublin City" |
area | string | The small area with a formal name. Examples: "Santry", "Ashford" |
county | string | The county this property is in. Examples: "Co. Wicklow", "Co. Kerry" |
city | string | The city this property is in, if any. Examples: "Limerick", "Cork" |
general_area | string | A large area without a formal name, if this property is inside one. Examples: "Dublin City Centre", "Galway Commuter Towns" |
postcode | string | The postcode, if any. Not all properties will have a postcode. Examples: "Dublin 11", "Dublin 24" |
latitude | float | The latitude of this property, if known. Example: 53.35404 |
longitude | float | The longitude of this property, if known. Example: -6.3328 |
latlon_accuracy | integer |
The accuracy of the latitude and longitude co-ordinates.
|
Agent and contact information | ||
agency_name | string | The estate agent, auctioneer, or other organisation bringing this property to market. |
contact_name | string | The name of a person to contact regarding this property. |
phone1 | string | The first phone number of the person to contact regarding this property. |
phone2 | string | An alternate phone number for the person to contact regarding this property. |
phoneinfo | string | When to call the phone1 or phone2 numbers. Examples: "Office Hours", "Anytime", "9am - 5pm" |
main_email | string | The primary email address to contact regarding this property. |
auction_address | string | The address of the auction event, if this property is being sold at auction. |
Dates (in UNIX timestamp format) | ||
listing_date | integer | A date for when this property ad went live, or was last renewed. |
agreed_date | integer | A date for when a sale was agreed for this property. |
auction_date | integer | A date for when the auction will take place, if this property is being sold at auction. |
Main image | ||
small_thumbnail_url | string | A URL to a small version of the main thumbnail for this property, which will be 100 pixels square. |
medium_thumbnail_url | string | A URL to a medium version of the main thumbnail for this property, the longest dimension of which will be 160 pixels. |
large_thumbnail_url | string | A URL to a large version of the main thumbnail for this property, the longest dimension of which will be 250 pixels. |
Errors
There are no extra error types specific to this request.
Back to topsearch_rental
Overview
search_rental
: Perform a search for "to let" property.
Examples
Code samples are available for this request.
Arguments
The arguments are common for all property search requests, and are listed in the table above.
Return value
If successful, search_rental
returns three elements:
- pagination: an array with data about the number of results, number of pages, etc.
- search_sentence: a string with a short sentence summarising the search. Example: "properties to let anywhere in Ireland"
- ads: an array of matching properties
Pagination
Name | Type | Description |
---|---|---|
total_results | integer | The total number of property ads matched by your search. |
results_per_page | integer | The number of results per "page" of results. You may be able to adjust this with the perpage query argument. |
num_pages | integer | The number of pages of results, based on total_results and results_per_page |
current_page | integer | The current page of results. |
first_on_page | integer | The index number of the first result on this page. For the first page it is 1, second page is 11, etc. (Example assumes ten results per page) |
last_on_page | integer | The index number of the last result on this page. For the first page it is 10, second page is 20, etc. (Example assumes ten results per page) |
Results
Name | Type | Description | |
---|---|---|---|
ad_id | integer | The ID number of this rental ad. | |
daft_url | string | A URL to this property on Daft.ie. | |
property_type | string | Examples: 'house', 'apartment' | |
agreed | integer |
Whether a letting has been agreed for this property or not.
|
|
priority | integer |
The priority of this ad.
|
|
description | string | A full-text description of this property. Example: "This lovely property is situated beside ..." | |
bathrooms | integer | The number of bathrooms in this property. | |
bedrooms | integer | The number of bedrooms in this property. | |
rent | integer | The rent amount for this property. Note that this amount may be weekly or monthly. Use the rent_collection_period value to determine which. |
|
rent_collection_period | string | How often the rent needs to be paid. Values: 'weekly', 'monthly' |
|
furnished | integer | Whether the property comes with furniture.
|
|
features | string array | An array of short strings for features the property may have. Example: ("Parking", "Central Heating", "Dishwasher") | |
single_beds | integer | The number of single bedrooms in this property. | |
double_beds | integer | The number of double bedrooms in this property. | |
twin_beds | integer | The number of twin bedrooms in this property. | |
lease_length | integer | The length of the lease, in months. | |
rent_allowance | integer | This item is deprecated | |
Location | |||
address | string | A short form of the property address. Example: "50 Old Mill Lane, Townsville" | |
full_address | string | A long form of the property address. Example: "50 Old Mill Lane, Townsville, Dublin 4, South Dublin City" | |
area | string | The small area with a formal name. Examples: "Santry", "Ashford" | |
county | string | The county this property is in. Examples: "Co. Wicklow", "Co. Kerry" | |
city | string | The city this property is in, if any. Examples: "Limerick", "Cork" | |
general_area | string | A large area without a formal name, if this property is inside one. Examples: "Dublin City Centre", "Galway Commuter Towns" | |
postcode | string | The postcode, if any. Not all properties will have a postcode. Examples: "Dublin 11", "Dublin 24" | |
latitude | float | The latitude of this property, if known. Example: 53.35404 | |
longitude | float | The longitude of this property, if known. Example: -6.3328 | |
latlon_accuracy | integer |
The accuracy of the latitude and longitude co-ordinates.
|
|
Agent and contact information | |||
agency_name | string | The estate agent, auctioneer, or other organisation bringing this property to market. | |
contact_name | string | The name of a person to contact regarding this property. | |
phone1 | string | The first phone number of the person to contact regarding this property. | |
phone2 | string | An alternate phone number for the person to contact regarding this property. | |
phoneinfo | string | When to call the phone1 or phone2 numbers. Examples: "Office Hours", "Anytime", "9am - 5pm" | |
main_email | string | The primary email address to contact regarding this property. | |
Dates (in UNIX timestamp format) | |||
listing_date | integer | A date for when this property ad went live, or was renewed. | |
agreed_date | integer | A date for when a sale was agreed for this property. | |
available_date | integer | A date for when the property is available from. | |
start_pay_date | integer | A date for when the first rent payment is due. | |
Main image | |||
small_thumbnail_url | string | A URL to a small version of the main thumbnail for this property, which will be 100 pixels square. | |
medium_thumbnail_url | string | A URL to a medium version of the main thumbnail for this property, the longest dimension of which will be 160 pixels. | |
large_thumbnail_url | string | A URL to a large version of the main thumbnail for this property, the longest dimension of which will be 250 pixels. |
Errors
There are no extra error types specific to this request.
Back to topsearch_commercial
Overview
search_commercial
: Perform a search for commercial property, both "for sale" and "to let".
Examples
Code samples are available for this request.
Arguments
The arguments are common for all property search requests, and are listed in the table above.
Return value
If successful, search_commercial
returns three elements:
- pagination: an array with data about the number of results, number of pages, etc.
- search_sentence: a string with a short sentence summarising the search. Example: "properties to let anywhere in Ireland"
- ads: an array of matching properties
Pagination
Name | Type | Description |
---|---|---|
total_results | integer | The total number of property ads matched by your search. |
results_per_page | integer | The number of results per "page" of results. You may be able to adjust this with the perpage query argument. |
num_pages | integer | The number of pages of results, based on total_results and results_per_page |
current_page | integer | The current page of results. |
first_on_page | integer | The index number of the first result on this page. For the first page it is 1, second page is 11, etc. (Example assumes ten results per page) |
last_on_page | integer | The index number of the last result on this page. For the first page it is 10, second page is 20, etc. (Example assumes ten results per page) |
Results
Name | Type | Description |
---|---|---|
ad_id | integer | The ID number of this commercial ad. |
daft_url | string | A URL to this property on Daft.ie. |
property_type | string | Examples: 'office', 'retail unit', 'industrial' |
contract_type | integer |
The type of contract this property is available under.
|
agreed | integer |
Whether a sale or letting has been agreed for this property.
|
priority | integer |
The priority of this ad.
|
description | string | A full-text description of this property. Example: "This lovely property is situated beside ..." |
rent | integer | The rent amount for this property. Note that this amount may be weekly or monthly. Use the rent_collection_period value to determine which. |
rent_collection_period | string | How often the rent needs to be paid. Values: 'yearly', 'monthly' |
furnished | integer | Whether the property comes with furniture. 0 = unfurnished, 1 = furnished, other values reserved for future use. |
features | string array | An array of short strings for features the property may have. Example: ("Parking", "Alarm", "Meeting rooms") |
price | integer | Sale price for this property. This field should be ignored if the property is up for rental only. |
sq_ft | integer | The area of the property, in square feet. |
people | integer | The number of people that this property is suitable for. |
Location | ||
address | string | A short form of the property address. Example: "50 Old Mill Lane, Townsville" |
full_address | string | A long form of the property address. Example: "50 Old Mill Lane, Townsville, Dublin 4, South Dublin City" |
area | string | The small area with a formal name. Examples: "Santry", "Ashford" |
county | string | The county this property is in. Examples: "Co. Wicklow", "Co. Kerry" |
city | string | The city this property is in, if any. Examples: "Limerick", "Cork" |
general_area | string | A large area without a formal name, if this property is inside one. Examples: "Dublin City Centre", "Galway Commuter Towns" |
postcode | string | The postcode, if any. Not all properties will have a postcode. Examples: "Dublin 11", "Dublin 24" |
latitude | float | The latitude of this property, if known. Example: 53.35404 |
longitude | float | The longitude of this property, if known. Example: -6.3328 |
latlon_accuracy | integer |
The accuracy of the latitude and longitude co-ordinates.
|
auction_address | string | The address of the auction event, if this property is being sold at auction. |
Agent and contact information | ||
agency_name | string | The estate agent, auctioneer, or other organisation bringing this property to market. |
contact_name | string | The name of a person to contact regarding this property. |
phone1 | string | The first phone number of the person to contact regarding this property. |
phone2 | string | An alternate phone number for the person to contact regarding this property. |
phoneinfo | string | When to call the phone1 or phone2 numbers. Examples: "Office Hours", "Anytime", "9am - 5pm" |
main_email | string | The primary email address to contact regarding this property. |
Dates (in UNIX timestamp format) | ||
listing_date | integer | A date for when this property ad went live, or was renewed. |
agreed_date | integer | A date for when a sale was agreed for this property. |
available_date | integer | A date for when the property is available from. |
start_pay_date | integer | A date for when the first rent payment is due. |
auction_date | integer | A date for when the auction will take place, if this property is being sold at auction. |
Main image | ||
small_thumbnail_url | string | A URL to a small version of the main thumbnail for this property, which will be 100 pixels square. |
medium_thumbnail_url | string | A URL to a medium version of the main thumbnail for this property, the longest dimension of which will be 160 pixels. |
large_thumbnail_url | string | A URL to a large version of the main thumbnail for this property, the longest dimension of which will be 250 pixels. |
Errors
There are no extra error types specific to this request.
Back to topsearch_new_development
Overview
search_new_development
: Perform a search for new developments for sale.
Examples
Code samples are available for this request.
Arguments
The arguments are common for all property search requests, and are listed in the table above.
Return value
If successful, search_new_development
returns three elements:
- pagination: an array with data about the number of results, number of pages, etc.
- search_sentence: a string with a short sentence summarising the search. Example: "new homes for sale anywhere in Ireland"
- ads: an array of matching properties
Pagination
Name | Type | Description |
---|---|---|
total_results | integer | The total number of property ads matched by your search. |
results_per_page | integer | The number of results per "page" of results. You may be able to adjust this with the perpage query argument. |
num_pages | integer | The number of pages of results, based on total_results and results_per_page |
current_page | integer | The current page of results. |
first_on_page | integer | The index number of the first result on this page. For the first page it is 1, second page is 11, etc. (Example assumes ten results per page) |
last_on_page | integer | The index number of the last result on this page. For the first page it is 10, second page is 20, etc. (Example assumes ten results per page) |
Results
Name | Type | Description |
---|---|---|
ad_id | integer | The ID number of this new_development ad. |
daft_url | string | A URL to this property on Daft.ie. |
tag_line | string | A "tag line" entered by the agent selling this property. Example: "Delicious living" |
location | string | A short description of the area this property is in, entered by the agent selling this property. |
developer_name | string | Short name for the property developer who built this new development. |
developer_info | string | General information about the development company. |
units_available | integer | The number of unsold units remaining in this development. |
units_total | integer | The total number of units unsold in this development. Note that this figure may be different from the number of entries in the `units` field, as there may be more than one unit of each type available. |
priority | integer |
The priority of this ad.
|
description | string | A full-text description of this property. Example: "This lovely property is situated beside ..." |
units | sale ad array | units is an array of individual property ads, with the same properties as a sale ad .
|
Location | ||
address | string | A short form of the property address. Example: "50 Old Mill Lane, Townsville" |
full_address | string | A long form of the property address. Example: "50 Old Mill Lane, Townsville, Dublin 4, South Dublin City" |
area | string | The small area with a formal name. Examples: "Santry", "Ashford" |
county | string | The county this property is in. Examples: "Co. Wicklow", "Co. Kerry" |
city | string | The city this property is in, if any. Examples: "Limerick", "Cork" |
general_area | string | A large area without a formal name, if this property is inside one. Examples: "Dublin City Centre", "Galway Commuter Towns" |
postcode | string | The postcode, if any. Not all properties will have a postcode. Examples: "Dublin 11", "Dublin 24" |
latitude | float | The latitude of this property, if known. Example: 53.35404 |
longitude | float | The longitude of this property, if known. Example: -6.3328 |
latlon_accuracy | integer |
The accuracy of the latitude and longitude co-ordinates.
|
Agent and contact information | ||
agency_name | string | The estate agent, auctioneer, or other organisation bringing this property to market. |
contact_name | string | The name of a person to contact regarding this property. |
phone1 | string | The first phone number of the person to contact regarding this property. |
phone2 | string | An alternate phone number for the person to contact regarding this property. |
phoneinfo | string | When to call the phone1 or phone2 numbers. Examples: "Office Hours", "Anytime", "9am - 5pm" |
main_email | string | The primary email address to contact regarding this property. |
Dates (in UNIX timestamp format) | ||
listing_date | integer | A date for when this property ad went live, or was renewed. |
agreed_date | integer | A date for when a sale was agreed for this property. |
available_date | integer | A date for when the property is available from. |
start_pay_date | integer | A date for when the first rent payment is due. |
auction_date | integer | A date for when the auction will take place, if this property is being sold at auction. |
Main image | ||
small_thumbnail_url | string | A URL to a small version of the main thumbnail for this property, which will be 100 pixels square. |
medium_thumbnail_url | string | A URL to a medium version of the main thumbnail for this property, the longest dimension of which will be 160 pixels. |
large_thumbnail_url | string | A URL to a large version of the main thumbnail for this property, the longest dimension of which will be 250 pixels. |
Errors
There are no extra error types specific to this request.
Back to topsearch_shortterm
Overview
search_shortterm
: Perform a search for short-term rental property.
Examples
Code samples are available for this request.
Arguments
The arguments are common for all property search requests, and are listed in the table above.
Return value
If successful, search_shortterm
returns three elements:
- pagination: an array with data about the number of results, number of pages, etc.
- search_sentence: a string with a short sentence summarising the search. Example: "properties to let anywhere in Ireland"
- ads: an array of matching properties
Pagination
Name | Type | Description |
---|---|---|
total_results | integer | The total number of property ads matched by your search. |
results_per_page | integer | The number of results per "page" of results. You may be able to adjust this with the perpage query argument. |
num_pages | integer | The number of pages of results, based on total_results and results_per_page |
current_page | integer | The current page of results. |
first_on_page | integer | The index number of the first result on this page. For the first page it is 1, second page is 11, etc. (Example assumes ten results per page) |
last_on_page | integer | The index number of the last result on this page. For the first page it is 10, second page is 20, etc. (Example assumes ten results per page) |
Results
Name | Type | Description |
---|---|---|
ad_id | integer | The ID number of this shortterm ad. |
daft_url | string | A URL to this property on Daft.ie. |
property_type | string | Examples: 'house', 'apartment' |
agreed | integer |
Whether a letting has been agreed for this property or not.
|
priority | integer |
The priority of this ad.
|
description | string | A full-text description of this property. Example: "This lovely property is situated beside ..." |
bathrooms | integer | The number of bathrooms in this property. |
bedrooms | integer | The number of bedrooms in this property. |
rent | integer | The rent amount for this property. Note that this amount may be weekly or monthly. Use the rent_collection_period value to determine which. |
rent_collection_period | string | How often the rent needs to be paid. Values: 'weekly', 'monthly' |
features | string array | An array of short strings for features the property may have. Example: ("Parking", "Central Heating", "Dishwasher") |
single_beds | integer | The number of single bedrooms in this property. |
double_beds | integer | The number of double bedrooms in this property. |
twin_beds | integer | The number of twin bedrooms in this property. |
Location | ||
address | string | A short form of the property address. Example: "50 Old Mill Lane, Townsville" |
full_address | string | A long form of the property address. Example: "50 Old Mill Lane, Townsville, Dublin 4, South Dublin City" |
area | string | The small area with a formal name. Examples: "Santry", "Ashford" |
county | string | The county this property is in. Examples: "Co. Wicklow", "Co. Kerry" |
city | string | The city this property is in, if any. Examples: "Limerick", "Cork" |
general_area | string | A large area without a formal name, if this property is inside one. Examples: "Dublin City Centre", "Galway Commuter Towns" |
postcode | string | The postcode, if any. Not all properties will have a postcode. Examples: "Dublin 11", "Dublin 24" |
latitude | float | The latitude of this property, if known. Example: 53.35404 |
longitude | float | The longitude of this property, if known. Example: -6.3328 |
latlon_accuracy | integer |
The accuracy of the latitude and longitude co-ordinates.
|
Agent and contact information | ||
agency_name | string | The estate agent, auctioneer, or other organisation bringing this property to market. |
contact_name | string | The name of a person to contact regarding this property. |
phone1 | string | The first phone number of the person to contact regarding this property. |
phone2 | string | An alternate phone number for the person to contact regarding this property. |
phoneinfo | string | When to call the phone1 or phone2 numbers. Examples: "Office Hours", "Anytime", "9am - 5pm" |
main_email | string | The primary email address to contact regarding this property. |
Dates (in UNIX timestamp format) | ||
listing_date | integer | A date for when this property ad went live, or was renewed. |
agreed_date | integer | A date for when a sale was agreed for this property. |
available_date | integer | A date for when the property is available from. |
start_pay_date | integer | A date for when the first rent payment is due. |
Main image | ||
small_thumbnail_url | string | A URL to a small version of the main thumbnail for this property, which will be 100 pixels square. |
medium_thumbnail_url | string | A URL to a medium version of the main thumbnail for this property, the longest dimension of which will be 160 pixels. |
large_thumbnail_url | string | A URL to a large version of the main thumbnail for this property, the longest dimension of which will be 250 pixels. |
Errors
There are no extra error types specific to this request.
Back to topmedia
Overview
media
: Find all the media for a property ad.
Examples
Code samples are available for this request.
Arguments
The media
request accepts an array identifying a property ad:
Name | Type | Required | Description |
---|---|---|---|
ad_type | string | Required | A valid ad type. Ad types are available from the ad_types request, or from the table in Appendix 1. |
ad_id | integer | Required | A valid ad_id, as returned by a property search. |
Return value
media
returns a set of media for an ad. A media set has the following form:
Name | Type | Description |
---|---|---|
ad_type | string | The type of this ad. This will be the same as the value provided in the arguments. |
ad_id | integer | The ID of this ad. This will be the same as the value provided in the arguments. |
images | array | An array of image results. The structure of each image result is detailed in the table below. |
Image results
Name | Type | Description |
---|---|---|
caption | string | Short sentence describing this image. |
large_url | string | A URL to the large image, the longest dimension of which will not exceed 600 pixels. |
medium_url | string | A URL to the medium image, the longest dimension of which will not exceed 400 pixels. |
small_url | string | A URL to the small image, the longest dimension of which will not exceed 250 pixels. |
Errors
Error type | Message | Reason |
---|---|---|
NoMatchFailure | Invalid ad type: | You specified an invalid ad_type . Correct values can be found by using the ad_types function, or by consulting the table in Appendix 1 |
Examples
PHP5 sample code
You can find more examples in other languages on the Sample Code page.
<?php
/**
* This example will do a basic search for residential "for sale" property.
*/
$DaftAPI = new SoapClient(
"http://api.daft.ie/v2/wsdl.xml"
, array('features' => SOAP_SINGLE_ELEMENT_ARRAYS)
);
$parameters = array(
'api_key' => "4039260_invalid_example_key_87b7c7c267fa"
, 'query' => array('bedrooms' => 2)
);
$response = $DaftAPI->search_sale($parameters);
$results = $response->results;
foreach($results->ads as $ad)
{
printf(
'<a href="%s">%s</a><br />'
, $ad->daft_url
, $ad->full_address
);
}
?>
The response fetched by this code should have the following structure:
stdClass Object ( [search_sentence] => 2 bed properties for sale anywhere in Ireland [pagination] => stdClass Object ( [total_results] => 8261 [results_per_page] => 10 [num_pages] => 827 [current_page] => 1 [first_on_page] => 1 [last_on_page] => 10 ) [ads] => Array ( [0] => stdClass Object ( [ad_id] => 123456 [daft_url] => http://www.daft.ie/cavan/etc/123456/ [property_type] => house ...
For a full listing of ad properties and query parameters, see the reference documentation.
Back to topAppendices
Appendix 1: Tables
Ad types
List of all valid ad types. This data is equivalent to what the ad_types
request returns. This data rarely changes, so it is reproduced here to serve as a quick reference.
Ad type | Name | Name (Plural) | Name (Short) |
---|---|---|---|
shortterm | short-term letting | short-term lettings | short-term |
sharing | accommodation sharing | accommodation sharing | sharing |
sale | property for sale | properties for sale | for sale |
rental | property to let | properties to let | to let |
parking | parking space | parking spaces | parking |
new_development | new home for sale | new homes for sale | for sale |
commercial | commercial property | commercial properties | commercial |