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 Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates 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: 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: 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: 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 Messages 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 Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields 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
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Broker Distributions

The Broker Distributions Metadata service allows retrieval of distribution options available within an MLS and allows us to filter a subset of those which are available within an office.

  1. Supported Roles
  2. Available Services
    1. MLS Broker Distributions
    2. MLS broker distributions filtered by agent or broker
    3. Individual Broker Distributions
  3. Broker Distribution Description
  4. Expansions
  5. API Explorer
 

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

MLS broker distributions

/<API Version>/brokerdistributions

HTTP Method Description Conditional Notes
GET Returns a list of distributions available for the MLS. This is a full list of available options in the MLS, to get options for the listing agent or broker filter this with their Account Id. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
      "D": {
          "Results": [
              {
                  "Id": "20171114172142952062000000",
                  "ResourceUri": "/v1/brokerdistributions/20171114172142952062000000",
                  "MlsId": "20000426143505724628000000",
                  "OwnerId": "20000426143505724628000000",
                  "Name": "Example",
                  "ExclusionDefault": false,
                  "ExclusionEditable": true,
                  "PropertyTypeRestrictions": [
                      "A",
                      "B",
                      "C",
                      "D",
                      "E",
                      "G",
                      "I"
                  ]
              }
          ],
          "Success": true
      }
  }
 
 

MLS broker distributions filtered by agent or broker

/<API Version>/brokerdistributions/accounts/<ListingAgent.Id>

HTTP Method Description Conditional Notes
GET Returns distributions for the listing agent or broker. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
      "D": {
          "Results": [
              {
                  "Id": "20171114172142952062000000",
                  "ResourceUri": "/v1/brokerdistributions/20171114172142952062000000",
                  "MlsId": "20000426143505724628000000",
                  "OwnerId": "20000426143505724628000000",
                  "Name": "Example",
                  "ExclusionDefault": false,
                  "ExclusionEditable": true,
                  "PropertyTypeRestrictions": [
                      "A",
                      "B",
                      "C",
                      "D",
                      "E",
                      "G",
                      "I"
                  ]
              }
          ],
          "Success": true
      }
  }
 
 

Individual distribution

/<API Version>/brokerdistributions/<BrokerDistribution.Id>

HTTP Method Description Conditional Notes
GET Returns individual distribution No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
      "D": {
          "Results": [
              {
                  "Id": "20171114172142952062000000",
                  "ResourceUri": "/v1/brokerdistributions/20171114172142952062000000",
                  "MlsId": "20000426143505724628000000",
                  "OwnerId": "20000426143505724628000000",
                  "Name": "Example",
                  "ExclusionDefault": false,
                  "ExclusionEditable": true,
                  "PropertyTypeRestrictions": [
                      "A",
                      "B",
                      "C",
                      "D",
                      "E",
                      "G",
                      "I"
                  ]
              }
          ],
          "Success": true
      }
  }
 
 

Expansions

 

Broker Distributions Description

Attribute Data Type Description
Id Character The distribution id.
MlsId Character The ID of the MLS that owns the distribution.
OwnerId Character The Id of the MLS or Broker who owns the distribution.
Name Character Name of the distribution
ExclusionDefault Boolean True if the distribution should be excluded by default.
ExclusionEditable Boolean True if the listing agent has a choice whether or not to choose this option on input.
PropertyTypeRestrictions Character List A list of property type codes which this distribution is restricted to. null signifies no restrictions.
 

API Explorer

Interact with this service using the API Explorer.