Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Required Documents Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Required Documents Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Overlays Overlays: Shapes Portals Portals: Listing Categories Portals: Metadata Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Market Statistics

Overview

The Market Statistics API returns summary listing data about the market in specified geographical locations for display in a table, a graph, or other uses. Note that the data returns date fields, but the day is not significant; the data is actually for the month and year, not the day, month, and year.

  1. Supported Roles
  2. Available Services
    1. Absorption Rate
    2. Inventory
    3. Price
    4. Sale to List Price Ratios
    5. Days On Market
    6. Volume
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes No

More information about roles may be found here.

 

Available Services

Parameters common to all /marketstatistics services

Name Required Expected Notes
LocationField No String representing the location field (e.g. City) to return market statistic data Defaults to all locations if LocationField and LocationValue are not supplied
LocationValue No String representing the location value (e.g. Fargo) to return market statistic data Defaults to all locations if LocationField and LocationValue are not supplied
PropertyTypeCode No One MlsCode (property type code) from the Property Types API Defaults to the first Residential property type
Options No Varies based on each service See documentation for each service

Absorption Rate

URI: /<API Version>/marketstatistics/absorption

Common parameters plus the following:

GET Request

Name Required Expected Notes
Options No Comma-separated string with one or many of the following options:
  • AbsorptionRate
The default if no Options parameter is specified is AbsorptionRate

GET Response

{ "Dates":                      ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
                                 "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
                                 "1/1/2010","12/1/2009"],
 "AbsorptionRate":              [6.11,5.14,4.51,5.15,5.33,6.01,4.92,4.98,5.01,5.33,4.77,4.1]
}
 

Inventory

URI: /<API Version>/marketstatistics/inventory

Common parameters plus the following:

GET Request

Name Required Expected Notes
Options No Comma-separated string with one or many of the following options:
  • ActiveListings
  • NewListings
  • PendedListings
  • SoldListings
The default if no Options parameter is specified is ActiveListings,NewListings

GET Response

{ "Dates":                      ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
                                 "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
                                 "1/1/2010","12/1/2009"],
 "ActiveListings":              [10000,10005,10010,10015,9998,10221,10125,10222,10315,10008,10009,10001],
 "NewListings":                 [100,101,105,109,99,100,105,102,102,98,95,92],
 "PendedListings":              [100,101,105,109,99,100,105,102,102,98,95,92],
 "SoldListings":                [100,101,105,109,99,100,105,102,102,98,95,92]
}
 

Price

URI: /<API Version>/marketstatistics/price

Common parameters plus the following:

GET Request

Name Required Expected Notes
Options No Comma-separated string with one or many of the following options:
  • ActiveAverageListPrice
  • NewAverageListPrice
  • PendedAverageListPrice
  • SoldAverageListPrice
  • SoldAverageSoldPrice
  • ActiveMedianListPrice
  • NewMedianListPrice
  • PendedMedianListPrice
  • SoldMedianListPrice
  • SoldMedianSoldPrice
The default if no Options parameter is specified is ActiveAverageListPrice, ActiveMedianListPrice, NewAverageListPrice, NewMedianListPrice

GET Response

{ "Dates":                      ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
                                 "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
                                 "1/1/2010","12/1/2009"],
 "ActiveAverageListPrice":      [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "NewAverageListPrice":         [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "PendedAverageListPrice":      [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "SoldAverageListPrice":        [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "SoldAverageSoldPrice":        [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "ActiveMedianListPrice":       [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "NewMedianListPrice":          [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "PendedMedianListPrice":       [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "SoldMedianListPrice":         [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000],
 "SoldMedianSoldPrice":         [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000]
}

Sales to List Price Ratios

URI: /<API Version>/marketstatistics/ratio

Common parameters plus the following:

GET Request

Name Required Expected Notes
Options No Comma-separated string with one or many of the following options:
  • SaleToOriginalListPriceRatio
  • SaleToListPriceRatio
The default if no Options parameter is specified is SaleToOriginalListPriceRatio

GET Response

{ "Dates":                      ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
                                 "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
                                 "1/1/2010","12/1/2009"],
 "SaleToOriginalListPriceRatio":[0.9834,0.9941,0.9898,0.9834,0.9941,0.9898,0.9834,0.9941,0.9898,0.9834,0.9941,0.9898],
 "SaleToListPriceRatio":        [0.9834,0.9941,0.9898,0.9834,0.9941,0.9898,0.9834,0.9941,0.9898,0.9834,0.9941,0.9898]
}
 

Days On Market

URI: /<API Version>/marketstatistics/dom

Common parameters plus the following:

GET Request

Name Required Expected Notes
Options No Comma-separated string with one or many of the following options:
  • AverageDom
  • AverageCdom
The default if no Options parameter is specified is AverageDom

GET Response

{ "Dates":                      ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
                                 "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
                                 "1/1/2010","12/1/2009"],
 "AverageDom":                  [100,99,98,97,95,91,101,112,92,88,89,90],
 "AverageCdom":                 [100,99,98,97,95,91,101,112,92,88,89,90]
}
 

Volume

URI: /<API Version>/marketstatistics/volume

Common parameters plus the following:

GET Request

Name Required Expected Notes
Options No Comma-separated string with one or many of the following options:
  • ActiveListVolume
  • NewListVolume
  • PendedListVolume
  • SoldListVolume
  • SoldSaleVolume
The default if no Options parameter is specified is ActiveListVolume,NewListVolume

GET Response

{ "Dates":                      ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
                                 "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
                                 "1/1/2010","12/1/2009"],
 "ActiveListVolume":            [135650975,155736691,144529581,135650975,155736691,144529581,
                                 135650975,155736691,144529581,135650975,155736691,144529581],
 "NewListVolume":               [135650975,155736691,144529581,135650975,155736691,144529581,
                                 135650975,155736691,144529581,135650975,155736691,144529581],
 "PendedListVolume":            [135650975,155736691,144529581,135650975,155736691,144529581,
                                 135650975,155736691,144529581,135650975,155736691,144529581],
 "SoldListVolume":              [135650975,155736691,144529581,135650975,155736691,144529581,
                                 135650975,155736691,144529581,135650975,155736691,144529581],
 "SoldSaleVolume":              [135650975,155736691,144529581,135650975,155736691,144529581,
                                 135650975,155736691,144529581,135650975,155736691,144529581]
}