Getting Started
...
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, 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 20 - max value is 100200) |
$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. Check Searchable fields section. |
$expandTo | retrieve OpenHouse data as a part of the Property payloadPull in data from related resources. For example, $expand=OpenHouse would retrieve associated Openhouses data. |
$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 RealtyFeed exclusive parameter which will prioritize the response. |
The supported parameters can be combined as needed
...
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 |
---|---|
ListingKey | |
ModificationTimestamp | last modified timestamp by MLS |
RFModificationTimestamp | last modified timestamp by RealtyFeed |
ListingId | |
PropertyType | A list of types of properties such as Residential, Lease, Income, Land, Mobile, 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 as it reflects the state on RF |
MlsStatus | The status of the contract between the listing agent and seller or an agreement with a buyer (Active, Active Under Contract, Canceled, Closed, Expired, Pending, Withdrawn).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. |
TaxLotTaxYear | 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. |
TaxBlockTaxAnnualAmount | 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. |
...