Property

Property#

Introduction #

Property can:

Look up U.S. properties by address, county FIPS (Federal Information Processing Standards) and APN (Assessor’s Parcel Number), or Melissa Address Key (MAK)
Find the owner’s name, address, and value of the home
Learn about the various properties and characteristics of a property such as size, rooms, number of buildings, amenities, improvements, etc.
Search through historical deeds for a home to see past buyers and sales
Find other properties owned by a homeowner

Click here to learn more about the Property Cloud API.

The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at Sales@Melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Property will not function.

Initialization #

There are two different constructors that you can utilize when initializing Property.

Property(string license)

Initialize the Cloud API object with a license key

C#
Python

Property property = new Property(MELISSA_LICENSE_KEY);

property = Property(MELISSA_LICENSE_KEY)

Property()

Initialize the Cloud API object, which will read the license key from the environment variable MD_LICENSE or configured using a set method

Click here to learn more about setting up the environment variable.

C#
Python

Property property = new Property()

property = Property()

Configuration #

Property supports both GET and POST requests.

(GET) Using one of three ways to configure each respective parameter
(POST) Using the Set Post Body Method to pass a PropertyPostRequest object as the pre-constructed post body containing all parameters and records to process
(POST) Using Set Methods to configure base parameters and the Add Records Method to pass records to process

Requests #

GET #

To send a GET request, there are three ways you can configure the parameters to make a request.

Method 1: Using the Set Value Method to specify the parameter and value you want to set it to
Method 2: Using direct property access to set parameter values
Method 3: Using specialized Set Methods to set parameter values

Method 1: Using Set Value Method #

This function allows you to specify input parameters and the values you went to set them to.

Format

C#
Python

property.SetValue("AddressLine1", ADDRESS_LINE_1);
property.SetValue("City", CITY);
property.SetValue("State", STATE);

property.set_value("address_line_1", ADDRESS_LINE_1)
property.set_value("city", CITY)
property.set_value("state", STATE)

Example

C#
Python

property.SetValue("AddressLine1", "22382 Avenida Empresa");
property.SetValue("City", "Rancho Santa Margarita");
property.SetValue("State", "CA");

property.set_value("address_line_1", "22382 Avenida Empresa")
property.set_value("city", "Rancho Santa Margarita")
property.set_value("state", "CA")

Method 2: Using Direct Property Access #

This allows you to set values directly using the Cloud API’s parameter names.

Format

C#
Python

property.AddressLine1 = ADDRESS_LINE_1;
property.City = CITY;
property.State = STATE;

property.address_line_1 = ADDRESS_LINE_1
property.city = CITY
property.state = STATE

Example

C#
Python

property.AddressLine1 = "22382 Avenida Empresa";
property.City = "Rancho Santa Margarita";
property.State = "CA";

property.address_line_1 = "22382 Avenida Empresa"
property.city = "Rancho Santa Margarita"
property.state = "CA"

Method 3: Using Specialized Methods #

These functions allow you to set the input parameters for the Cloud API.

See Set Methods for a list of available parameters.

Format

C#
Python

property.SetAddressLine1(ADDRESS_LINE_1);
property.SetCity(CITY);
property.SetState(STATE);

property.set_address_line_1(ADDRESS_LINE_1)
property.set_city(CITY)
property.set_state(STATE)

Example

C#
Python

property.SetAddressLine1("22382 Avenida Empresa");
property.SetCity("Rancho Santa Margarita");
property.SetState("CA");

property.set_address_line_1("22382 Avenida Empresa")
property.set_city("Rancho Santa Margarita")
property.set_state("CA")

POST #

To send a POST request, there are two ways you can configure the parameters to make a request.

Method 1: Using the Set Post Body Method to pass a PropertyPostRequest object as the pre-constructed post body containing all parameters and records to process
Method 2: Using Set Methods to configure base parameters and the Add Records Method to pass records to process

A maximum of 100 records can be sent per request.

Method 1: Set Post Body #

This function allows you to pass a pre-constructed post body with all parameters and records for POST requests.

Format

C#
Python

