Developer Documentation
Platform Overview
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: 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: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar 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: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals 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
Terms of Use

Request Parameters

Data retrieval services typically include standard parameters for searching, sorting, and pagination. Take a look at the Oasis OData Documentation for more details.

  1. Attribute Selection
  2. Pagination
  3. Sorting
  4. Searching
  5. Expansions

Attribute Selection

The $select parameter allows you to specify the top-level data components you need. For larger data sets, such as properties, using this parameter will greatly reduce data retrieval time.

Parameter Description
$select A comma separated list specifying the attributes to be returned in the response payload.


Pagination allows data to be retrieved in sets of a specified size and provides additional data about the result set.

Parameter Description
$top Integer > 0 and <= 25 indicating how many results to return at once. The default is 10. For keys with the replication role it may be > 0 and <= 1000.
$skip Indicates the number of records to skip over when retrieving the current results set.
$count Boolean true or false. Indicates if the number of records in the total result set should be returned. Default is false.


Sorting is typically available on resources that allow searching.

Parameter Description
$orderby Indicates the order in which to return records in the result set. Each service has its own default order.

Any searchable field can be present in the $orderby parameter, with some exceptions (e.g. longer text fields such as PublicRemarks for properties).



Request parameters below are common to data retrieval services supporting searching.

Parameter Description
$filter OData filter syntax is used for filtering. Documentation can be found here.


Request parameters below are common to data retrieval services supporting pulling related entities.

The most basic example is to retrieve both media and listing data with a single call to the API. This can be done by including the $expand=Media parameter in a request on the /Property endpoint.

You are also able to pass pagination and search parameters that interact exclusively with the expanded entity. The syntax for such a request is $expand=Media($top=1) and the result of this particular example is the retrieval of a single media record for each listing in your payload.

Parameter Description
$expand OData expansion syntax is used for expansions. Documentation can be found here.