Domu Docs

Welcome to the Domu Documentation

Find guides, code examples, tutorials, API references, and more.

Domu allows you to query data using the RESO Web API specification, which is based on OData. For more information about the specification, visit the RESO website.

Authorization

The application must send an authorization header with each HTTP request to the API:

Authorization: Bearer {token}

If you can't set headers, you can send the token in the access_token query string parameter of your request:

GET https://api.domu.app/reso/{recurso}?access_token={token}

API Response

By default, the RESO Web API will return 10 listings, regardless of the total number of records available. You can use the $top parameter to request up to 200 listings at a time.

If there are more than 200 records available, you must paginate the results.

All API responses, aside from metadata, are returned in JSON format.

Result Pagination

If the total number of records returned by a query exceeds 200 (the maximum limit for a result set), you must paginate the results. This is done by increasing the number of skipped records.

// Returns the next 200 records, sorted by ListPrice

https://api.domu.app/reso/Property?access_token={token}&$top=200&$skip=200&$orderby=ListPrice desc

Media

Instead of maintaining it as a separate resource, Media is returned as an object directly in the property record.

Metadata

You can request metadata that returns fields and lookup values made available by the data provider. Metadata is returned in XML according to the RESO specification.

// Request metadata

https://api.domu.app/reso/$metadata?access_token={token}

Operators

You can restrict a resource's result set by passing additional operators with your request. Valid operators include:

Operator	Description
eq	Equals
ne	Not equal
gt	Greater than
lt	Less than
ge	Greater than or equal to
le	Less than or equal to
and	Logical AND
or	Logical OR
not	Logical NOT

Parameters

You can pass the following query parameters to filter results.

Name	Type	Description
access_token	cadena	Token to identify the application. This is always required. // Returns all available resources https://api.domu.app/reso?access_token={token}
ListingKey	string	The property key, available in the /Property resource. // Returns the property data for ListingKey '12345' https://api.domu.app/reso/Property('12345')?access_token={token}
$skip	number	Skips this number of results // Skips the first 10 results https://api.domu.app/reso/Property?access_token={token}&$skip=10
$select	string	Selects the fields to be returned // Returns only the LivingArea field https://api.domu.app/reso/Property?access_token={token}&$select=LivingArea
$filter	string	Filters the results to be returned // Returns properties where ListPrice is greater than 100000 https://api.domu.app/reso/Property?access_token={token}&$filter=ListPrice gt 100000
$top	number	Limits the size of the result set. The default is 10, maximum is 200. // Limits results to 2 https://api.domu.app/reso/Property?access_token={token}&$top=2
$orderby	string	Sorts the results, ascending or descending // Sorts by descending price https://api.domu.app/reso/Property?access_token={token}&$orderby=ListPrice desc

Query Functions

Function	Description
any	Search fields where any element of an array satisfies a condition // Returns properties with the option of electric heating https://api.domu.app/reso/Property?access_token={token}&$filter=Heating/any(a: a eq 'Electric')
all	Search fields where all elements of an array satisfy a condition // Returns properties where all flooring is parquet https://api.domu.app/reso/Property?access_token={token}&$filter=Flooring/all(a: a eq 'Parquet')
geo.distance	Search by coordinates // Return listings that are near specific co-ordinates, to a radius of 0.6 meters https://api.domu.app/reso/Property?access_token=access_token&$filter=geo.distance(Coordinates, POINT(2.15899 41.38879)) lt 0.6
geo.intersects	If you know the extents of a polygonal region, you can provide the each point as co-ordinates // Return listings within a shape https://api.domu.app/reso/Property?access_token=access_token&$filter=geo.intersects(Coordinates, POLYGON((2.16 41.39, 2.16 41.41, 2.18 41.41, 2.18 41.39, 2.16 41.39)))