property.SetPostBody(new PropertyPostRequest
{
  CustomerId = MELISSA_LICENSE_KEY,
  TotalRecords = "2",
  Records = new List<PropertyRecordRequest>
  {
    new PropertyRecordRequest
    {
      RecordId = RECORD_ID,
      AddressLine1 = ADDRESS_LINE_1,
      City = CITY,
      State = STATE,
      PostalCode = POSTAL_CODE
    },
    new PropertyRecordRequest
    {
      RecordId = RECORD_ID,
      AddressLine1 = ADDRESS_LINE_1,
      City = CITY,
      State = STATE,
      PostalCode = POSTAL_CODE
    }
  }
});

property.set_post_body(PropertyPostRequest(
  customer_id = MELISSA_LICENSE_KEY,
  total_records = "2",
  records=[
    PropertyRecordRequest(
      record_id = RECORD_ID,
      address_line_1 = ADDRESS_LINE_1,
      city = CITY,
      state = STATE,
      postal_code = POSTAL_CODE
    ),
    PropertyRecordRequest(
      record_id = RECORD_ID,
      address_line_1 = ADDRESS_LINE_1,
      city = CITY,
      state = STATE,
      postal_code = POSTAL_CODE
    )
  ]
))

Example

C#
Python

property.SetPostBody(new PropertyPostRequest
{
    CustomerId = MELISSA_LICENSE_KEY,
    TotalRecords = "2",
    Records = new List<PropertyRecordRequest>
    {
      new PropertyRecordRequest
      {
        RecordId = "1",
        AddressLine1 = "22382 Avenida Empresa",
        City = "RSM",
        State = "CA",
        PostalCode = "92688"
      },
      new PropertyRecordRequest
      {
        RecordId = "2",
        AddressLine1 = "1 Microsoft Way",
        City = "Redmond",
        State = "WA",
        PostalCode = "98052"
      }
    }
});

property.set_post_body(PropertyPostRequest(
  customer_id = MELISSA_LICENSE_KEY,
  total_records = "2",
  records=[
    PropertyRecordRequest(
      record_id = "1",
      address_line_1 = "22382 Avenida Empresa",
      city = "RSM",
      state = "CA",
      postal_code = "92688"
    ),
    PropertyRecordRequest(
      record_id = "2",
      address_line_1 = "1 Microsoft Way",
      city = "Redmond",
      state = "WA",
      postal_code = "98052"
    )
  ]
))

Method 2: Set Input Parameters and Add Records #

You will use set methods to configure the base parameters (license, options, transmission reference), and use the function below to add records for POST requests.

See Set Methods for a list of available parameters.

Format

C#
Python

property.SetLicense(MELISSA_LICENSE_KEY);
property.SetTotalRecords("2");

property.AddRecord(new PropertyRecordRequest
{
  RecordId = RECORD_ID,
  AddressLine1 = ADDRESS_LINE_1,
  City = CITY,
  State = STATE,
  PostalCode = POSTAL_CODE
});

property.AddRecord(new PropertyRecordRequest
{
  RecordId = RECORD_ID,
  AddressLine1 = ADDRESS_LINE_1,
  City = CITY,
  State = STATE,
  PostalCode = POSTAL_CODE
});

property_instance = Property(MELISSA_LICENSE_KEY)

property_instance.add_record(PropertyRecordRequest(
  record_id = RECORD_ID,
  address_line_1 = ADDRESS_LINE_1,
  city = CITY,
  state = STATE,
  postal_code = POSTAL_CODE
))

property_instance.add_record(PropertyRecordRequest(
  record_id = RECORD_ID,
  address_line_1 = ADDRESS_LINE_1,
  city = CITY,
  state = STATE,
  postal_code = POSTAL_CODE
))

Example

C#
Python

property.SetLicense(MELISSA_LICENSE_KEY);
property.SetTotalRecords("2");

property.AddRecord(new PropertyRecordRequest
{
    RecordId = "1",
    AddressLine1 = "22382 Avenida Empresa",
    City = "RSM",
    State = "CA",
    PostalCode = "92688"
});

