Spark API

FBS's proprietary REST API over Flexmls MLS content. Documented services include Listings (plus photos, documents, floor plans, videos, virtual tours, open houses, rooms, units, history and rules), Contacts, Saved Searches, Listing Carts, Portals/VOW accounts, Market Statistics, Overlays, Standard Fields and custom field metadata, System Info, and a Developers service for keys, roles, domains, authorizations and usage. Filtering uses SparkQL. Authentication is a Bearer access token obtained through OAuth 2 or an MLS-issued non-expiring token; anonymous requests return HTTP 401.

API entry from apis.yml

apis.yml Raw ↑
aid: spark-platform:spark-api
name: Spark API
description: FBS's proprietary REST API over Flexmls MLS content. Documented services include Listings
  (plus photos, documents, floor plans, videos, virtual tours, open houses, rooms, units, history and
  rules), Contacts, Saved Searches, Listing Carts, Portals/VOW accounts, Market Statistics, Overlays,
  Standard Fields and custom field metadata, System Info, and a Developers service for keys, roles, domains,
  authorizations and usage. Filtering uses SparkQL. Authentication is a Bearer access token obtained through
  OAuth 2 or an MLS-issued non-expiring token; anonymous requests return HTTP 401.
humanURL: https://sparkplatform.com/docs/overview/api
baseURL: https://sparkapi.com/v1
tags:
- MLS
- Property Listings
- Real Estate
- IDX
properties:
- type: Documentation
  url: https://sparkplatform.com/docs
- type: APIReference
  url: https://sparkplatform.com/docs/api_services/read_first
- type: Documentation
  url: https://sparkplatform.com/docs/api_services/listings
- type: Documentation
  url: https://sparkplatform.com/docs/api_services/market_statistics
- type: Documentation
  url: https://sparkplatform.com/docs/supporting_documentation/sparkql_grammar
- type: Documentation
  url: https://sparkplatform.com/docs/supporting_documentation/search_and_paging_syntax
- type: Authentication
  url: https://sparkplatform.com/docs/authentication/access_token
- type: ErrorCatalog
  url: errors/spark-platform-error-codes.yml
- type: Conventions
  url: conventions/spark-platform-conventions.yml
- type: Examples
  url: examples/spark-platform-request-examples.yml
- type: SignUp
  url: https://sparkplatform.com/register/developers
- type: TermsOfService
  url: https://sparkplatform.com/docs/terms_of_use/developer_agreement_and_terms_of_use