v2

latestOpenAPI 3.1.22026-08-07853184.9 KB

Lookup Listings

Lookup listings for a property

The property LookupListings endpoint returns an array of historical market listings from the recorder table when given the MelissaAddressKey.

The service requires at least one of the following input combinations:

Set A - mak

get/LookupListings

Query parameters

colsstring

Columns - The column names or groups to be output.

Entering the column name will return the column. Specifying a group name will return all columns in the group.

Delimit multiple columns with a ,.

For example: ColumnName,ColumnName.

Columns:

GrpAll - Recommended. Indicates to the Cloud API that all fields should be returned.

<details> <summary> <code>[Default]</code> - Always return in the output structure. Includes the following groups:</summary>

GrpListingInfo

</details> <details> <summary> <code>GrpListingAgent</code> - Listing agent Information </summary>

Address
BaseMAK
City
Email
LicenseNumber
MAK
NameFull
Phone
State
Zip

</details> <details> <summary> <code>GrpListingAgentOffice</code> - Listing Agent Office Information </summary>

Address
BaseMAK
City
Email
MAK
Name
Phone
State
Zip

</details> <details> <summary> <code>GrpListingFeatures</code> </summary>

Appliances
ElementarySchool
HighSchool
LotFeatures
MiddleSchool
SchoolDistrict

</details> <details> <summary> <code>GrpListingInfo</code> </summary>

CurrentListPrice
InitialStatus
ListingNumber
MaxListPrice
MaxListPriceDate
MinListPrice
MinListPriceDate
OriginalListingDate
RentalIndicator
SoldDate
SoldPrice
Status
StatusSubType

</details> <details> <summary> <code>GrpListingValue</code> </summary>

LastPriceChangeAmount
LastPriceChangeDate
LastStatusChange
LastStatusChangeDate
LastStatusSubTypeChange
LastStatusSubTypeChangeDate
PriorPriceChangeAmount
PriorPriceChangeDate
PriorStatusChange
PriorStatusChangeDate
PriorStatusSubTypeChange
PriorStatusSubTypeChangeDate

</details>

{"stackTrail":"components:parameters:LicenseKeyParam:schema","oasType":"schema","type":"unknown"}

Required. The License Key issued by Melissa.

format'json' | 'xml'

Desired format of the response.

optstring

Options - Specify which options to use. List options in <OptionName>:<Parameter> format. Multiple options are delimited with a ,.

For example: OptionName:Parameter,OptionName:Parameter.

Page:< Integer > - Specifies which “page” to return. Acceptable values are any integer.
RecordsPerPage:< 0 - 100 > - Default set to 1. Sets the records per “page”. Acceptable values are 0 to 100, inclusive.

tstring

Transmission Reference - This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

makstring

Melissa Address Key - A proprietary unique key identifier for an address derived from Address Checking.

Headers

Accept'application/json' | 'application/xml' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' required

Format of the request.

Response

Successful response

Versionstring

The current service version number.

TransmissionReferencestring

Serves as a unique request identifier.

Resultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Property Result Codes.

TotalRecordsinteger

Total number of records.

TransactionIDstring

A unique string identifier for this record. A unique transaction ID is generated for every record handled.