View all Web API examples ▸

Utah MLS

MLS Provider: Utah Real Estate

• ▾   A1 | Get metadata
• ▾   A2 | See all available Data Systems
• ▾   A3 | Get single Data System
• ▾   B4 | Filter for specific Property
• ▾   B5 | Filter by resource key
• ▾   C10 | Filter using not equal
• ▾   C6 | Filter on multiple field values
• ▾   C7 | Filter on Boolean field
• ▾   C8 | Filter on string fields
• ▾   C9 | Filter on same field
• ▾   D11 | Ouput a selected set of fields
• ▾   D12 | Return only limited number of records
• ▾   D13 | Skip n records and get next m records
• ▾   D14 | Sort Results
• ▾   D15 | Expand Resources in results
• ▾   E16 | Filter on single value enumeration
• ▾   E17 | Filter on multi-valued enumeration
• ▾   F18 | Filter on a Date
• ▾   F19 | Filter on time
• ▾   F20 | Filter on a fractional second
• ▾   F21 | Filter on a date value of now
• ▾   G22 | Filter on a string that starts with
• ▾   G23 | Filter on a string that ends with
• ▾   G24 | Filter a string that contains
• ▾   G25 | Filter by comparing upper case
• ▾   H26 | Geospatial Filter within a radius

A1 | Get metadata

Retrieve metadata for a specific service in OData EDMX/xml format. http://resoapi.wfrmls.com/reso/odata/$metadata Top ▴

A2 | See all available Data Systems

To get the complete list of DataSystems provided by a server, append /DataSystem to the URI Stem of the server. Each Data System provided by the service will be listed as items and will contain a list all available Resources for that... http://resoapi.wfrmls.com/reso/odata/DataSystem Top ▴

A3 | Get single Data System

Select a specific Data System and list its resources. The DataSystem endpoint will list all available Resources. http://resoapi.wfrmls.com/reso/odata/DataSystem('WEB_API') Top ▴

B4 | Filter for specific Property

There are several ways to get a single property. By ID as in this example or including the unique key (i.e. Listing Key) in the Property attribute. i.e. Property(‘23442234’). Resultant fields are dictated by the $select... http://resoapi.wfrmls.com/reso/odata/Properties?$filter=ListingKeyNumeric eq 10261&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks Top ▴

B5 | Filter by resource key

You can search most resources by using that resource’s unique identifier. http://resoapi.wfrmls.com/reso/odata/Properties(10261)

Notice that the resource key is numeric (not a string enclosed in quotes)

Top ▴

C10 | Filter using not equal

not equal (ne) is used as to counter equal (eq) http://resoapi.wfrmls.com/reso/odata/Properties?$filter=BedroomsTotal ne 33&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks Top ▴

C6 | Filter on multiple field values

All names in the $filter option are case sensitive and must match the names of elements provided by the metadata resource. Values are also case sensitive. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=BedroomsTotal lt 5 and (City has Odata.Models.City'Provo') and (PropertyType has Odata.Models.PropertyType'Residential')&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,BedroomsTotal Top ▴

C7 | Filter on Boolean field

Filter results by a boolean field (true or false). Note, do not treat the value true or false as a string. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=CoolingYN eq true&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,CoolingYN Top ▴

C8 | Filter on string fields

