Developer Documentation
Platform Overview
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: Mapping Layers Flexmls: Mapping Shapegen 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: Floor Plans 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: Floor Plans Listings: FloPlans Listings: Historical Listings: History 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 News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences 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
Supporting Documentation
Terms of Use

Privileged API Keys Only

Special permission is required to access this service. Please contact or your API key provider to request access to this data.

Developers: Billing Summary Report

The developer billing services provide a usage overview specific to billable requests. This service only includes usage data from the past year.

  1. Supported Roles
  2. Available Services
    1. Request Billing Data
  3. Developer Billing Summary Description
  4. Expansions

Supported Roles

Role Reads Writes Notes
Public 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

Request Billing Summary

/<API Version>/developers/identities/<Identity.Id>/billing

HTTP Method Description Conditional Notes
GET Returns per-key hit information for the past year, or in the requested timeframe 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


Parameter Required Notes
Standard search and paging syntax No _orderby not permitted.
Timespan parameters No Default range includes the partial billing data for the current month as well as full billing data for the previous three months.

GET Response

    "D": {
        "Success": true,
        "Results": [
            "SuccessHits": 10000,
            "ClientErrorHits": 219,
            "ServerErrorHits": 0,
            "Key": {
              "Id": 5,
              "ResourceUri": "/vX/developers/identities/101/keys/5",
              "Type": "OAuth2",
              "Name": "My Application",
              "Key": "...",
              "RedirectUri: "",
              "ApplicationUri": "",
              "SingleSession": true,
              "Replication": false,
              "DataRole": "idx",
              "TemplateId": null,
              "Enabled": true,
              "Comments": null,
              "LastActive": "2012-03-07T21:13:11Z",
              "Editable": true,
              "ModificationTimestamp": "2014-06-27T10:01:06-05:00",
              "CreatedTimestamp": "2014-06-27T10:01:06-05:00"

Request Billing Summary Description

Attribute Data Type Searchable Description
SuccessHits Integer No The number of successful hits.
ClientErrorHits Integer No The number of hits that resulted in a client (4xx) error.
ServerErrorHits Integer No The number of hits that resulted in a server (5xx) error.
RequestDate Date Yes For searching only. Restricts the hit tallies to requests made in this time frame. This service only considers request data for the past year.
Key Developer keys Yes The API Key the requests were made under. Keys can be filtered as _filter="Key Eq 'my_api_key'", where my_api_key is the Key attribute.