...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Authentication
To access MLS Router™ RESO Web the API, authentication is required. The API uses the OAuth2 Client Credentials flow for authentication.
Obtaining Access Token
To authenticate, send a POST request to the following endpoint:
| Code Block |
|---|
POST https://realtyfeed-sso.auth.us-east-1.amazoncognito.com/oauth2/token |
The request should include the following in the Request Body as x-www-form-urlencoded key/values:
Parameter | Description |
|---|---|
client_id | The client ID provided by Realtyna |
client_secret | The client secret provided by Realtyna |
grant_type | The grant type, which should be "client_credentials" |
And also include the following in the Request Headers:
Parameter | Description |
|---|---|
Content-Type | application/x-www-form-urlencoded |
Accept-Encoding | gzip, deflate, br |
Accept | */* |
If the authentication request is successful, you will receive a JSON response with the following values:
| Code Block | ||
|---|---|---|
| ||
{
"access_token": "<access_token>",
"expires_in": 3600,
"token_type": "Bearer"
} |
access_token: This is the authorization token that needs to be passed in the Authorization header of API requests.expires_in: The duration of validity for the token in seconds (currently set to 3600).token_type: The type of token being returned (currently set to "Bearer").
Need more help? See How to get Authentication codeFor more information, Check Authentication section.
Reading the Metadata
Once you've authenticated, the next step for building a client is finding out what data you can get out of RESO Web API. To do this, you query the metadata endpoint.
...
Now that we know what fields are available via RESO Web API, it's time to start fetching property data.
Retrieving Data
To retrieve data from the RESO Web API, please include the following headers in each request:
Authorization: Set this header with the value "Bearer <access_token>" (replace<access_token>with the actual access token obtained during authentication).x-api-key: Include this header with the API key provided by Realtyna. (Optional)Origin: Include this header with the API key provided by Realtyna. (Optional)Referer: Include this header with the API key provided by Realtyna. (Optional)
The endpoint structure of all search requests is:
...
Valid resource values include the names of the valid RESO resources: Property, Media, Member, Office, PropertyRooms and OpenHouse.
Sample for Property Search:
...
ListingKey is the unique identifier for Property records
Request Parameters
The RESO Web API supports the following parameters for search requests:
Parameter | Description |
|---|---|
$top | To get more records per query, we use the $top parameter. If you want just one record, you can specify $top=1, or if you want one hundred, $top=100. (default is 20 - max value is 200) |
$skip | Use $skip to skip over a number of records. This is most useful in combination with $top to iterate over the results of a query. (default is 0) |
$select | You can limit the fields you want with $select. For example, if you want just the ListingKey and the StandardStatus, you would use $select=ListingKey, StandardStatus |
$filter | You can get specific records you want with the $filter. Check Searchable fields section. |
$expand | Pull in data from related resources. For example, $expand=Media would retrieve associated Media objects. |
$apply | to perform data transformation operations. Sample: $apply=groupby((CountyOrParish), (aggregate($count as ListingCount))) will return number of records in each available County |
$feature | It’s a MLS Router exclusive parameter which will prioritize the response. |
The supported parameters can be combined as needed
$filter
The $filter system query option restricts the set of items returned. MLS Router supports a set of built-in filter operations, as described in this section:
...
These operators can be combined to form very complex queries, e.g. ((ListPrice lt 300000 and LotSizeAcres lt 3) or (BedroomsTotal gt 4 and StandardStatus eq 'Active'))
Working with strings in $filter:
Strings are relatively straightforward in RESO Web API. They are always enclosed in single quotes (') and if you need a single quote in the string, you simply double it up, e.g. 'O''Brien'.
...
Function | Description |
|---|---|
contains(haystack, 'needle') | Returns response if needle is found in haystack |
Working with geo coordinates in $filter:
Function | Description |
|---|---|
geo.distance(Coordinates, POINT(-96.818747 32.928812)) lt 10km | Returns property listings within geo distance of 10km from a specific point |
Retrieving Single Record
Use this endpoint to get details about a specific record:
...
| Code Block |
|---|
GET https://api.realtyfeed.com/reso/odata/Property('ListingKey')
or
GET https://api.realtyfeed.com/reso/odata/Member('MemberKey') |
Don’t hesitate to contact Realtyna Support, if you have any questions.
Searchable Fields:
Property
Field | Description |
|---|---|
ListingKey |
|
ModificationTimestamp | last modified timestamp by MLS |
RFModificationTimestamp | last modified timestamp by RealtyFeed. Recommended field for replication process as well as detecting latest updated records. |
ListingId |
|
PropertyType | A list of types of properties such as Residential, Land, Commercial Sale, etc... |
PropertySubType | A list of sub types to Residential, Residential Lease, Manufactured in Park, Commercial and Business Opportunity listings. e.g. Single Family Residence, Condominium, Manufactured on Land, Townhouse, Multi Family, Office, Retail, etc. |
ListPrice | The current price of the property as determined by the seller and the seller's broker. For auctions this is the minimum or reserve price. |
BathroomsTotalInteger | The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms and one Half Bathroom, the Bathrooms Total Integer will be 3. |
BedroomsTotal | The total number of bedrooms in the dwelling. |
StandardStatus | The status of the listing on RF |
MlsStatus | The status of the listing on MLS |
DaysOnMarket |
|
LotSizeArea | The total area of the lot. |
LivingArea | The total livable area within the structure. |
BuildingAreaTotal | Total area of the structure. Includes both finished and unfinished areas. |
OriginatingSystemName | The name of the Originating record provider. Most commonly the name of the MLS. |
City | The city in listing address. |
PostalCode | The postal code portion of a street or mailing address. |
UnparsedAddress | The UnparsedAddress is a text representation of the address with the full civic location as a single entity. It may optionally include any of City, StateOrProvince, PostalCode and Country. |
YearBuilt | The year that an occupancy permit is first granted for the house or other local measure of initial habitability of the build. |
ListAgentFullName | The full name of the listing agent. (First Middle Last) |
ListAgentMlsId |
|
CoListAgentMlsId |
|
BuyerAgentMlsId |
|
CoBuyerAgentMlsId |
|
ListOfficeName | The legal name of the brokerage representing the seller. |
ListOfficeMlsId |
|
ListAOR |
|
ListAgentAOR |
|
ListOfficeAOR |
|
CoListOfficeMlsId |
|
BuyerOfficeMlsId |
|
CoBuyerOfficeMlsId |
|
StoriesTotal | The total number of floors in the building. |
TaxYear | A type of legal description for land in developed areas where streets or other rights-of-ways delineate large parcels of land referred to as divided into lots on which homes or other types of developments are built. |
TaxAnnualAmount | A type of legal description for land in developed areas where streets or other rights-of-ways delineate large parcels of land referred to as divided into lots on which homes or other types of developments are built. |
GarageSpaces | The number of spaces in the garage(s). |
Cooling | A list describing the cooling or air conditioning features of the property. |
InteriorFeatures | A list of features or description of the interior of the property included in the sale/lease. |
ExteriorFeatures | A list of features or description of the exterior of the property included in the sale/lease. |
PublicRemarks | Text remarks that may be displayed to the public. |
LaundryFeatures | A list of features and locations where the laundry is located in the property being sold. i.e. Gas Dryer Hookup, In Kitchen, In Garage, etc. |
FireplacesTotal | The total number of fireplaces included in the property. |
PoolFeatures | A list of features or description of the pool included in the sale/lease. |
PetsAllowed | Are pets allowed at the property? A list of yes, no and more detailed restrictions/allowances. |
WaterfrontFeatures | Features of the waterfront on which the property is located. |
AccessibilityFeatures | A list or description of the accessibility features included in the sale/lease. |
LotFeatures | A list of features or description of the lot included in the sale/lease. |
...