View all Web API examples ▸

Bridge API Generic

MLS Provider: Bridge API

• ▾   A1 | See all available Data Systems
• ▾   A2 | Get single Data System
• ▾   A3 | Get metadata
• ▾   B4 | Filter for specific Property
• ▾   B5 | Filter by resource key
• ▾   C10 | Filter on same field
• ▾   C11 | Filter using not equal
• ▾   C6 | Filter on multiple field values
• ▾   C7 | Filter on Boolean field
• ▾   C8 | Filter on string fields
• ▾   C9 | Filter using ‘not’ in an expression
• ▾   D12 | Ouput a selected set of fields
• ▾   D13 | Return only limited number of records
• ▾   D14 | Skip n records and get next m records
• ▾   D15 | Sort Results
• ▾   D16 | Sort Results
• ▾   D17 | Expand Resources in results
• ▾   E18 | Filter on single value enumeration
• ▾   E19 | Filter on multi-valued enumeration
• ▾   F20 | Filter on a Date
• ▾   F21 | Filter on a fractional second
• ▾   F22 | Filter on a date value of now
• ▾   F23 | Filter on time
• ▾   G24 | Filter a string that contains
• ▾   G25 | Filter by comparing upper case
• ▾   G26 | Filter on a string that ends with
• ▾   G27 | Filter on a string that starts with
• ▾   H28 | Geospatial Filter within a radius
• ▾   H29 | Geospatial Filter within a polygon

A1 | 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... https://api.bridgedataoutput.com/api/v2/OData/DataSystem Top ▴

A2 | Get single Data System

Select a specific Data System and list its resources. The DataSystem endpoint will list all available Resources. https://api.bridgedataoutput.com/api/v2/OData/DataSystem('abor_ref') Top ▴

A3 | Get metadata

Retrieve metadata for a specific service in OData EDMX/xml format. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/$metadata 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... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=ListingKey eq 'c685511d251c6385556c60e866d8541a'&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PropertySubType Top ▴

B5 | Filter by resource key

You can search most resources by using that resource’s unique identifier. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property('c685511d251c6385556c60e866d8541a') Top ▴

C10 | Filter on same field

Use parenthesis and logical ‘and’ or ‘or’ to group filter expressions. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$top=10&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType&$filter=(BedroomsTotal gt 3 and BedroomsTotal lt 5) and (PropertyType eq 'Residential') Top ▴

C11 | Filter using not equal

not equal (ne) is used as to counter equal (eq) https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$top=10&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType&$filter=(BedroomsTotal ne 2) and (BedroomsTotal le 5 and BedroomsTotal ne 1) and (PropertyType eq 'Residential') 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. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=(BedroomsTotal gt 3 and BedroomsTotal lt 5) and (City eq 'Austin') and (PropertyType eq 'Residential')&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType 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. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=InternetAddressDisplayYN eq true and (City eq 'Austin') and (PropertyType eq 'Residential')&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,InternetAddressDisplayYN 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... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Member?$top=5&$filter=MemberStatus eq 'Active' and (MemberFirstName eq 'James' or MemberFirstName eq 'Adam') Top ▴

C9 | Filter using ‘not’ in an expression

A boolean ‘Not’ must enclose its operands in a parenthesis with not as an operator i.e. not(City eq ‘Elkwood’). https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$top=10&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,InternetAddressDisplayYN&$filter=not(InternetAddressDisplayYN eq true) Top ▴

D12 | Ouput a selected set of fields

The resultant output (usually JSON) can be dictated by using the OData ‘select’ statement. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=(City eq 'Austin') and (PropertyType eq 'Residential') and BedroomsTotal lt 5&$top=10&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType Top ▴

D13 | 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... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Member?$top=10&$select=MemberLastName,MemberFirstName,MemberLoginId&$filter=MemberFirstName eq 'John' Top ▴

D14 | 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... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Member?$skip=10&$top=10&$orderby=MemberLastName&$select=MemberLastName,MemberFirstName,MemberLoginId Top ▴

