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
FloPlan
Terms of Use

Example: Searching Listings

When searching listings, familiarity with the Standard Fields service as well as the Search and Paging Syntax is vital.

 
  1. Authentication
  2. Retrieve standard field data for City
  3. Searching listings by City
  4. Paginating our results
 

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: Retrieve standard field data for City

First, we'll pull down the meta data for the City Standard Field. We see from the meta data below that it is Searchable and will be unmasked (e.g. MlsVisible) for the property types "A", "B", "C", "D", and "E". Since HasList is true, all possible listing values fall into a defined set of strings advertised in FieldList.

 
$ 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": [
         "City": {
            "ResourceUri": "/v1/standardfields/City",
            "HasList": true,
            "MaxListSize": 4,
            "Searchable": true,
            "MlsVisible": [
              "A",
              "B",
              "C",
              "D",
              "E"
            ],
            "Type": "Character",
            "FieldList": [
              {
                "Name": "Great Falls",
                "Value": "GREAT FALLS"
              },
              {
                "Name": "Augusta",
                "Value": "AUGUSTA"
              },
              {
                "Name": "Babb",
                "Value": "BABB"
              },
              {
                "Name": "Belgrade",
                "Applies To": [
                  "A",
                  "B",
                  "C",
                  "D"
                ],
                "Value": "BELGRADE"
              }
            ]
          }
        ]
    }
}
 
 

Step 3: Searching listings by City

Since "Augusta", unlike "Belgrade", is present in all property types, we'll use that City to search on in our example. Note that we want to use the Value, "AUGUSTA". The Value attribute is intended for use while searching, while the Name attribute is intended for display to the end user.

We'll include three parameters from the Search and Paging Syntax page: _filter for searching, _pagination to return pagination information, and _limit to only select a single listing at a time.

We'll also include the _select Attribute Selection parameter to limit the standard fields that are returned.

 
$ curl "https://sparkapi.com/v1/listings?_filter=City+Eq+%27AUGUSTA%27&_pagination=1&_limit=1&_select=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": [
          {
            "Id": "20100000000000000000000000",
            "ResourceUri": "/v1/listings/20100000000000000000000000",
            "StandardFields": {
              "City": "AUGUSTA"
            }
          }
        ],
        "Pagination": {
          "TotalRows": 100,
          "PageSize": 1,
          "CurrentPage": 1,
          "TotalPages": 100
        }
    }
}
 
 

Step 4: Searching listings by City

Viewing the next set of results is as simple as adding the _page parameter, and setting it to the next page: 2.

 
$ curl "https://sparkapi.com/v1/listings?_filter=City+Eq+%27AUGUSTA%27&_pagination=1&_limit=1&_select=City&_page=2" -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": [
          {
            "Id": "20100000000000000000000001",
            "ResourceUri": "/v1/listings/20100000000000000000000001",
            "StandardFields": {
              "City": "AUGUSTA"
            }
          }
        ],
        "Pagination": {
          "TotalRows": 100,
          "PageSize": 1,
          "CurrentPage": 2,
          "TotalPages": 100
        }
    }
}