property.AddRecord(new PropertyRecordRequest
{
    RecordId = "2",
    AddressLine1 = "1 Microsoft Way",
    City = "Redmond",
    State = "WA",
    PostalCode = "98052"
});

property_instance = Property(MELISSA_LICENSE_KEY)

property_instance.add_record(PropertyRecordRequest(
  record_id = "1",
  address_line_1 = "22382 Avenida Empresa",
  city = "RSM",
  state = "CA",
  postal_code = "92688"
))

property_instance.add_record(PropertyRecordRequest(
  record_id = "2",
  address_line_1 = "1 Microsoft Way",
  city = "Redmond",
  state = "WA",
  postal_code = "98052"
))

Response #

When submitting a request, you have the option to either get the response as a string or encapsulate the response into the respective Cloud API response object.

As a String #

Submit a GET or POST request and get the response as a string.

C#
Python

string response = property.GetLookupProperty<string>();

response = property.get_lookup_property(str)

C#
Python

response = property.post_lookup_property(str)

response = property.post_lookup_property(str)

As a Response Object #

Submit a GET or POST request and encapsulate the response into the Cloud API response object.

C#
Python

PropertyResponse responseObject = property.GetLookupProperty<PropertyResponse>();

response = property.get_lookup_property(PropertyResponse)

C#
Python

PropertyResponse responseObject = property.PostLookupProperty<PropertyResponse>();

response = property.post_lookup_property(PropertyResponse)

Accessing Values #

When encapsulating the response into the Cloud API’s respective response object, there are three ways to access values. The response object structure matches the respective Cloud API’s response format.

Click here to learn more about the Property response format.

The record responses are typically stored in a list. In the examples below, record represents an individual record at an arbitrary position within this list.

1. Using the Get Value Method:

Pass the field name as a string to the Get Value Method, and it will return the corresponding field value.

C#
Python

record.GetValue("RecordID");
record.GetValue("Results");

record.get_value("RecordID")
record.get_value("Results")

2. Accessing Properties directly

Values can be accessed directly using the response object’s field names.

C#
Python

record.RecordID;
record.Results;

record.record_id
record.results

3. Use Specialized Methods

Use get methods corresponding to field name to get the field value.

C#
Python

record.GetRecordID();
record.GetResults();

record.get_record_id()
record.get_results()

Methods #

The methods listed below pertain to the Property Cloud API object.

For methods related to the respective Cloud API’s response object click here.

Constructors #

These methods initialize and configure instances of the Cloud API object. Use these methods to create a new object, optionally providing initial values such as a license string to customize the instance during its creation.

C#
Python

Method	Description
`Property()`	Constructor to initialize the Property object.
`Property(string license)`	Constructor to initialize the Property object with a license string.

Method	Description
`Property()`	Constructor to initialize the Property object.
`Property(license)`	Constructor to initialize the Property object with a license string.

Set Methods #

These methods configure or modify parameters at the record level for the Cloud API object. Use these methods to make adjustments to the parameters during the execution of the Cloud API, ensuring flexibility in customizing API requests.

C#
Python

Method	Description
`void SetBaseUrl(string baseUrl)`	Set the base URL.
`void SetLicense(string license)`	Set the license string.
`void SetEndpoint(string endpoint)`	Set the endpoint.
`void SetFormat(string format)`	Set the format.
`void SetAddressKey(string addressKey)`	Set the address key.
`void SetAddressLine1(string addressLine1)`	Set the address line 1.
`void SetAddressLine2(string addressLine2)`	Set the address line 2.
`void SetAPN(string apn)`	Set the APN.
`void SetCity(string city)`	Set the city.
`void SetCountry(string country)`	Set the country.
`void SetFIPS(string fips)`	Set the FIPS.
`void SetFreeForm(string freeForm)`	Set the free form.
`void SetMAK(string mak)`	Set the MAK.
`void SetState(string state)`	Set the state.
`void SetPostal(string postal)`	Set the postal code.
`void SetTransmissionReference(string transmissionReference)`	Set the transmission reference.
`void SetCols(string cols)`	Set the columns.
`void SetOpt(string opt)`	Set the option.
`void SetOwnerMAK(string mak)`	Set the owner MAK.
`void SetTotalRecords(string totalRecords)`	Set the total records.
`void SetPostBody(PropertyBatchRequest postBody)`	Set the batch post body for post requests.
`void SetValue(string parameter, string value)`	Set the input parameter to a specified value.
`void SetPostSingleBody(PropertyRecordRequest postBody)`	Set the post body for post requests.

