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: 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

Example: Displaying Standard Field Labels

Standard fields have MLS-defined labels fit for display on listing reports. Additionally, some listing fields have values from a pre-determined list. For these fields, human readable values must be retrieved from the corresponding meta data service.

 
  1. Authentication
  2. Retrieving standard fields for the MLS
  3. Retrieving listing data
  4. Retrieving list item values for the City field
 

Step 1: Authentication

This example expects that you have already obtained an OAuth 2 authorization token to access a user's data. Read more on our OpendID Connect Authentication and OAuth 2 Authorization.

 

Step 2: Retrieving standard fields for the MLS

First, you'll need to consult the Listing Meta: Standard Fields service. Standard fields meta data rarely changes, so we recommend you cache this response locally.

In the example below, we find that the MLS label for BedsTotal is "Total Bedrooms"; thus, you should display this string on human-readable reports when presenting bedrooms information.

Lastly, we also see that the City field has HasList set to true. We know, then, that we'll need to make another API request label (Step 4) to find the appropriate label for each city.

The below response is intentionally abridged.

 
$ curl "https://sparkapi.com/v1/standardfields" -H "X-SparkApi-User-Agent: SparkAPIExamples" -H "Authorization: OAuth MY_OAUTH2_ACCESS_TOKEN" {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"1; mode=block", "X-Content-Type-Options"=>"nosniff"} 

{
    "D": {
        "Success": true,
        "LastUpdated":"2012-11-01T20:55:02Z",
        "Results": [
            {
                "BedsTotal": {
                    "Label": "Total Bedrooms",
                    "Searchable": true,
                    "Type": "Integer",
                    "ResourceUri": "/v1/standardfields/BedsTotal",
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    }
                },
                "City": {
                    "Label": "City",
                    "Searchable": true,
                    "Type": "Character",
                    "ResourceUri": "/v1/standardfields/City",
                    "HasList": true,
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    }
                }
            }
        ]
    }
}
 
 

Step 3: Retrieving listing data

As in the previous example, the below response is intentionally abridged.

 
$ curl "https://sparkapi.com/v1/listings/20100000000000000000000000" -H "X-SparkApi-User-Agent: SparkAPIExamples" -H "Authorization: OAuth MY_OAUTH2_ACCESS_TOKEN" {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"1; mode=block", "X-Content-Type-Options"=>"nosniff"} 
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listings/20100000000000000000000000",
                "Id": "20100000000000000000000000",
                "StandardFields": {
                  "City": "FAR",
                  "BedsTotal": 8
                }
            }
        ]
    }
}
 
 

Step 4: Retrieving list item values for the City field

Finally, since HasList was set to true in Step 2 for the City field, we'll need to find the appropriate label for the value 'FAR'. In the response below, we find that listing reports should display 'Fargo' to the end user.

 
$ curl "https://sparkapi.com/v1/standardfields/City" -H "X-SparkApi-User-Agent: SparkAPIExamples" -H "Authorization: OAuth MY_OAUTH2_ACCESS_TOKEN" {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"1; mode=block", "X-Content-Type-Options"=>"nosniff"} 
{
    "D": {
        "Success": true,
        "Results": [
            {
                "PropertySubType": {
                    "Label": "City",
                    "Searchable": true,
                    "Type": "Character",
                    "ResourceUri": "/v1/standardfields/City",
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    },
                    "HasList": true,
                    "FieldList": [
                        {
                            "Value": "FAR",
                            "Name": "Fargo",
                            "AppliesTo": [
                                "A",
                                "B",
                                "C"
                            ]
                        },
                        {
                            "Value": "MOOR",
                            "Name": "Moorhead",
                            "AppliesTo": [
                                "A",
                                "B",
                                "C"
                            ]
                        }
                    ]
                }
            }
        ]
    }
}