Privileged API Keys Only
Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.
Properties: Standard Fields
The Properties Standard Fields API is used to retrieve a list of supported standard fields for Properties.
Alpha Only: This service is subject to change
This service is a work in progress. It is currently subject to change or removal without notice.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | No |
More information about roles may be found here.
Available Services
Properties: Standard Fields
/<API Version>/properties/standardfields
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves standard fields data | 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
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": {
"ResourceUri": "/v1/properties/standardfields/Id",
"Type": "Integer",
"Searchable": true,
"Label": "Id",
"Currency": false
},
"StreetNumber": {
"ResourceUri": "/v1/properties/standardfields/StreetNumber",
"Type": "Character",
"Searchable": true,
"Label": "StreetNumber",
"Currency": false
},
"StreetDirPrefix": {
"ResourceUri": "/v1/properties/standardfields/StreetDirPrefix",
"Type": "Character",
"Searchable": true,
"Label": "StreetDirPrefix",
"Currency": false
},
"StreetName": {
"ResourceUri": "/v1/properties/standardfields/StreetName",
"Type": "Character",
"Searchable": true,
"Label": "StreetName",
"Currency": false
},
"StreetSuffix": {
"ResourceUri": "/v1/properties/standardfields/StreetSuffix",
"Type": "Character",
"Searchable": true,
"Label": "StreetSuffix",
"Currency": false
},
"StreetDirSuffix": {
"ResourceUri": "/v1/properties/standardfields/StreetDirSuffix",
"Type": "Character",
"Searchable": true,
"Label": "StreetDirSuffix",
"Currency": false
},
"UnitNumber": {
"ResourceUri": "/v1/properties/standardfields/UnitNumber",
"Type": "Character",
"Searchable": true,
"Label": "UnitNumber",
"Currency": false
},
"City": {
"ResourceUri": "/v1/properties/standardfields/City",
"Type": "Character",
"Searchable": true,
"Label": "City",
"Currency": false
},
"StateOrProvince": {
"ResourceUri": "/v1/properties/standardfields/StateOrProvince",
"Type": "Character",
"Searchable": true,
"Label": "StateOrProvince",
"Currency": false
},
"PostalCode": {
"ResourceUri": "/v1/properties/standardfields/PostalCode",
"Type": "Character",
"Searchable": true,
"Label": "PostalCode",
"Currency": false
},
"PostalCodePlus4": {
"ResourceUri": "/v1/properties/standardfields/PostalCodePlus4",
"Type": "Character",
"Searchable": true,
"Label": "PostalCodePlus4",
"Currency": false
},
"Country": {
"ResourceUri": "/v1/properties/standardfields/Country",
"Type": "Character",
"Searchable": true,
"Label": "Country",
"Currency": false
},
"CountyOrParish": {
"ResourceUri": "/v1/properties/standardfields/CountyOrParish",
"Type": "Character",
"Searchable": true,
"Label": "CountyOrParish",
"Currency": false
},
"Municipality": {
"ResourceUri": "/v1/properties/standardfields/Municipality",
"Type": "Character",
"Searchable": true,
"Label": "Municipality",
"Currency": false
},
"Township": {
"ResourceUri": "/v1/properties/standardfields/Township",
"Type": "Character",
"Searchable": true,
"Label": "Township",
"Currency": false
},
"SubdivisionName": {
"ResourceUri": "/v1/properties/standardfields/SubdivisionName",
"Type": "Character",
"Searchable": true,
"Label": "SubdivisionName",
"Currency": false
},
"ParcelNumber": {
"ResourceUri": "/v1/properties/standardfields/ParcelNumber",
"Type": "Character",
"Searchable": true,
"Label": "ParcelNumber",
"Currency": false
},
"YearBuilt": {
"ResourceUri": "/v1/properties/standardfields/YearBuilt",
"Type": "Integer",
"Searchable": true,
"Label": "YearBuilt",
"Currency": false
},
"RoomsTotal": {
"ResourceUri": "/v1/properties/standardfields/RoomsTotal",
"Type": "Integer",
"Searchable": true,
"Label": "RoomsTotal",
"Currency": false
},
"BedroomsTotal": {
"ResourceUri": "/v1/properties/standardfields/BedroomsTotal",
"Type": "Integer",
"Searchable": true,
"Label": "BedroomsTotal",
"Currency": false
},
"BathroomsTotal": {
"ResourceUri": "/v1/properties/standardfields/BathroomsTotal",
"Type": "Decimal",
"Searchable": true,
"Label": "BathroomsTotal",
"Currency": false
},
"BathroomsFull": {
"ResourceUri": "/v1/properties/standardfields/BathroomsFull",
"Type": "Integer",
"Searchable": true,
"Label": "BathroomsFull",
"Currency": false
},
"BathroomsHalf": {
"ResourceUri": "/v1/properties/standardfields/BathroomsHalf",
"Type": "Integer",
"Searchable": true,
"Label": "BathroomsHalf",
"Currency": false
},
"BathroomsThreeQuarter": {
"ResourceUri": "/v1/properties/standardfields/BathroomsThreeQuarter",
"Type": "Integer",
"Searchable": true,
"Label": "BathroomsThreeQuarter",
"Currency": false
},
"LivingArea": {
"ResourceUri": "/v1/properties/standardfields/LivingArea",
"Type": "Integer",
"Searchable": true,
"Label": "LivingArea",
"Currency": false
},
"AttachedGarageYN": {
"ResourceUri": "/v1/properties/standardfields/AttachedGarageYN",
"Type": "boolean",
"Searchable": true,
"Label": "AttachedGarageYN",
"Currency": false
},
"BuildingAreaTotal": {
"ResourceUri": "/v1/properties/standardfields/BuildingAreaTotal",
"Type": "Integer",
"Searchable": true,
"Label": "BuildingAreaTotal",
"Currency": false
},
"Stories": {
"ResourceUri": "/v1/properties/standardfields/Stories",
"Type": "Integer",
"Searchable": true,
"Label": "Stories",
"Currency": false
},
"LotSizeAcres": {
"ResourceUri": "/v1/properties/standardfields/LotSizeAcres",
"Type": "Decimal",
"Searchable": true,
"Label": "LotSizeAcres",
"Currency": false
},
"LotSizeSquareFeet": {
"ResourceUri": "/v1/properties/standardfields/LotSizeSquareFeet",
"Type": "Integer",
"Searchable": true,
"Label": "LotSizeSquareFeet",
"Currency": false
},
"TaxYear": {
"ResourceUri": "/v1/properties/standardfields/TaxYear",
"Type": "Integer",
"Searchable": true,
"Label": "TaxYear",
"Currency": false
},
"TaxAnnualAmount": {
"ResourceUri": "/v1/properties/standardfields/TaxAnnualAmount",
"Type": "Decimal",
"Searchable": true,
"Label": "TaxAnnualAmount",
"Currency": true
},
"TaxAssessedValue": {
"ResourceUri": "/v1/properties/standardfields/TaxAssessedValue",
"Type": "Decimal",
"Searchable": true,
"Label": "TaxAssessedValue",
"Currency": true
}
}
]
}
}
Properties Standard Fields Description
| Attribute | Data Type | Description |
|---|---|---|
ResourceUri |
Character | The URI for the individual field's metadata. |
Type |
Character | The data type of the field. |
Searchable |
Boolean | true if Properties can be filtered by the field. |
Label |
Character | The human-friendly label for the standard field. |
Currency |
Boolean | true if the attribute represents currency data. |
Expansions
None.