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: 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: 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: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Portals 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
FloPlan
Terms of Use

Developers: Domains

This service allows developers to register and manage the domains which are displaying data from an API Key. These are used to verify that data provided to the clients using each API key are only available on these authorized domains. It also requires linking an account which provides details to the MLS organizations on who these domains are servicing.

 
  1. Supported Roles
  2. Available Services
    1. Retrieve domains for the current key
    2. Individual domain for the current_key
    3. Retrieve domains for an API key
    4. Individual domain for an API key
  3. Domain Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes Yes
Public Yes Yes
VOW (As Portal Group) Yes Yes
Portal (As Portal Group) Yes Yes
Private Yes Yes Only the domains for the current request's API Identity and Key are available except for privileged api keys.

More information about roles may be found here.

 

Available Services

Retrieve domains for the current key

/<API Version>/developers/domains

Retrieves all domains for the API key making the request.

HTTP Method Description Conditional Notes
GET Returns domains for the current API Identity and Key. No
POST Registers a domain for the API Key No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

Parameter Required Notes
Standard search and paging syntax No
 
 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                    "Id": 1,
                    "Uri": "example.com",
                    "AccountId": "20000426143505724621000000",
                    "ModificationTimestamp": "2017-12-05T20:11:43Z",
                    "CreatedTimestamp": "2017-12-05T20:11:43Z"
            }
        ]
    }
}
 

POST Request

Request body:

{
    "D": {
      "Uri": "my-new-domain.com"
    }
}
 

POST Response

The standard success/fail response is returned.

 
 

Individual domain for the current key

/<API Version>/developers/domains/<Domain.Id>

Retrieve or update an individual domain for current key.

HTTP Method Description Conditional Notes
GET Returns domain information for a individual domain No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates a registered domain for the API Key No
DELETE Unregisters a domain for the API Key No

GET Request

Parameters:

 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                    "Id": 1,
                    "Uri": "example.com",
                    "AccountId": "20000426143505724621000000",
                    "ModificationTimestamp": "2017-12-05T20:11:43Z",
                    "CreatedTimestamp": "2017-12-05T20:11:43Z"
            }
        ]
    }
}
 

PUT Request

Request body:

{
    "D": {
      "Uri": "my-updated-domain.com"
    }
}
 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Available Services

All domains for developer key

/<API Version>/developers/identities/<Identity.Id>/keys/<Key.Id>/domains

Retrieve domains for an API key. Only applications granted explicit permission may access domains for identities and keys which are not their own.

HTTP Method Description Conditional Notes
GET Returns domains for the API key. No
POST Registers a domain for the API key. No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

Parameter Required Notes
Standard search and paging syntax No
 
 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                    "Id": 1,
                    "Uri": "example.com",
                    "AccountId": "20000426143505724621000000",
                    "ModificationTimestamp": "2017-12-05T20:11:43Z",
                    "CreatedTimestamp": "2017-12-05T20:11:43Z"
            }
        ]
    }
}
 

POST Request

Request body:

{
    "D": {
      "Uri": "my-new-domain.com"
    }
}
 

POST Response

The standard success/fail response is returned.

 
 

Individual Domain

/<API Version>/developers/identities/<Identity.Id>/keys/<Key.Id>/domains/<Domain.Id>

Retrieve or update a individual domain for the the API Key. Only applications granted explicit permission may access domains for identities and keys which are not their own.

HTTP Method Description Conditional Notes
GET Returns domain information for an individual domain No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates a registered domain for the API Key No
DELETE Unregisters a domain for the API Key No

GET Request

Parameters:

 

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                    "Id": 1,
                    "Uri": "example.com",
                    "AccountId": "20000426143505724621000000",
                    "ModificationTimestamp": "2017-12-05T20:11:43Z",
                    "CreatedTimestamp": "2017-12-05T20:11:43Z"
            }
        ]
    }
}
 

PUT Request

Request body:

{
    "D": {
      "Uri": "my-updated-domain.com"
    }
}
 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Domain Description

Attribute Data Type Writeable Required Searchable Description
Id Integer No No No The unique ID for the domain record.
AccountId Character Yes Yes No The account that owns this domain.
Uri Character Yes Yes Yes The URI of the domain.
ModificationTimestamp DateTime No No No The timestamp the modification occured.
CreatedTimestamp DateTime No No No The timestamp the record was created.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.