D15 | 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... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=(BedroomsTotal gt 3 and BedroomsTotal lt 5) and (City eq 'Austin') and (PropertyType eq 'Residential')&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType&$orderby=ListPrice desc Top ▴

D16 | 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... https://api.bridgedataoutput.com/api/v2/OData/Property?$filter=ListPrice lt 300000&$orderby=ListPrice desc Top ▴

D17 | 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. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=(City eq 'Austin') and (PropertyType eq 'Residential') and PhotosCount gt 1&$top=10&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,PhotosCount,PublicRemarks&$expand=ListAgent Top ▴

E18 | 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... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=ListPrice lt 900000 and (City eq 'Austin') and (PropertyType eq 'Residential')&$top=10 Top ▴

E19 | 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. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=(City eq 'Austin') and (Levels eq 'One') or (Levels eq 'Two')&$top=10&$select=ListingId,ListPrice,StreetNumber,StreetName,City,BathroomsTotalInteger,BedroomsTotal,Levels Top ▴

F20 | Filter on a Date

Filtering on a date requires date fields to be defined as dates (Type=”Edm.Date”) in the metadata https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=ListingContractDate lt 2016-12-31 and (PropertyType eq 'Residential')&$top=10&$select=ListingId,ListingKey,City,ListPrice,StreetNumber,StreetName,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType Top ▴

F21 | Filter on a fractional second

filtering on fractions of a second requires the use of the function fractionalseconds() https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$top=4&$select=ListingKey,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,City,PublicRemarks&$filter=year(ListingContractDate) eq 2017 and month(ListingContractDate) eq 5 and day(ListingContractDate) eq 31 and hour(ModificationTimestamp) gt 13 and minute(ModificationTimestamp) gt 3 and fractionalseconds(ModificationTimestamp) lt 33 and PropertyType eq 'Residential'

HAR: This function may not work with ModificationTimestamp (incompatible types)

Top ▴

F22 | Filter on a date value of now

The function now() will return the now time in UTC https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$top=4&$filter=ModificationTimestamp le now() and PropertyType eq 'Residential'&$select=ListingKey,BedroomsTotal,Directions,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,City Top ▴

F23 | Filter on time

Filtering on time can use of the hour, minute, second and fractional seconds functions. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=year(ListingContractDate) eq 2017 and month(ListingContractDate) eq 5 and day(ListingContractDate) eq 31 and hour(ModificationTimestamp) gt 13 and minute(ModificationTimestamp) gt 3 Top ▴

G24 | Filter a string that contains

Filter on a string field value that contains a certain value. This is case sensitive https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Member?$top=5&$filter=contains(toupper(MemberFirstName),'JOHN') Top ▴

G25 | Filter by comparing upper case

Convert a string to upper case (toupper). Lower case would use the function tolower(). https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$top=11&$select=ListingKey,BedroomsTotal,BathroomsTotalInteger ,ListingContractDate,ModificationTimestamp,StandardStatus,PropertyType,City,PublicRemarks&$filter=toupper(StreetName) eq 'INDUSTRIAL' Top ▴

G26 | Filter on a string that ends with

Filter on a string field value that ends with a certain value. This is case sensitive https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Member?$top=5&$filter=endswith(toupper(MemberLastName),'SON') Top ▴

G27 | Filter on a string that starts with

Filter on a string field value that starts with a certain value. This is case sensitive https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Member?$top=5&$filter=startswith(toupper(MemberLastName),'JOHNS')&$select=MemberFullName,MemberStatus Top ▴

H28 | 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”. https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=geo.distance(Coordinates, POINT(-97.62669 30.430726)) le 10&$top=10 Top ▴

H29 | Geospatial Filter within a polygon

Need a minimum of four points to search by a polygon. The first and last points must be the same and because you’re able to put ‘holes’ into your polygon, you’d need to wrap the coords in another set of parenthesis. Note that the structure of a... https://api.bridgedataoutput.com/api/v2/OData/abor_ref/Property?$filter=ListPrice lt 900000 and geo.intersects(Coordinates, POLYGON((-97.90117 30.547803,-97.870488 30.356415, -97.62669 30.430726, -97.90117 30.547803)))&$top=10 Top ▴