Standard Fields

Not all listing data is suitable for display.
When using the Listings Service, you must consult the corresponding meta data services (e.g. Property Types and Standard Fields) for the PropertyType standard field and any other field where the HasList is true in the meta data.

See an example here.

The Standard Fields API allows retrieval of a list of supported standard fields and list items. Of special note is the MlsId field, which informs which other MLSs the current user may search.

  1. Supported Roles
  2. Available Services
    1. All Standard Fields
    2. Individual Standard Field
    3. Last Updated Timestamp
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes
IDX Yes No
VOW Yes No
Private Yes No

More information about roles may be found here.

Available Services

All Standard Fields

URI: /<API Version>/standardfields

URI: /<API Version>/mls/<MlsId>/standardfields

HTTP Method Description Conditional Notes
GET Returns standard field metadata Yes
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

Parameter Description Required
_mls A comma-separated list of MLS IDs the standard fields should be common across No

GET Response

{
    "D": {
        "Success": true,
        "LastUpdated":"2012-11-01T20:55:02Z",
        "Results": [
            {
                "City": {
                    "Label": "City",
                    "Searchable": true,
                    "Type": "Character",
                    "ResourceUri": "/v1/standardfields/City",
                    "HasList": true,
                    "MultiSelect": false,
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    }
                },
                "BedsTotal": {
                    "Label": "Total Bedrooms",
                    "Searchable": true,
                    "Type": "Integer",
                    "ResourceUri": "/v1/standardfields/BedsTotal",
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    }
                },
                "ListPrice": {
                    "Label": "Listing Price",
                    "Searchable": true,
                    "Type": "Decimal",
                    "ResourceUri": "/v1/standardfields/ListPrice",
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    }
                },
                "MlsId": {
                    "Label": "MLS ID",
                    "Searchable": true,
                    "Type": "Character",
                    "ResourceUri": "/v1/standardfields/MlsId",
                    "HasList": true,
                    "MaxListSize": 1,
                    "MultiSelect": false,
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    }
                },
                "PendingDate": {
                    "Label": "Pending Date",
                    "Searchable": true,
                    "Type": "Character",
                    "ResourceUri": "/v1/standardfields/PendingDate",
                    "Defaults": {
                        "FromQuantity": "6",
                        "FromUnit": "months",
                        "ToQuantity": "10",
                        "ToUnit": "years"
                    },
                    "MlsVisible": {
                        "PropertyTypes": []
                    }
                },
                "PoolFeatures": {
                    "ResourceUri": "/v1/standardfields/PoolFeatures",
                    "Label": "Pool Features",
                    "HasList": true,
                    "MultiSelect": true,
                    "MaxListSize": 3,
                    "Searchable": true,
                    "Type": "Boolean",
                    "MlsVisible": [
                        "A",
                        "B"
                    ]
                }
            }
        ]
    }
}
Restricted Fields
The MlsVisible field lists all property types where the standard field is not restricted by the MLS. Listings whose PropertyType is not present in the array will have the corresponding standard field value masked (i.e. have a value of "********").

Individual Standard Field

URI: /<API Version>/standardfields/<StandardField>

URI: /<API Version>/mls/<MlsId>/standardfields/<StandardField>

HTTP Method Description Conditional Notes
GET Returns standard field metadata for an individual field Yes
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

Parameters:

Parameter Description Required
_mls A comma-separated list of MLS IDs the standard fields should be common across No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "PropertySubType": {
                    "Label": "Property Sub-Type",
                    "Searchable": true,
                    "Type": "Character",
                    "ResourceUri": "/v1/standardfields/PropertySubType",
                    "MlsVisible": {
                        "PropertyTypes": ["A","B","C"]
                    },
                    "HasList": true,
                    "FieldList": [
                        {
                            "Value": "SF",
                            "Name": "Single Family",
                            "AppliesTo": [
                                "A",
                                "B",
                                "C"
                            ]
                        },
                        {
                            "Value": "CD",
                            "Name": "Condo",
                            "AppliesTo": [
                                "A",
                                "B",
                                "C"
                            ]
                        },
                        {
                            "Value": "CO",
                            "Name": "Commercial",
                            "AppliesTo": [
                                "D"
                            ]
                        }
                    ]
                }
            }
        ]
    }
}

Last Updated Timestamp

URI: /<API Version>/standardfields/lastupdated

URI: /<API Version>/mls/<MlsId>/standardfields/lastupdated

HTTP Method Description Conditional Notes
GET Returns the LastUpdated attribute, which notes the last time the data provided by this service was updated. Yes
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

Parameters:
  • None

GET Response

{ 
  "D": {
    "Success": true,
    "LastUpdated":"2012-11-01T20:55:02Z"
  }
}

Response Description

The top level LastUpdated attribute is only available for the All service and reflects the last time any fields in the result list was updated.

Attribute Description
ResourceUri The URI to retrieve the field data from.
Type The data type of the field.
Label The human-friendly label for the standard field.
Searchable true if the listings can be filtered by the field.
MlsVisible.PropertyTypes An array of PropertyType.MlsCode detailing which property types corresponding listing data will be visible under.
HasList true if the field has a FieldList attribute.
MultiSelect true if the field has a FieldList attribute and listing data for this field can have multiple values from this list.

The Defaults attribute is only available for Date types:

Attribute Description
Defaults.FromQuantity The quantity to apply to FromUnit.
Defaults.FromUnit One of the following: day, month, year.
Defaults.ToQuantity The quantity to apply to ToUnit.
Defaults.ToUnit One of the following: day, month, year.


The FieldList attribute is only present when retrieving an individual field for data where HasList=true:

Attribute Description
FieldList.Name The human friendly name for the field.
FieldList.Value The searchable code for the field.
FieldList.AppliesTo An array of PropertyType.MlsCode the field list item is valid under.


When the MultiSelect attribute for a field is true, the listing may have multiple values from FieldList. In the Listing payload, the field is represented as an associative array. Below is an example of the PoolFeature field for a listing.

{
    "D": {
        "Results": [
            {
                "StandardFields": {
                    "PoolFeatures": {
                        "Private": true
                    }
                }
            }
        ],
        "Success": true
    }
}
See the Listing Search Parameters page for details on using this field with the _filter parameter.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.