Authentication
...
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:
...
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. |
...
| 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.
403 Forbidden
A 403 http response results when an authenticated user does not have adequate permissions to perform the requested operation or access the specified resource.
400 Bad Request
A 400 http response results when a request is poorly formatted or does not meet validation for the specified operation.
400 responses contain an array of messages that a developer may parse to determine the parameter and reason for why the request failed.
406 Not Accepted
A 406 http response results when a request is not satisfied due to rule or policy being broken.
500 Internal Server Error
...
.
Searchable Fields:
Property
...