Filter a query by matching strings. Note that string comparisons are case sensitive. There are also string functions to aid with string filters but will vary depending on MLS Provider (i.e. toupper(StreetName) eq... http://resoapi.wfrmls.com/reso/odata/Members?$filter=(MemberFirstName eq 'James' or toupper(MemberFirstName) eq 'Adam')&$top=20 Top ▴

C9 | Filter on same field

Use parenthesis and logical ‘and’ or ‘or’ to group filter expressions. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=BedroomsTotal lt 5 or (BedroomsTotal eq 4 and CoolingYN eq true)&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks Top ▴

D11 | Ouput a selected set of fields

The resultant output (usually JSON) can be dictated by using the OData ‘select’ statement. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=BedroomsTotal eq 3&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks Top ▴

D12 | Return only limited number of records

Get first 10 results from query/filter. All names in the $select option are case-sensitive to match the names of elements provided by the resource. The implementation of $top and $orderby is defined by the server and may restrict what values may be used in either... http://resoapi.wfrmls.com/reso/odata/Members?$top=10&$select=MemberLastName,MemberFirstName&$filter=toupper(MemberFirstName) eq 'JOHN' Top ▴

D13 | Skip n records and get next m records

Skip by the first 10 results and return the 2nd 10 results from a filter. If more records exist in the query than returned then using the @odata.nextLink value from the result is another way to retrieve remaining... http://resoapi.wfrmls.com/reso/odata/Members?$skip=10&$top=10&$orderby=MemberLastName&$select=MemberLastName,MemberFirstName Top ▴

D14 | Sort Results

The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. If asc or desc not specified, then the resources will be ordered in ascending (asc) order. A compliant client SHOULD use the... http://resoapi.wfrmls.com/reso/odata/Properties?$filter=ListPrice lt 1000000 and (PropertyType has Odata.Models.PropertyType'Residential')&$orderby=ListPrice desc&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,Longitude,Latitude Top ▴

D15 | Expand Resources in results

The $expand system query option specifies the related resources to be included in line with retrieved resources. Look for the NavigationProperty in the metadata to determine if a resource is linked for expansion. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=(City has Odata.Models.City'Provo') and (PropertyType has Odata.Models.PropertyType'Residential') and PhotosCount gt 1&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,PhotosCount&$expand=Media Top ▴

E16 | Filter on single value enumeration

A Single Valued Lookup is a field that can have one and only one selection from a list of values. The Web API Implements Single Valued Lookup fields using the OData data type of Edm.EnumType with an underlying type of... http://resoapi.wfrmls.com/reso/odata/Properties?$filter=(PropertyType has Odata.Models.PropertyType'Residential') and PropertyType has Odata.Models.PropertyType'Residential'&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,PropertyType Top ▴

E17 | Filter on multi-valued enumeration

A Multi-Valued Lookup is a field that can have one or more items selected from a list of values. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=(PropertyType has Odata.Models.PropertyType'Residential') and (Roof has Odata.Models.Roof'Wood') or (Roof has Odata.Models.Roof'Stone')&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,Roof Top ▴

F18 | Filter on a Date

Filtering on a date requires date fields to be defined as dates (Type=”Edm.Date”) in the metadata http://resoapi.wfrmls.com/reso/odata/Properties?$filter=ListingContractDate lt 2017-12-31 and (PropertyType has Odata.Models.PropertyType'Residential')&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,ListingContractDate Top ▴

F19 | Filter on time

Filtering on time can use of the hour, minute, second and fractional seconds functions. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=year(ModificationTimestamp) eq 2018 and month(ModificationTimestamp) gt 5 and day(ModificationTimestamp) lt 31 and hour(ModificationTimestamp) gt 1 and minute(ModificationTimestamp) gt 3 and (PropertyType has Odata.Models.PropertyType'Residential')&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,ModificationTimestamp Top ▴

F20 | Filter on a fractional second

filtering on fractions of a second requires the use of the function fractionalseconds() http://resoapi.wfrmls.com/reso/odata/Properties?$filter=ListingContractDate lt 2017-12-31 and fractionalseconds(ModificationTimestamp) lt 0033 and (PropertyType has Odata.Models.PropertyType'Residential')&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,ListingContractDate,ModificationTimestamp Top ▴

F21 | Filter on a date value of now

The function now() will return the now time in UTC http://resoapi.wfrmls.com/reso/odata/Properties?$filter=ModificationTimestamp le now() and (PropertyType has Odata.Models.PropertyType'Residential')&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,ModificationTimestamp&$top=10 Top ▴

G22 | Filter on a string that starts with

Filter on a string field value that starts with a certain value. This is case sensitive http://resoapi.wfrmls.com/reso/odata/Members?$filter=startswith(MemberFirstName, 'Joh')&$select=MemberFirstName,MemberLastName,MemberStatus,ModificationTimestamp&$top=20 Top ▴

G23 | Filter on a string that ends with

Filter on a string field value that ends with a certain value. This is case sensitive http://resoapi.wfrmls.com/reso/odata/Properties?$filter=endswith(StreetName, 'M')&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,StreetName&$top=10 Top ▴

G24 | Filter a string that contains

Filter on a string field value that contains a certain value. This is case sensitive http://resoapi.wfrmls.com/reso/odata/Properties?$filter=contains(toupper(StreetName),'MAIN')&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks Top ▴

G25 | Filter by comparing upper case

Convert a string to upper case (toupper). Lower case would use the function tolower(). http://resoapi.wfrmls.com/reso/odata/Properties?$filter=toupper(StreetName) eq 'MAIN'&$top=10&$select=ListingKeyNumeric,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PublicRemarks,StreetName Top ▴

H26 | Geospatial Filter within a radius

A geographic search from a point in the Data System. Note that the structure of a geospatial search can vary per MLS.Search. Pay attention to MLS Service metadata name for Type=”Edm.GeographyPoint”. http://resoapi.wfrmls.com/reso/odata/Properties?$filter=geo.distance(GeoLocation, geography'SRID=3956;POINT(-111.898248 40.576672)') lt 10&$select=ListingKey,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,City,PublicRemarks,Latitude,Longitude&$top=10

The syntax SRID=3956 within the Filter is unique to UtahMLS

Top ▴