Getting Started
To get started using the MLS Router API, please sign up on RF Dashboard. (How to Sign Up on RF Dashboard)
...
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.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, Member, Office, PropertyRooms and OpenHouse.
Sample for Property Search:
...
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 10 - 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. If you want all the fields, you would use $select=ALL |
$filter | You can get specific records you want with the $filter. |
$orderby | You can sort results via the $orderby parameter. This parameter accepts “ASC” and “DESC” as an argument (default is “ASC”). |
...
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.
Errors
401 Unauthorized
A 401 http response results when authentication fails. This is likely due to using an invalid x-api-key or account suspension.
...
Field | Description |
---|---|
OpenHouseKey | |
ListingKey | Get Openhouse records based on associated ListingKey |
ListingId | Get Openhouse records based on associated ListingID |
ModificationTimestamp | |
OriginatingSystemName | |
OpenHouseStatus | |
OpenHouseDate |
PropertyRooms
Field | Description |
---|---|
RoomKey | |
ListingKey | Get Room records based on associated ListingKey |
ListingId | Get Room records based on associated ListingID |
ModificationTimestamp | |
OriginatingSystemName |