Method	Description
`set_base_url(base_url)`	Set the base URL.
`set_license(license)`	Set the license string.
`set_endpoint(endpoint)`	Set the endpoint.
`set_format(format)`	Set the format.
`set_address_key(address_key)`	Set the address key.
`set_address_line_1(address_line_1)`	Set the address line 1.
`set_address_line_2(address_line_2)`	Set the address line 2.
`set_apn(apn)`	Set the APN.
`set_city(city)`	Set the city.
`set_country(country)`	Set the country.
`set_fips(fips)`	Set the FIPS.
`set_free_form(free_form)`	Set the free form.
`set_mak(mak)`	Set the MAK.
`set_state(state)`	Set the state.
`set_postal(postal)`	Set the postal code.
`set_transmission_reference(transmission_reference)`	Set the transmission reference.
`set_cols(cols)`	Set the columns.
`set_opt(opt)`	Set the option.
`set_owner_mak(mak)`	Set the owner MAK.
`set_total_records(total_records)`	Set the total records.
`set_post_body(post_body)`	Set the batch post body for post requests.
`set_value(parameter, value)`	Set the input parameter to a specified value.
`set_post_single_body(post_body)`	Set the post body for post requests.

Get Methods #

These methods retrieve parameter values from the Cloud API object. Use these methods to access the parameters configured for the Cloud API at the record level, providing insight into the current state of the object’s settings.

C#
Python

Method	Description
`string GetBaseUrl()`	Get the base URL.
`string GetLicense()`	Get the license string.
`string GetEndpoint()`	Get the endpoint.
`string GetFormat()`	Get the format.
`string GetAddressKey()`	Get the address key.
`string GetAddressLine1()`	Get the address line 1.
`string GetAddressLine2()`	Get the address line 2.
`string GetAPN()`	Get the APN.
`string GetCity()`	Get the city.
`string GetCountry()`	Get the country.
`string GetFIPS()`	Get the FIPS.
`string GetFreeForm()`	Get the free form.
`string GetMAK()`	Get the MAK.
`string GetState()`	Get the state.
`string GetPostal()`	Get the postal code.
`string GetTransmissionReference()`	Get the transmission reference.
`string GetCols()`	Get the columns.
`string GetOpt()`	Get the option.
`string GetOwnerMAK()`	Get the owner MAK.
`string GetTotalRecords()`	Get the total records.
`void GetValue(string parameter)`	Get the value of an input parameter.
`PropertyBatchRequest GetPostBody()`	Get the batch post body for post requests.
`PropertyRecordRequest GetPostSingleBody()`	Get the post body for post requests.

Method	Description
`get_base_url()`	Get the base URL.
`get_license()`	Get the license string.
`get_endpoint()`	Get the endpoint.
`get_format()`	Get the format.
`get_address_key()`	Get the address key.
`get_address_line_1()`	Get the address line 1.
`get_address_line_2()`	Get the address line 2.
`get_apn()`	Get the APN.
`get_city()`	Get the city.
`get_country()`	Get the country.
`get_fips()`	Get the FIPS.
`get_free_form()`	Get the free form.
`get_mak()`	Get the MAK.
`get_state()`	Get the state.
`get_postal()`	Get the postal code.
`get_transmission_reference()`	Get the transmission reference.
`get_cols()`	Get the columns.
`get_opt()`	Get the option.
`get_owner_mak()`	Get the owner MAK.
`get_total_records()`	Get the total records.
`get_value(parameter)`	Get the value of an input parameter.
`get_post_body()`	Get the batch post body for post requests.
`get_post_single_body()`	Get the post body for post requests.

Class Methods #

These methods perform service-level operations, handling the core processing and interactions for the Cloud API object. Use these methods to execute primary functionalities such as assembling records, clearing records, and making API requests.

C#
Python

