- Jump Right In!
- Listing Display
- MLS Data Sharing Agreements
- API URIs
- Rate Limit
- HTTP Headers
- API Clients
Jump Right In!
Already Have an API Key?We've written a simple PHP application demonstrating end-user authorization and data retrieval. Check out the project on github, poke around the source code, and run the application. If you're already set up with a web server and PHP, you should have this application up and running in minutes.
No API Key?You can still interact with the API right now using our API Explorer. You'll find links to the explorer on the bottom of the documentation for many API Services .
ExamplesWe have a growing set of API examples that will guide as you become familiar with our API. Check them out now, and check back often.
Be aware from the start that when you display listing data, you must follow the compliance rules defined by the MLS.
MLS Data Sharing AgreementsSome MLSs having data sharing agreements, allowing a user to search listings in other MLSs. Consult the MlsId field in the standard fields service to see the MLSs whose listing data can be accessed.
The API is versioned. The Listings resource for Spark API version 1, for example, will be located at https://sparkapi.com/v1/listings.
Note: The latest API version is /v1/.
Rate LimitThe API also is rate limited. If your key exceeds the rate limit, an HTTP 429 is returned along with the corresponding Spark API error code and a Retry-After header indicating the retry period. The limits are designed to be reasonable, but if you need a higher limit, please contact us.
HTTP HeadersPlease include the following user agent identifiers with each API request:
|User-Agent||Specifies the client library being used, such as one of the supported API clients listed below. If you are using one of the API clients, there is no need to set this header manually.|
|X-SparkApi-User-Agent||You must supply this request header, or your request will not be successful. Specifies the name of the software built on top of the client library. One example is the flexmls WordPress IDX plugin, which is built on the PHP API client linked below.|
API ClientsCheck out our list of Spark API clients.
Special considerations often apply when replicating. If you want to replicate data using Spark API, please review our replication documentation.