Privileged API Keys Only

Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

Developers: Syndications

Developer templates can be restricted to a syndication, which in turn determines which listings can be accessed by applications or data feeds used by that key. Individual listings will be opted in, or out, of each syndication.

Supported Roles
Available Services
1. All Syndications
2. Individual Syndication
Developer Syndications Description
Expansions

Supported Roles

Role	Reads	Writes	Notes
IDX	No	No
Public	No	No
VOW	No	No
Portal	No	No
Private	Yes	No	Only accessible by MLS and association users, and by API keys granted explicit permission.

More information about roles may be found here.

Available Services

All Syndications

`/<API Version>/developers/syndications`

HTTP Method	Description	Conditional	Notes
GET	Returns all syndication options for an MLS	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:

None

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
            "Id": "20160517183142081463000000",
            "ResourceUri": "/vX/developers/syndications/20160517183142081463000000",
            "MlsId": "20100517183236349236000000",
            "Name": "Listings SuperSite",
            "StandardName": null
          }
        ]
    }
}

Individual Syndications

`/<API Version>/developers/syndications/<Syndication.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns details for a single syndication record.	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:

None

GET Response

See the GET request section for for the syndications service.

Developers: Syndications Description

Attribute	Data Type	Description
`Id`	Integer	The unique id for the syndication record.
`ResourceUri`	Character	The URI to the individual syndication record.
`MlsId`	Character	The MLS the syndication belongs to.
`Name`	Character	The custom name for the syndication record.
`StandardName`	Character	If the syndication represents a syndication type standardized across multiple, or all MLSs, this will be the syndications unique standard name.

Expansions

None.