Method	Description
`void AddRecord(PropertyRecordRequest record)`	Add record to internal list for post body assembly.
`void ClearRecords()`	Clear the internal list of records.
`T GetLookupProperty<T>()`	Endpoint: /v4/WEB/LookupProperty Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`async Task<T> GetLookupPropertyAsync<T>()`	Endpoint: /v4/WEB/LookupProperty Makes the asynchronous GET request to the CloudAPI and returns the response.
`T PostLookupProperty<T>()`	Endpoint: /v4/WEB/LookupProperty Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`async Task<T> PostLookupPropertyAsync<T>()`	Endpoint: /v4/WEB/LookupProperty Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`T GetLookupDeeds<T>()`	Endpoint: /v4/WEB/LookupDeeds Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`async Task<T> GetLookupDeedsAsync<T>()`	Endpoint: /v4/WEB/LookupDeeds Makes the asynchronous GET request to the CloudAPI and returns the response.
`T PostLookupDeeds<T>()`	Endpoint: /v4/WEB/LookupDeeds Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`async Task<T> PostLookupDeedsAsync<T>()`	Endpoint: /v4/WEB/LookupDeeds Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`T GetLookupHomesByOwner<T>()`	Endpoint: /v4/WEB/LookupHomesByOwner Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`async Task<T> GetLookupHomesByOwnerAsync<T>()`	Endpoint: /v4/WEB/LookupHomesByOwner Makes the asynchronous GET request to the CloudAPI and returns the response.
`T PostLookupHomesByOwner<T>()`	Endpoint: /v4/WEB/LookupHomesByOwner Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`async Task<T> PostLookupHomesByOwnerAsync<T>()`	Endpoint: /v4/WEB/LookupHomesByOwner Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`string GetApiVersion()`	Makes synchronous getversion request and returns parsed Cloud API version.
`async Task<string> GetApiVersionAsync()`	Makes asynchronous getversion request and returns parsed Cloud API version.

Method	Description
`add_record(record)`	Add record to internal list for post body assembly.
`clear_records()`	Clear the internal list of records.
`get_lookup_property(response_type)`	Endpoint: /v4/WEB/LookupProperty Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`get_lookup_property_async(response_type)`	Endpoint: /v4/WEB/LookupProperty Makes the asynchronous GET request to the CloudAPI and returns the response.
`post_lookup_property(response_type)`	Endpoint: /v4/WEB/LookupProperty Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`post_lookup_property_async(response_type)`	Endpoint: /v4/WEB/LookupProperty Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`get_lookup_deeds(response_type)`	Endpoint: /v4/WEB/LookupDeeds Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`get_lookup_deeds_async(response_type)`	Endpoint: /v4/WEB/LookupDeeds Makes the asynchronous GET request to the CloudAPI and returns the response.
`post_lookup_deeds(response_type)`	Endpoint: /v4/WEB/LookupDeeds Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`post_lookup_deeds_async(response_type)`	Endpoint: /v4/WEB/LookupDeeds Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`get_lookup_homes_by_owner(response_type)`	Endpoint: /v4/WEB/LookupHomesByOwner Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`get_lookup_homes_by_owner_async(response_type)`	Endpoint: /v4/WEB/LookupHomesByOwner Makes the asynchronous GET request to the CloudAPI and returns the response.
`post_lookup_homes_by_owner(response_type)`	Endpoint: /v4/WEB/LookupHomesByOwner Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`post_lookup_homes_by_owner_async(response_type)`	Endpoint: /v4/WEB/LookupHomesByOwner Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`get_api_version()`	Makes synchronous getversion request and returns parsed Cloud API version.
`get_api_version_async()`	Makes asynchronous getversion request and returns parsed Cloud API version.

Property

Contents

Property#

Introduction #

Licensing #

Initialization #

Configuration #

Requests #

GET #

Method 1: Using Set Value Method #

Method 2: Using Direct Property Access #

Method 3: Using Specialized Methods #

POST #

Method 1: Set Post Body #

Method 2: Set Input Parameters and Add Records #

Response #

As a String #

As a Response Object #

Accessing Values #

Methods #

Constructors #

Set Methods #

Get Methods #

Class Methods #