Reference Guide

Attention

🚧🛠️ Pardon Our Dust! 🛠️🚧

This collection of APIs is currently in BETA release. Changes are still actively being made and some of the documentation may be incomplete. While we work diligently, you might notice a few things out of place. Please excuse the temporary mess as we strive to improve our site.

👇 For now the links below will guide you to the current most up to date documentation. 👇

Introduction

Welcome to Data Retriever .

Base URL

https://dataretriever.melissadata.net

Licensing

The License Key is a software key required to use the Cloud API. You will receive your License Key from your Melissa representative. If you don’t have a License Key, contact the Melissa sales team by Requesting a Demo or by calling 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a License Key this service will not function.

Endpoints

MAK

All MAK endpoints use the following buyable Columns.

• MAK

Column Name	Type	Definition
MelissaAddressKey	bigint	10-digit unique key assigned to each address.
BaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
AddressLine	varchar(50)	Address line
Suite	varchar(20)	Suite
Urbanization	varchar(28)	Urbanization indicator
City	varchar(35)	City
State	char(2)	State
AddressKey	char(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
BaseRecord	bit	Flag to indicate the address is a parent record.
ResultCodes	varchar(50)	Melissa result codes
AddressStreetNumber	varchar(10)	Address street number. Ex. ‘6450’
AddressDirectionPrefix	varchar(5)	Address directional prefix. Ex. ‘e’
AddressStreetName	varchar(40)	Street name. Ex. ‘Side’
AddressStreetSuffix	varchar(10)	Suffix of address. Ex. ‘Dr’
AddressDirectionSuffix	varchar(5)	Address directional suffix. Ex. ‘Ne’
AddressSuiteName	varchar(10)	Suite. Ex. ‘Apt’
AddressSuiteNumber	varchar(10)	Suite number. Ex. ‘Q’
AddressType	char(1)	Address type. Ex. P.O.Box or residential address
RBDI	char(1)	Business/residential indication
CommercialMailReceivingAgency	bit	U.S. Only. The address is a commercial mail receiving agency like a mailbox, etc. These addresses include a private mailbox (PMB or number).
County	varchar(100)	County name
CongressionalDistrict	varchar(3)	Federal congressional district number
CarrierRoute	varchar(4)	The carrier route for the location address as assigned by the USPS.
CityAbbreviation	varchar(13)	Alternative city name
FIPSCode	varchar(5)	The FIPSCode indicates the location of the address at both the state and county level.
Vacant	bit	Indicates whether an address is vacant
NeighborhoodName	varchar(100)	The name of a Neighborhood
ApartmentName	varchar(255)	The name of an apartment complex
NonUSPS	bit	US only. This US address is not serviced by the USPS but does exist and may receive mail through third party carriers.
PlaceCode	varchar(7)	Place identifier represented as State FIPS (2) + PlaceFIPS (5)
Latitude	decimal(18,6)	The latitude in decimal degrees using the WGS84 datum for the address
Longitude	decimal(18,6)	The longitude in decimal degrees using the WGS84 datum for the address
GeoLevel	varchar(1)	Geo level, see code table
CensusKey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
CensusKeyDecennial	varchar(15)	Similar to the Census key, however, this key contains 15 characters and changes every 10 years. Fifteen-digit key that represents: State (2) + County (3) + Tract (6) + Block Group Number (4)
ElevationInMeters	decimal(18,2)	Elevation of the address from sea level in meters
POBoxStyleAddress	bit	PO Box Style Street Address
DropInd	bit	Mail is delivered to a single receptable at a site
Throwback	bit	Mail is not delivered to the street address
DeliveryDaysFlag	bit	Indicates that DeliveryDays contains data
NonDeliveryDaysFlag	bit	Indicates that NonDeliveryDays contains data
NoStatInd	bit	Address that has not yet become deliverable
DoorNotAccessible	bit	USPS cannot knock on a door to deliver mail

/web/V1/MAK/doCount

Introduction

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/MAK/doCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "CustomerID": "{{customerId}}",
    "Includes": {
      "Zips": [
        {"Zip": "92688"}
      ],
      "RBDI": ["B"]
    }
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688"}, {"Zip": "92688", "Plus4": "2122"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
POBoxStyleAddress	The status for POBoxStyleAddress	"POBoxStyleAddress": [null, false]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
DropInd	The status for DropInd	"DropInd": [false, null]
Throwback	The status for Throwback	"Throwback": [false, null]
DeliveryDaysFlag	The status for DeliveryDaysFlag	"DeliveryDaysFlag": [true, null]
NonDeliveryDaysFlag	The status for NonDeliveryDaysFlag	"NonDeliveryDaysFlag": [false, null]
NoStatInd	The status for NoStatInd	"NoStatInd": [true, null]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
DoorNotAccessible	The status for DoorNotAccessible	"DoorNotAccessible": [false, true]
FalseTable	The status for FalseTable	"FalseTable": [false, null]
BaseRecord	The status for BaseRecord	"BaseRecord": [true, null]
ResultCodes	The ResultCodes to include	"ResultCodes": ["AS17"]
NonUSPS	The status for NonUSPS	"NonUSPS": [true, null]
GeoLevel	The status for GeoLevel	"GeoLevel": ["B", "5"]
CommercialMailReceivingAgency	The status for CommercialMailReceivingAgency	"CommercialMailReceivingAgency": [true, null]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688"}, {"Zip": "92688", "Plus4": "2122"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
POBoxStyleAddress	The status for POBoxStyleAddress	"POBoxStyleAddress": [null, false]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
DropInd	The status for DropInd	"DropInd": [false, null]
Throwback	The status for Throwback	"Throwback": [false, null]
DeliveryDaysFlag	The status for DeliveryDaysFlag	"DeliveryDaysFlag": [true, null]
NonDeliveryDaysFlag	The status for NonDeliveryDaysFlag	"NonDeliveryDaysFlag": [false, null]
NoStatInd	The status for NoStatInd	"NoStatInd": [true, null]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
DoorNotAccessible	The status for DoorNotAccessible	"DoorNotAccessible": [false, true]
FalseTable	The status for FalseTable	"FalseTable": [false, null]
BaseRecord	The status for BaseRecord	"BaseRecord": [true, null]
ResultCodes	The ResultCodes to include	"ResultCodes": ["AS17"]
NonUSPS	The status for NonUSPS	"NonUSPS": [true, null]
GeoLevel	The status for GeoLevel	"GeoLevel": ["B", "5"]
CommercialMailReceivingAgency	The status for CommercialMailReceivingAgency	"CommercialMailReceivingAgency": [true, null]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 930,
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/MAK/doLookup

Introduction

This endpoint returns a paginated result view of the request. This can sometimes take awhile and should be used after DoCount has been used to filter down your dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/MAK/doLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
     "CustomerID": "{{customerId}}",
     "Includes": {
       "Zips": [
         { "Zip": "92688" }
       ],
       "RBDI": ["B"]
     },
     "Columns": [
       "MelissaAddressKey",
       "AddressLine",
       "Suite"
     ],
     "Pagination": {
       "Page": 1
     },
     "OrderBy": [
       { "column": "MelissaAddressKey", "sortorder": "desc" }
     ]
 }'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All MAK Columns you want returned.
Pagination	Specify the desired page in the results to access. Pages are based on 100 records per page.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688"}, {"Zip": "92688", "Plus4": "2122"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
POBoxStyleAddress	The status for POBoxStyleAddress	"POBoxStyleAddress": [null, false]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
DropInd	The status for DropInd	"DropInd": [false, null]
Throwback	The status for Throwback	"Throwback": [false, null]
DeliveryDaysFlag	The status for DeliveryDaysFlag	"DeliveryDaysFlag": [true, null]
NonDeliveryDaysFlag	The status for NonDeliveryDaysFlag	"NonDeliveryDaysFlag": [false, null]
NoStatInd	The status for NoStatInd	"NoStatInd": [true, null]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
DoorNotAccessible	The status for DoorNotAccessible	"DoorNotAccessible": [false, true]
FalseTable	The status for FalseTable	"FalseTable": [false, null]
BaseRecord	The status for BaseRecord	"BaseRecord": [true, null]
ResultCodes	The ResultCodes to include	"ResultCodes": ["AS17"]
NonUSPS	The status for NonUSPS	"NonUSPS": [true, null]
GeoLevel	The status for GeoLevel	"GeoLevel": ["B", "5"]
CommercialMailReceivingAgency	The status for CommercialMailReceivingAgency	"CommercialMailReceivingAgency": [true, null]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688"}, {"Zip": "92688", "Plus4": "2122"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
POBoxStyleAddress	The status for POBoxStyleAddress	"POBoxStyleAddress": [null, false]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
DropInd	The status for DropInd	"DropInd": [false, null]
Throwback	The status for Throwback	"Throwback": [false, null]
DeliveryDaysFlag	The status for DeliveryDaysFlag	"DeliveryDaysFlag": [true, null]
NonDeliveryDaysFlag	The status for NonDeliveryDaysFlag	"NonDeliveryDaysFlag": [false, null]
NoStatInd	The status for NoStatInd	"NoStatInd": [true, null]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
DoorNotAccessible	The status for DoorNotAccessible	"DoorNotAccessible": [false, true]
FalseTable	The status for FalseTable	"FalseTable": [false, null]
BaseRecord	The status for BaseRecord	"BaseRecord": [true, null]
ResultCodes	The ResultCodes to include	"ResultCodes": ["AS17"]
NonUSPS	The status for NonUSPS	"NonUSPS": [true, null]
GeoLevel	The status for GeoLevel	"GeoLevel": ["B", "5"]
CommercialMailReceivingAgency	The status for CommercialMailReceivingAgency	"CommercialMailReceivingAgency": [true, null]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access.	"Page": 1

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 930,
  "Results": [
    {
      "MelissaAddressKey": 1007119866,
      "AddressLine": "29911 Aventura",
      "Suite": ""
    },
    {
      "MelissaAddressKey": 1008571286,
      "AddressLine": "22362 Gilberto",
      "Suite": "Ste 121"
    },
    {
      "MelissaAddressKey": 2009306238,
      "AddressLine": "22342 Avenida Empresa",
      "Suite": "Ste 220"
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "NextPage": 2,
    "TotalPages": 9
  },
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
Results	Returned records with requested Columns.
Pagination	Paginated information. CurrentPage The current page number. NextPage The next page number. TotalPages The total number of pages available.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/MAK/getCount

Introduction

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/MAK/getCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
   "CustomerID": "{{customerId}}",
   "Includes": {
     "Zips": [
       {"Zip": "92688"}
     ],
     "RBDI": ["B"]
   },
   "Columns": [
     "MelissaAddressKey",
     "AddressLine",
     "Suite"
   ],
   "OrderBy": [
     { "column": "MelissaAddressKey", "sortorder": "desc" }
   ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All MAK Columns you want returned.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688"}, {"Zip": "92688", "Plus4": "2122"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
POBoxStyleAddress	The status for POBoxStyleAddress	"POBoxStyleAddress": [null, false]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
DropInd	The status for DropInd	"DropInd": [false, null]
Throwback	The status for Throwback	"Throwback": [false, null]
DeliveryDaysFlag	The status for DeliveryDaysFlag	"DeliveryDaysFlag": [true, null]
NonDeliveryDaysFlag	The status for NonDeliveryDaysFlag	"NonDeliveryDaysFlag": [false, null]
NoStatInd	The status for NoStatInd	"NoStatInd": [true, null]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
DoorNotAccessible	The status for DoorNotAccessible	"DoorNotAccessible": [false, true]
FalseTable	The status for FalseTable	"FalseTable": [false, null]
BaseRecord	The status for BaseRecord	"BaseRecord": [true, null]
ResultCodes	The ResultCodes to include	"ResultCodes": ["AS17"]
NonUSPS	The status for NonUSPS	"NonUSPS": [true, null]
GeoLevel	The status for GeoLevel	"GeoLevel": ["B", "5"]
CommercialMailReceivingAgency	The status for CommercialMailReceivingAgency	"CommercialMailReceivingAgency": [true, null]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688"}, {"Zip": "92688", "Plus4": "2122"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
POBoxStyleAddress	The status for POBoxStyleAddress	"POBoxStyleAddress": [null, false]
ZipIncludedIn3553	The status for ZipIncludedIn3553	"ZipIncludedIn3553": [true, null]
DropInd	The status for DropInd	"DropInd": [false, null]
Throwback	The status for Throwback	"Throwback": [false, null]
DeliveryDaysFlag	The status for DeliveryDaysFlag	"DeliveryDaysFlag": [true, null]
NonDeliveryDaysFlag	The status for NonDeliveryDaysFlag	"NonDeliveryDaysFlag": [false, null]
NoStatInd	The status for NoStatInd	"NoStatInd": [true, null]
NoSecureLocation	The status for NoSecureLocation	"NoSecureLocation": [false, true]
DoorNotAccessible	The status for DoorNotAccessible	"DoorNotAccessible": [false, true]
FalseTable	The status for FalseTable	"FalseTable": [false, null]
BaseRecord	The status for BaseRecord	"BaseRecord": [true, null]
ResultCodes	The ResultCodes to include	"ResultCodes": ["AS17"]
NonUSPS	The status for NonUSPS	"NonUSPS": [true, null]
GeoLevel	The status for GeoLevel	"GeoLevel": ["B", "5"]
CommercialMailReceivingAgency	The status for CommercialMailReceivingAgency	"CommercialMailReceivingAgency": [true, null]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "JobId": "returned_job_id",
  "Count": 930,
  "ResultCode": "LS01",
  "Sample": [
    {
      "MelissaAddressKey": 1008571286,
      "AddressLine": "22362 Gilberto",
      "Suite": "Ste 121"
    },
    {
      "MelissaAddressKey": 1010898855,
      "AddressLine": "23111 Antonio Pkwy",
      "Suite": ""
    },
    {
      "MelissaAddressKey": 1123819713,
      "AddressLine": "23181 Antonio Pkwy",
      "Suite": ""
    }
  ]
}

Response Fields

Output Name	Description
JobId	The JobId to be used to purchase and access the full dataset.
Count	Number of records returned by the query.
ResultCode	Success or Error codes based on the response/request.
Sample	A 10 record sample response.

NewMovers

All NewMovers Endpoints use the following buyable Columns. For more information on each column, please refer to New Movers Data Layout.

• NewMovers

Column Name	Type	Definition
MelissaAddressKey	bigint	10-Digit Unique key Assigned to Each Address.
BaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
FullName	varchar(60)	Full Name
FirstName	varchar(50)	First Name
MiddleName	varchar(15)	Middle Name
LastName	varchar(50)	Last Name
AddressLine	varchar(50)	Address Line
City	varchar(28)	City
State	varchar(2)	State
ZIPCode	varchar(5)	ZIP Code
Plus4	varchar(4)	Plus4
AddressKey	varchar(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
ResultCodes	varchar(100)	Melissa Result Codes
Latitude	decimal(18,6)	The Latitude in Decimal Degrees Using the Wgs84 Datum for the Address.
Longitude	decimal(18,6)	The Longitudein Decimal Degrees Using the Wgs84 Datum for the Address.
CensusKey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
PreviousMelissaAddressKey	bigint	10-Digit Unique key Assigned to Each Address
PreviousBaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is apart or within a building. Ex. Apartment
PreviousAddressLine	varchar(50)	Previous Address Line
PreviousSuite	varchar(50)	Previous Suite
PreviousCity	varchar(50)	Previous City
PreviousState	varchar(2)	Previous State
PreviousZIPCode	varchar(5)	Previous Zip Code
PreviousPlus4	varchar(4)	Previous Plus4
PreviousAddressKey	varchar(11)	Previous Addresskey
PreviousResultCodes	varchar(100)	Previous Melissa Result Codes
PreviousLatitude	decimal(18,6)	Previous Latitude
PreviousLongitude	decimal(18,6)	Previous Longitude
PhoneNumber	varchar(10)	Phone Number
MoveEffectiveDate	date	Effective Move Date
EstimatedHouseholdIncomeCode	varchar(2)	Estimated House Income
AgeOfHouseholdCode	int	Age Range of Household
EstimatedHousingValueCode	varchar(2)	Code for Estimated House Value
HomeownershipCode	int	The Probability of Home Ownership.
PresenceOfChildrenCode	int	The Probability of Children Being Present in the Home.
DwellingCodeSpecific	int	Dwelling Type of a Location. Refer to code definition for more insight.
MoveDistanceCode	MoveDistanceCode	The distance movers have moved from original locations.

/web/V1/NewMovers/doCount

Introduction

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/NewMovers/doCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "CustomerID": "{{customerId}}",
    "Includes": {
      "Zips": [
        {"Zip": "92688"}
      ],
      "MoveEffectiveDate": {
        "StartDate": "2023/01/01",
        "EndDate": "2024/01/01"
      }
    }
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.

• POST JSON (Includes)

Code	Description	JSON
CensusKey (Required)	A list of Census Keys.	"CensusKey": ["060590885013012"]
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey":["1022522181","3699370981"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey":["0","8782059379"]
FullName	A list of Full Names.	"FullName":["Ray Melissa"]
FirstName	A list of First Names.	"FirstName":["Ray"]
MiddleName	A list of Middle Names.	"MiddleName":["J"]
LastName	A list of Last Names.	"LastName":["Melissa"]
RBDI	An RBDI code.	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
State	A list of States.	"State": ["CA"]
Plus4	A list of Plus4s.	"Plus4": ["2115", "2115"]
AddressKey	A list of Address Keys.	"AddressKey":["79927262700"]
ResultCodes	A list of Result Codes.	"ResultCodes":["AS01,GS05,PS01,PS08,PS10"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
PreviousMelissaAddressKey	A list of Previous Melissa Address Keys.	"PreviousMelissaAddressKey":["7642903570"]
PreviousBaseMelissaAddressKey	A list of Previous Base Melissa Address Keys.	"PreviousBaseMelissaAddressKey":["1730591205"]
PreviousAddressLine	A list of Previous Address Lines.	"PreviousAddressLine": ["22382 Avenida Empresa"]
PreviousSuite	A list of Previous Suites.	"PreviousSuite": ["Apt 233"]
PreviousCities	A list of Previous Cities.	"PreviousCities": ["Rancho Santa Margarita"]
PreviousCountyName	A list of Previous County Names.	"PreviousCountyName": ["San Diego", "Orange", "Los Angeles"]
PreviousState	A list of Previous States.	"PreviousState": ["CA", "NV", "RI"]
PreviousZIPCode	A list of Previous ZIP Codes.	"PreviousZIPCode": ["92688"]
PreviousAddressKey	A list of Previous Address Keys.	"PreviousAddressKey": ["01801454649"]
PreviousPlus4	A list of Previous Plus4s.	"PreviousPlus4": ["2115"]
PreviousResultCodes	A list of Previous Result Codes.	"PreviousResultCodes": ["AS01"]
PreviousLatitude	A list of Previous Latitudes.	"PreviousLatitude": ["33.640495"]
PreviousLongitude	A list of Previous Longitudes.	"PreviousLongitude": ["-117.603915"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772", "9498586226"]
MoveEffectiveDate	A date range with start and end dates.	"MoveEffectiveDate": { "StartDate": "2023/01/01", "EndDate": "2024/01/01" }
EstimatedHouseholdIncomeCode	A list of Estimated Household Income Codes.	"EstimatedHouseholdIncomeCode":["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21","22","23","24","25","26"]
AgeOfHouseholdCode	A list of Age Of Household Codes.	"AgeOfHouseholdCode": [0, 1, 2, 3]
EstimatedHousingValueCode	A list of Estimated Housing Value Codes.	"EstimatedHousingValueCode": ["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21"]
HomeownershipCode	A list of Homeownership Codes.	"HomeownershipCode": [0, 1, 2, 3]
PresenceOfChildrenCode	A list of Presence Of Children Codes.	"PresenceOfChildrenCode": [0, 1, 2, 3]
DwellingCodeNormal	A list of Dwelling Code Normals.	"DwellingCodeNormal": ["AX"]
DwellingCodeSpecific	A list of Dwelling Specific Codes.	"DwellingCodeSpecific": [0, 1, 2, 3]
MoveDistanceCode	A list of Move Distance Codes.	"MoveDistanceCode": [0, 1, 2, 3]
ConstructionTypeCode	A list of Construction Type Codes.	"ConstructionTypeCode": ["B"]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": [ true, null ]

• POST JSON (Excludes)

Code	Description	JSON
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey":["1022522181","3699370981"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey":["0","8782059379"]
FullName	A list of Full Names.	"FullName":["Ray Melissa"]
FirstName	A list of First Names.	"FirstName":["Ray"]
MiddleName	A list of Middle Names.	"MiddleName":["J"]
LastName	A list of Last Names.	"LastName":["Melissa"]
RBDI	An RBDI code.	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
State	A list of States.	"State": ["CA"]
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122"} ]
Plus4	A list of Plus4s.	"Plus4": ["2115", "2115"]
AddressKey	A list of Address Keys.	"AddressKey":["79927262700"]
ResultCodes	A list of Result npCodes.	"ResultCodes":["AS01,GS05,PS01,PS08,PS10"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
PreviousMelissaAddressKey	A list of Previous Melissa Address Keys.	"PreviousMelissaAddressKey":["7642903570"]
PreviousBaseMelissaAddressKey	A list of Previous Base Melissa Address Keys.	"PreviousBaseMelissaAddressKey":["1730591205"]
PreviousAddressLine	A list of Previous Address Lines.	"PreviousAddressLine": ["22382 Avenida Empresa"]
PreviousSuite	A list of Previous Suites.	"PreviousSuite": ["Apt 233"]
PreviousCities	A list of Previous Cities.	"PreviousCities": ["Rancho Santa Margarita"]
PreviousCountyName	A list of Previous County Names.	"PreviousCountyName": ["San Diego", "Orange", "Los Angeles"]
PreviousState	A list of Previous States.	"PreviousState": ["CA", "NV", "RI"]
PreviousZIPCode	A list of Previous ZIP Codes.	"PreviousZIPCode": ["92688"]
PreviousAddressKey	A list of Previous Address Keys.	"PreviousAddressKey": ["01801454649"]
PreviousPlus4	A list of Previous Plus4s.	"PreviousPlus4": ["2115"]
PreviousResultCodes	A list of Previous Result Codes.	"PreviousResultCodes": ["AS01"]
PreviousLatitude	A list of Previous Latitudes.	"PreviousLatitude": ["33.640495"]
PreviousLongitude	A list of Previous Longitudes.	"PreviousLongitude": ["-117.603915"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772", "9498586226"]
MoveEffectiveDate	A date range with start and end dates.	"MoveEffectiveDate": { "StartDate": "2023/01/01", "EndDate": "2024/01/01" }
EstimatedHouseholdIncomeCode	A list of Estimated Household Income Codes.	"EstimatedHouseholdIncomeCode":["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21","22","23","24","25","26"]
AgeOfHouseholdCode	A list of Age Of Household Codes.	"AgeOfHouseholdCode": [0, 1, 2, 3]
EstimatedHousingValueCode	A list of Estimated Housing Value Codes.	"EstimatedHousingValueCode": ["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21"]
HomeownershipCode	A list of Homeownership Codes.	"HomeownershipCode": [0, 1, 2, 3]
PresenceOfChildrenCode	A list of Presence Of Children Codes.	"PresenceOfChildrenCode": [0, 1, 2, 3]
DwellingCodeNormal	A list of Dwelling Code Normals.	"DwellingCodeNormal": ["AX"]
DwellingCodeSpecific	A list of Dwelling Specific Codes.	"DwellingCodeSpecific": [0, 1, 2, 3]
MoveDistanceCode	A list of Move Distance Codes.	"MoveDistanceCode": [0, 1, 2, 3]
ConstructionTypeCode	A list of Construction Type Codes.	"ConstructionTypeCode": ["B"]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": [ true, null ]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 370,
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/NewMovers/doLookup

Introduction

This endpoint returns a paginated result view of the request. This can sometimes take awhile and should be used after DoCount has been used to filter down your dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/NewMovers/doLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "CustomerID": "{{customerId}}",
    "Includes": {
      "Zips": [
        {"Zip": "92688"}
      ],
      "MoveEffectiveDate": {
        "StartDate": "2023/01/01",
        "EndDate": "2024/01/01"
      }
    },
    "Columns": [
      "MelissaAddressKey",
      "AddressLine",
      "PreviousAddressLine"
    ],
    "Pagination": {
      "Page": 1
    },
    "OrderBy": [
      { "column": "MelissaAddressKey", "sortorder": "desc" }
    ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All NewMovers Columns you want returned.
Pagination	Specify the desired page in the results to access. Pages are based on 100 records per page.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
CensusKey (Required)	A list of Census Keys.	"CensusKey": ["060590885013012"]
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey":["1022522181","3699370981"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey":["0","8782059379"]
FullName	A list of Full Names.	"FullName":["Ray Melissa"]
FirstName	A list of First Names.	"FirstName":["Ray"]
MiddleName	A list of Middle Names.	"MiddleName":["J"]
LastName	A list of Last Names.	"LastName":["Melissa"]
RBDI	An RBDI code.	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
State	A list of States.	"State": ["CA"]
Plus4	A list of Plus4s.	"Plus4": ["2115", "2115"]
AddressKey	A list of Address Keys.	"AddressKey":["79927262700"]
ResultCodes	A list of Result Codes.	"ResultCodes":["AS01,GS05,PS01,PS08,PS10"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
PreviousMelissaAddressKey	A list of Previous Melissa Address Keys.	"PreviousMelissaAddressKey":["7642903570"]
PreviousBaseMelissaAddressKey	A list of Previous Base Melissa Address Keys.	"PreviousBaseMelissaAddressKey":["1730591205"]
PreviousAddressLine	A list of Previous Address Lines.	"PreviousAddressLine": ["22382 Avenida Empresa"]
PreviousSuite	A list of Previous Suites.	"PreviousSuite": ["Apt 233"]
PreviousCities	A list of Previous Cities.	"PreviousCities": ["Rancho Santa Margarita"]
PreviousCountyName	A list of Previous County Names.	"PreviousCountyName": ["San Diego", "Orange", "Los Angeles"]
PreviousState	A list of Previous States.	"PreviousState": ["CA", "NV", "RI"]
PreviousZIPCode	A list of Previous ZIP Codes.	"PreviousZIPCode": ["92688"]
PreviousAddressKey	A list of Previous Address Keys.	"PreviousAddressKey": ["01801454649"]
PreviousPlus4	A list of Previous Plus4s.	"PreviousPlus4": ["2115"]
PreviousResultCodes	A list of Previous Result Codes.	"PreviousResultCodes": ["AS01"]
PreviousLatitude	A list of Previous Latitudes.	"PreviousLatitude": ["33.640495"]
PreviousLongitude	A list of Previous Longitudes.	"PreviousLongitude": ["-117.603915"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772", "9498586226"]
MoveEffectiveDate	A date range with start and end dates.	"MoveEffectiveDate": { "StartDate": "2023/01/01", "EndDate": "2024/01/01" }
EstimatedHouseholdIncomeCode	A list of Estimated Household Income Codes.	"EstimatedHouseholdIncomeCode":["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21","22","23","24","25","26"]
AgeOfHouseholdCode	A list of Age Of Household Codes.	"AgeOfHouseholdCode": [0, 1, 2, 3]
EstimatedHousingValueCode	A list of Estimated Housing Value Codes.	"EstimatedHousingValueCode": ["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21"]
HomeownershipCode	A list of Homeownership Codes.	"HomeownershipCode": [0, 1, 2, 3]
PresenceOfChildrenCode	A list of Presence Of Children Codes.	"PresenceOfChildrenCode": [0, 1, 2, 3]
DwellingCodeNormal	A list of Dwelling Code Normals.	"DwellingCodeNormal": ["AX"]
DwellingCodeSpecific	A list of Dwelling Specific Codes.	"DwellingCodeSpecific": [0, 1, 2, 3]
MoveDistanceCode	A list of Move Distance Codes.	"MoveDistanceCode": [0, 1, 2, 3]
ConstructionTypeCode	A list of Construction Type Codes.	"ConstructionTypeCode": ["B"]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": [ true, null ]

• POST JSON (Excludes)

Code	Description	JSON
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey":["1022522181","3699370981"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey":["0","8782059379"]
FullName	A list of Full Names.	"FullName":["Ray Melissa"]
FirstName	A list of First Names.	"FirstName":["Ray"]
MiddleName	A list of Middle Names.	"MiddleName":["J"]
LastName	A list of Last Names.	"LastName":["Melissa"]
RBDI	An RBDI code.	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
State	A list of States.	"State": ["CA"]
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122"} ]
Plus4	A list of Plus4s.	"Plus4": ["2115", "2115"]
AddressKey	A list of Address Keys.	"AddressKey":["79927262700"]
ResultCodes	A list of Result npCodes.	"ResultCodes":["AS01,GS05,PS01,PS08,PS10"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
PreviousMelissaAddressKey	A list of Previous Melissa Address Keys.	"PreviousMelissaAddressKey":["7642903570"]
PreviousBaseMelissaAddressKey	A list of Previous Base Melissa Address Keys.	"PreviousBaseMelissaAddressKey":["1730591205"]
PreviousAddressLine	A list of Previous Address Lines.	"PreviousAddressLine": ["22382 Avenida Empresa"]
PreviousSuite	A list of Previous Suites.	"PreviousSuite": ["Apt 233"]
PreviousCities	A list of Previous Cities.	"PreviousCities": ["Rancho Santa Margarita"]
PreviousCountyName	A list of Previous County Names.	"PreviousCountyName": ["San Diego", "Orange", "Los Angeles"]
PreviousState	A list of Previous States.	"PreviousState": ["CA", "NV", "RI"]
PreviousZIPCode	A list of Previous ZIP Codes.	"PreviousZIPCode": ["92688"]
PreviousAddressKey	A list of Previous Address Keys.	"PreviousAddressKey": ["01801454649"]
PreviousPlus4	A list of Previous Plus4s.	"PreviousPlus4": ["2115"]
PreviousResultCodes	A list of Previous Result Codes.	"PreviousResultCodes": ["AS01"]
PreviousLatitude	A list of Previous Latitudes.	"PreviousLatitude": ["33.640495"]
PreviousLongitude	A list of Previous Longitudes.	"PreviousLongitude": ["-117.603915"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772", "9498586226"]
MoveEffectiveDate	A date range with start and end dates.	"MoveEffectiveDate": { "StartDate": "2023/01/01", "EndDate": "2024/01/01" }
EstimatedHouseholdIncomeCode	A list of Estimated Household Income Codes.	"EstimatedHouseholdIncomeCode":["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21","22","23","24","25","26"]
AgeOfHouseholdCode	A list of Age Of Household Codes.	"AgeOfHouseholdCode": [0, 1, 2, 3]
EstimatedHousingValueCode	A list of Estimated Housing Value Codes.	"EstimatedHousingValueCode": ["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21"]
HomeownershipCode	A list of Homeownership Codes.	"HomeownershipCode": [0, 1, 2, 3]
PresenceOfChildrenCode	A list of Presence Of Children Codes.	"PresenceOfChildrenCode": [0, 1, 2, 3]
DwellingCodeNormal	A list of Dwelling Code Normals.	"DwellingCodeNormal": ["AX"]
DwellingCodeSpecific	A list of Dwelling Specific Codes.	"DwellingCodeSpecific": [0, 1, 2, 3]
MoveDistanceCode	A list of Move Distance Codes.	"MoveDistanceCode": [0, 1, 2, 3]
ConstructionTypeCode	A list of Construction Type Codes.	"ConstructionTypeCode": ["B"]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": [ true, null ]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access.	"Page": 1

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 370,
  "Results": [
    {
        "MelissaAddressKey": 1005797685,
        "AddressLine": "35 Pinzon",
        "PreviousAddressLine": ""
    },
    {
        "MelissaAddressKey": 1005797685,
        "AddressLine": "35 Pinzon",
        "PreviousAddressLine": "17136 E Roadrunner Rd"
    },
    {
        "MelissaAddressKey": 3513560832,
        "AddressLine": "117 Montana Del Lago Dr",
        "PreviousAddressLine": "2490 Electric Ave"
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "NextPage": 2,
    "TotalPages": 3
  },
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
Results	The returned records with requested columns. 100 records per page.
Pagination	Paginated information. CurrentPage The current page number. NextPage The next page number. TotalPages The total number of pages available.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/NewMovers/getCount

Introduction

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/NewMovers/getCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688"}
        ],
        "MoveEffectiveDate": {
          "StartDate": "2023-01-01",
          "EndDate": "2023-12-31"
        }
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "PreviousAddressLine"
      ],
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All NewMovers Columns you want returned.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
CensusKey (Required)	A list of Census Keys.	"CensusKey": ["060590885013012"]
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey":["1022522181","3699370981"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey":["0","8782059379"]
FullName	A list of Full Names.	"FullName":["Ray Melissa"]
FirstName	A list of First Names.	"FirstName":["Ray"]
MiddleName	A list of Middle Names.	"MiddleName":["J"]
LastName	A list of Last Names.	"LastName":["Melissa"]
RBDI	An RBDI code.	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
State	A list of States.	"State": ["CA"]
Plus4	A list of Plus4s.	"Plus4": ["2115", "2115"]
AddressKey	A list of Address Keys.	"AddressKey":["79927262700"]
ResultCodes	A list of Result Codes.	"ResultCodes":["AS01,GS05,PS01,PS08,PS10"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
PreviousMelissaAddressKey	A list of Previous Melissa Address Keys.	"PreviousMelissaAddressKey":["7642903570"]
PreviousBaseMelissaAddressKey	A list of Previous Base Melissa Address Keys.	"PreviousBaseMelissaAddressKey":["1730591205"]
PreviousAddressLine	A list of Previous Address Lines.	"PreviousAddressLine": ["22382 Avenida Empresa"]
PreviousSuite	A list of Previous Suites.	"PreviousSuite": ["Apt 233"]
PreviousCities	A list of Previous Cities.	"PreviousCities": ["Rancho Santa Margarita"]
PreviousCountyName	A list of Previous County Names.	"PreviousCountyName": ["San Diego", "Orange", "Los Angeles"]
PreviousState	A list of Previous States.	"PreviousState": ["CA", "NV", "RI"]
PreviousZIPCode	A list of Previous ZIP Codes.	"PreviousZIPCode": ["92688"]
PreviousAddressKey	A list of Previous Address Keys.	"PreviousAddressKey": ["01801454649"]
PreviousPlus4	A list of Previous Plus4s.	"PreviousPlus4": ["2115"]
PreviousResultCodes	A list of Previous Result Codes.	"PreviousResultCodes": ["AS01"]
PreviousLatitude	A list of Previous Latitudes.	"PreviousLatitude": ["33.640495"]
PreviousLongitude	A list of Previous Longitudes.	"PreviousLongitude": ["-117.603915"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772", "9498586226"]
MoveEffectiveDate	A date range with start and end dates.	"MoveEffectiveDate": { "StartDate": "2023/01/01", "EndDate": "2024/01/01" }
EstimatedHouseholdIncomeCode	A list of Estimated Household Income Codes.	"EstimatedHouseholdIncomeCode":["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21","22","23","24","25","26"]
AgeOfHouseholdCode	A list of Age Of Household Codes.	"AgeOfHouseholdCode": [0, 1, 2, 3]
EstimatedHousingValueCode	A list of Estimated Housing Value Codes.	"EstimatedHousingValueCode": ["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21"]
HomeownershipCode	A list of Homeownership Codes.	"HomeownershipCode": [0, 1, 2, 3]
PresenceOfChildrenCode	A list of Presence Of Children Codes.	"PresenceOfChildrenCode": [0, 1, 2, 3]
DwellingCodeNormal	A list of Dwelling Code Normals.	"DwellingCodeNormal": ["AX"]
DwellingCodeSpecific	A list of Dwelling Specific Codes.	"DwellingCodeSpecific": [0, 1, 2, 3]
MoveDistanceCode	A list of Move Distance Codes.	"MoveDistanceCode": [0, 1, 2, 3]
ConstructionTypeCode	A list of Construction Type Codes.	"ConstructionTypeCode": ["B"]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": [ true, null ]

• POST JSON (Excludes)

Code	Description	JSON
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey":["1022522181","3699370981"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey":["0","8782059379"]
FullName	A list of Full Names.	"FullName":["Ray Melissa"]
FirstName	A list of First Names.	"FirstName":["Ray"]
MiddleName	A list of Middle Names.	"MiddleName":["J"]
LastName	A list of Last Names.	"LastName":["Melissa"]
RBDI	An RBDI code.	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
State	A list of States.	"State": ["CA"]
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122"} ]
Plus4	A list of Plus4s.	"Plus4": ["2115", "2115"]
AddressKey	A list of Address Keys.	"AddressKey":["79927262700"]
ResultCodes	A list of Result npCodes.	"ResultCodes":["AS01,GS05,PS01,PS08,PS10"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
PreviousMelissaAddressKey	A list of Previous Melissa Address Keys.	"PreviousMelissaAddressKey":["7642903570"]
PreviousBaseMelissaAddressKey	A list of Previous Base Melissa Address Keys.	"PreviousBaseMelissaAddressKey":["1730591205"]
PreviousAddressLine	A list of Previous Address Lines.	"PreviousAddressLine": ["22382 Avenida Empresa"]
PreviousSuite	A list of Previous Suites.	"PreviousSuite": ["Apt 233"]
PreviousCities	A list of Previous Cities.	"PreviousCities": ["Rancho Santa Margarita"]
PreviousCountyName	A list of Previous County Names.	"PreviousCountyName": ["San Diego", "Orange", "Los Angeles"]
PreviousState	A list of Previous States.	"PreviousState": ["CA", "NV", "RI"]
PreviousZIPCode	A list of Previous ZIP Codes.	"PreviousZIPCode": ["92688"]
PreviousAddressKey	A list of Previous Address Keys.	"PreviousAddressKey": ["01801454649"]
PreviousPlus4	A list of Previous Plus4s.	"PreviousPlus4": ["2115"]
PreviousResultCodes	A list of Previous Result Codes.	"PreviousResultCodes": ["AS01"]
PreviousLatitude	A list of Previous Latitudes.	"PreviousLatitude": ["33.640495"]
PreviousLongitude	A list of Previous Longitudes.	"PreviousLongitude": ["-117.603915"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772", "9498586226"]
MoveEffectiveDate	A date range with start and end dates.	"MoveEffectiveDate": { "StartDate": "2023/01/01", "EndDate": "2024/01/01" }
EstimatedHouseholdIncomeCode	A list of Estimated Household Income Codes.	"EstimatedHouseholdIncomeCode":["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21","22","23","24","25","26"]
AgeOfHouseholdCode	A list of Age Of Household Codes.	"AgeOfHouseholdCode": [0, 1, 2, 3]
EstimatedHousingValueCode	A list of Estimated Housing Value Codes.	"EstimatedHousingValueCode": ["00","01","02","03","04","05", "06","07","08","09","10","11","12","13","14","15","16","17", "18","19","20","21"]
HomeownershipCode	A list of Homeownership Codes.	"HomeownershipCode": [0, 1, 2, 3]
PresenceOfChildrenCode	A list of Presence Of Children Codes.	"PresenceOfChildrenCode": [0, 1, 2, 3]
DwellingCodeNormal	A list of Dwelling Code Normals.	"DwellingCodeNormal": ["AX"]
DwellingCodeSpecific	A list of Dwelling Specific Codes.	"DwellingCodeSpecific": [0, 1, 2, 3]
MoveDistanceCode	A list of Move Distance Codes.	"MoveDistanceCode": [0, 1, 2, 3]
ConstructionTypeCode	A list of Construction Type Codes.	"ConstructionTypeCode": ["B"]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": [ true, null ]

Headers

• POST JSON

 Content-Type: application/json
 Accept: application/json

Response

• POST JSON

{
  "JobId": "returned_job_id",
  "Count": 370,
  "ResultCode": "LS01",
  "Sample": [
    {
      "MelissaAddressKey": 1005797685,
      "AddressLine": "35 Pinzon",
      "PreviousAddressLine": "17136 E Roadrunner Rd"
    },
    {
      "MelissaAddressKey": 1122076153,
      "AddressLine": "11 Castano",
      "PreviousAddressLine": ""
    }
  ]
}

Response Fields

Output Name	Description
JobId	The JobId to be used to purchase and access the full dataset.
Count	Number of records returned by the query.
ResultCode	Success or Error codes based on the response/request.
Sample	A 10 record sample response.

NewHomeowners

All NewHomeowners endpoints have the following buyable Columns. For more information on each column, please refer to New Homeowners Data Layout.

• NewHomeowners

Column Name	Type	Definition
MelissaAddressKey	bigint	10-digit unique key assigned to each address.
BaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
FirstName	varchar(64)	First Name
LastName	varchar(64)	Last Name
AddressLine	varchar(64)	Address Line
City	varchar(64)	City
State	varchar(2)	State
ZIPCode	varchar(5)	ZIP Code
Plus4	varchar(4)	Plus4
DeliveryPoint	varchar(2)	A specific location where mail is delivered to an individual or entity. It is a precise point of delivery for a particular address.
AddressKey	varchar(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
CarrierRoute	varchar(4)	The carrier route for the location address assigned by the USPS.
FIPSCode	varchar(5)	The FIPSCode indicates the location of the address at both the state and county level.
PlaceCode	varchar(7)	Place identifier represented as State FIPS (2) + PlaceFIPS (5)
Latitude	decimal(18,6)	The latitude in decimal degrees using the WGS84 datum for the address.
Longitude	decimal(18,6)	The longitude in decimal degrees using the WGS84 datum for the address.
CensusKey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
PhoneNumber	varchar(12)	Phone number
PurchasePrice	int	The purchase price of the property.
SellDate	date	The closing date, the ownership of the property is transferred to the buyer.
Lender	varchar(90)	A lender is an individual, a public or private group, or a financial institution that makes funds available to another with the expectation that the funds will be repaid.
TransactionType	varchar(5)	Transaction type code
PublishedDate	date	Record published date
CondoCode	varchar(2)	Indicates if a property is a condo.
MortgageAmount	int	A regularly scheduled payment which includes principal and interest paid by borrower to lender of home loan.
RateType	varchar(5)	Whether a fixed-rate or an adjustable-rate mortgage loan.
LoanType	varchar(50)	Indicates whether the loan granted, applied for, or purchased was conventional, government-guaranteed, or government-insured.

/web/V1/NewHomeowners/doCount

Introduction

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/NewHomeowners/doCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688"}
        ],
        "SellDate": {
          "StartDate": "2024-01-01",
          "EndDate": "2024-12-01"
        }
      }
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All NewHomeowners Columns you want returned.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"}}}} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey": ["8787744694", "5398639232"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey": ["0"]
FirstName	A list of First Names.	"FirstName": ["JOHN"]
LastName	A list of Last Names.	"LastName": ["DOE"]
RBDI	An RBDI code.	"RBDI": ["B"]
Address	A list of Addresses.	"AddressLine": ["22382 Avenida Empresa"]
Street	A list of Streets.	"Street": ["Main St"]
State	A list of States.	"State": ["CA"]
Plus4	A list of Plus4s.	"Plus4": ["2115"]
DeliveryPoint	A list of Delivery Points.	"DeliveryPoint": ["19"]
AddressKey	A list of Address Keys.	"AddressKey": ["99507411719","99501483908"]
CarrierRoute	A list of Carrier Routes.	"CarrierRoute": ["C010"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
CountyName	A list of County Names.	"CountyName": ["Orange"]
PlaceCode	A list of Place Codes.	"PlaceCode": ["0660594"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772"]
PurchasePrice	A Range of Purchase Prices	"PurchasePrice": ["500","600"]
SellDate	A list of Sell Dates.	"SellDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
Lender	A list of Lenders.	"Lender": ["Melissa Bank", "Rancho Test Credit Union"]
TransactionType	A list of Transaction Types.	"TransactionType": [ 0,1,109,21,3,43,7,9]
PublishedDate	A date range with start and end dates.	"PublishedDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
CondoCode	A list of Condo Codes.	"CondoCode": ["C"]
MortgageAmount	A list of Mortgage Amounts.	"MortgageAmount": ["500","600"]
RateType	A list of Rate Types.	"RateType": ["ADJ","FIX","MULT","OTH","STP","UNK","VAR","NULL"," "]
LoanType	A list of Loan Types.	"LoanType": ["NULL","2nd Mtg covering 1st","420","ARM","Assumption", "Balloon","Building","Building or Construction","C", "Closed End Mortgage","CNV","Commercial","Conventional","FHA", "HME","Land - Agreement Sale","Line of Credit","Negative Amortization", "PP","Regional Government Programs","Reverse Mortgage","SBA", "Seller Take Back","Stand Alone 1st","Stand Alone 2nd", "Stand Alone Refi","USDA - US Department of Agriculture Loan","VA", "Veterans Administration Loan"]

• POST JSON (Excludes)

Code	Description	JSON
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey": ["8787744694", "5398639232"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey": ["0"]
FirstName	A list of First Names.	"FirstName": ["JOHN"]
LastName	A list of Last Names.	"LastName": ["DOE"]
RBDI	An RBDI code.	"RBDI": ["B"]
Address	A list of Addresses.	"AddressLine": ["22382 Avenida Empresa"]
Street	A list of Streets.	"Street": ["Main St"]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
State	A list of States.	"State": ["CA"]
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"}}}} ]
Plus4	A list of Plus4s.	"Plus4": ["2115"]
DeliveryPoint	A list of Delivery Points.	"DeliveryPoint": ["19"]
AddressKey	A list of Address Keys.	"AddressKey": ["99507411719","99501483908"]
CarrierRoute	A list of Carrier Routes.	"CarrierRoute": ["C010"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
CountyName	A list of County Names.	"CountyName": ["Orange"]
PlaceCode	A list of Place Codes.	"PlaceCode": ["0660594"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772"]
PurchasePrice	A Range of Purchase Prices	"PurchasePrice": ["500","600"]
SellDate	A list of Sell Dates.	"SellDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
Lender	A list of Lenders.	"Lender": ["Melissa Bank", "Rancho Test Credit Union"]
TransactionType	A list of Transaction Types.	"TransactionType": [ 0,1,109,21,3,43,7,9]
PublishedDate	A date range with start and end dates.	"PublishedDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
CondoCode	A list of Condo Codes.	"CondoCode": ["C"]
MortgageAmount	A list of Mortgage Amounts.	"MortgageAmount": ["500","600"]
RateType	A list of Rate Types.	"RateType": ["ADJ","FIX","MULT","OTH","STP","UNK","VAR","NULL"," "]
LoanType	A list of Loan Types.	"LoanType": ["NULL","2nd Mtg covering 1st","420","ARM","Assumption", "Balloon","Building","Building or Construction","C", "Closed End Mortgage","CNV","Commercial","Conventional","FHA", "HME","Land - Agreement Sale","Line of Credit","Negative Amortization", "PP","Regional Government Programs","Reverse Mortgage","SBA", "Seller Take Back","Stand Alone 1st","Stand Alone 2nd", "Stand Alone Refi","USDA - US Department of Agriculture Loan","VA", "Veterans Administration Loan"]

Headers

• POST JSON

 Content-Type: application/json
 Accept: application/json

Response

• POST JSON

{
  "Count": 406,
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/NewHomeowners/doLookup

Introduction

This endpoint returns a paginated result view of the request. This can sometimes take awhile and should be used after DoCount has been used to filter down your dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/NewHomeowners/doLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688"}
        ],
        "SellDate": {
          "StartDate": "2024-01-01",
          "EndDate": "2024-12-01"
        }
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "PurchasePrice",
        "SellDate"
      ],
      "Pagination": {
        "Page": 1
      },
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All NewHomeowners Columns you want returned.
Pagination	Specify the desired page in the results to access. Pages are based on 100 records per page.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"}}}} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey": ["8787744694", "5398639232"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey": ["0"]
FirstName	A list of First Names.	"FirstName": ["JOHN"]
LastName	A list of Last Names.	"LastName": ["DOE"]
RBDI	An RBDI code.	"RBDI": ["B"]
Address	A list of Addresses.	"AddressLine": ["22382 Avenida Empresa"]
Street	A list of Streets.	"Street": ["Main St"]
State	A list of States.	"State": ["CA"]
Plus4	A list of Plus4s.	"Plus4": ["2115"]
DeliveryPoint	A list of Delivery Points.	"DeliveryPoint": ["19"]
AddressKey	A list of Address Keys.	"AddressKey": ["99507411719","99501483908"]
CarrierRoute	A list of Carrier Routes.	"CarrierRoute": ["C010"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
CountyName	A list of County Names.	"CountyName": ["Orange"]
PlaceCode	A list of Place Codes.	"PlaceCode": ["0660594"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772"]
PurchasePrice	A Range of Purchase Prices	"PurchasePrice": ["500","600"]
SellDate	A list of Sell Dates.	"SellDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
Lender	A list of Lenders.	"Lender": ["Melissa Bank", "Rancho Test Credit Union"]
TransactionType	A list of Transaction Types.	"TransactionType": [ 0,1,109,21,3,43,7,9]
PublishedDate	A date range with start and end dates.	"PublishedDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
CondoCode	A list of Condo Codes.	"CondoCode": ["C"]
MortgageAmount	A list of Mortgage Amounts.	"MortgageAmount": ["500","600"]
RateType	A list of Rate Types.	"RateType": ["ADJ","FIX","MULT","OTH","STP","UNK","VAR","NULL"," "]
LoanType	A list of Loan Types.	"LoanType": ["NULL","2nd Mtg covering 1st","420","ARM","Assumption", "Balloon","Building","Building or Construction","C", "Closed End Mortgage","CNV","Commercial","Conventional","FHA", "HME","Land - Agreement Sale","Line of Credit","Negative Amortization", "PP","Regional Government Programs","Reverse Mortgage","SBA", "Seller Take Back","Stand Alone 1st","Stand Alone 2nd", "Stand Alone Refi","USDA - US Department of Agriculture Loan","VA", "Veterans Administration Loan"]

• POST JSON (Excludes)

Code	Description	JSON
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey": ["8787744694", "5398639232"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey": ["0"]
FirstName	A list of First Names.	"FirstName": ["JOHN"]
LastName	A list of Last Names.	"LastName": ["DOE"]
RBDI	An RBDI code.	"RBDI": ["B"]
Address	A list of Addresses.	"AddressLine": ["22382 Avenida Empresa"]
Street	A list of Streets.	"Street": ["Main St"]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
State	A list of States.	"State": ["CA"]
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"}}}} ]
Plus4	A list of Plus4s.	"Plus4": ["2115"]
DeliveryPoint	A list of Delivery Points.	"DeliveryPoint": ["19"]
AddressKey	A list of Address Keys.	"AddressKey": ["99507411719","99501483908"]
CarrierRoute	A list of Carrier Routes.	"CarrierRoute": ["C010"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
CountyName	A list of County Names.	"CountyName": ["Orange"]
PlaceCode	A list of Place Codes.	"PlaceCode": ["0660594"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772"]
PurchasePrice	A Range of Purchase Prices	"PurchasePrice": ["500","600"]
SellDate	A list of Sell Dates.	"SellDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
Lender	A list of Lenders.	"Lender": ["Melissa Bank", "Rancho Test Credit Union"]
TransactionType	A list of Transaction Types.	"TransactionType": [ 0,1,109,21,3,43,7,9]
PublishedDate	A date range with start and end dates.	"PublishedDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
CondoCode	A list of Condo Codes.	"CondoCode": ["C"]
MortgageAmount	A list of Mortgage Amounts.	"MortgageAmount": ["500","600"]
RateType	A list of Rate Types.	"RateType": ["ADJ","FIX","MULT","OTH","STP","UNK","VAR","NULL"," "]
LoanType	A list of Loan Types.	"LoanType": ["NULL","2nd Mtg covering 1st","420","ARM","Assumption", "Balloon","Building","Building or Construction","C", "Closed End Mortgage","CNV","Commercial","Conventional","FHA", "HME","Land - Agreement Sale","Line of Credit","Negative Amortization", "PP","Regional Government Programs","Reverse Mortgage","SBA", "Seller Take Back","Stand Alone 1st","Stand Alone 2nd", "Stand Alone Refi","USDA - US Department of Agriculture Loan","VA", "Veterans Administration Loan"]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access.	"Page": 1

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 406,
  "Results": [
    {
        "MelissaAddressKey": null,
        "AddressLine": "10 Daffodil # 34",
        "PurchasePrice": 850,
        "SellDate": "2023-08-08T00:00:00"
    },
    {
        "MelissaAddressKey": null,
        "AddressLine": "10 Daffodil # 34",
        "PurchasePrice": 850,
        "SellDate": "2023-08-08T00:00:00"
    },
    {
        "MelissaAddressKey": 2701812381,
        "AddressLine": "6 Codoniz",
        "PurchasePrice": 761,
        "SellDate": "2023-09-26T00:00:00"
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "NextPage": 2,
    "TotalPages": 4
  },
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of total records returned by the query.
Results	The returned records with requested columns. 100 records per page.
Pagination	Paginated information. CurrentPage The current page number. NextPage The next page number. TotalPages The total number of pages available.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/NewHomeowners/getCount

Introduction

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/NewHomeowners/getCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688"}
        ],
        "SellDate": {
          "StartDate": "2024-01-01",
          "EndDate": "2024-12-01"
        }
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "PurchasePrice",
        "SellDate"
      ],
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All NewHomeowners Columns you want returned.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"}}}} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey": ["8787744694", "5398639232"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey": ["0"]
FirstName	A list of First Names.	"FirstName": ["JOHN"]
LastName	A list of Last Names.	"LastName": ["DOE"]
RBDI	An RBDI code.	"RBDI": ["B"]
Address	A list of Addresses.	"AddressLine": ["22382 Avenida Empresa"]
Street	A list of Streets.	"Street": ["Main St"]
State	A list of States.	"State": ["CA"]
Plus4	A list of Plus4s.	"Plus4": ["2115"]
DeliveryPoint	A list of Delivery Points.	"DeliveryPoint": ["19"]
AddressKey	A list of Address Keys.	"AddressKey": ["99507411719","99501483908"]
CarrierRoute	A list of Carrier Routes.	"CarrierRoute": ["C010"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
CountyName	A list of County Names.	"CountyName": ["Orange"]
PlaceCode	A list of Place Codes.	"PlaceCode": ["0660594"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772"]
PurchasePrice	A Range of Purchase Prices	"PurchasePrice": ["500","600"]
SellDate	A list of Sell Dates.	"SellDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
Lender	A list of Lenders.	"Lender": ["Melissa Bank", "Rancho Test Credit Union"]
TransactionType	A list of Transaction Types.	"TransactionType": [ 0,1,109,21,3,43,7,9]
PublishedDate	A date range with start and end dates.	"PublishedDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
CondoCode	A list of Condo Codes.	"CondoCode": ["C"]
MortgageAmount	A list of Mortgage Amounts.	"MortgageAmount": ["500","600"]
RateType	A list of Rate Types.	"RateType": ["ADJ","FIX","MULT","OTH","STP","UNK","VAR","NULL"," "]
LoanType	A list of Loan Types.	"LoanType": ["NULL","2nd Mtg covering 1st","420","ARM","Assumption", "Balloon","Building","Building or Construction","C", "Closed End Mortgage","CNV","Commercial","Conventional","FHA", "HME","Land - Agreement Sale","Line of Credit","Negative Amortization", "PP","Regional Government Programs","Reverse Mortgage","SBA", "Seller Take Back","Stand Alone 1st","Stand Alone 2nd", "Stand Alone Refi","USDA - US Department of Agriculture Loan","VA", "Veterans Administration Loan"]

• POST JSON (Excludes)

Code	Description	JSON
MelissaAddressKey	A list of Melissa Address Keys.	"MelissaAddressKey": ["8787744694", "5398639232"]
BaseMelissaAddressKey	A list of Base Melissa Address Keys.	"BaseMelissaAddressKey": ["0"]
FirstName	A list of First Names.	"FirstName": ["JOHN"]
LastName	A list of Last Names.	"LastName": ["DOE"]
RBDI	An RBDI code.	"RBDI": ["B"]
Address	A list of Addresses.	"AddressLine": ["22382 Avenida Empresa"]
Street	A list of Streets.	"Street": ["Main St"]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
State	A list of States.	"State": ["CA"]
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"}}}} ]
Plus4	A list of Plus4s.	"Plus4": ["2115"]
DeliveryPoint	A list of Delivery Points.	"DeliveryPoint": ["19"]
AddressKey	A list of Address Keys.	"AddressKey": ["99507411719","99501483908"]
CarrierRoute	A list of Carrier Routes.	"CarrierRoute": ["C010"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
CountyName	A list of County Names.	"CountyName": ["Orange"]
PlaceCode	A list of Place Codes.	"PlaceCode": ["0660594"]
Latitude	A list of Latitudes.	"Latitude": ["33.640495"]
Longitude	A list of Longitudes.	"Longitude": ["-117.603915"]
CensusKey	A list of Census Keys.	"CensusKey": ["060590885013012"]
PhoneNumber	A list of Phone Numbers.	"PhoneNumber": ["8006354772"]
PurchasePrice	A Range of Purchase Prices	"PurchasePrice": ["500","600"]
SellDate	A list of Sell Dates.	"SellDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
Lender	A list of Lenders.	"Lender": ["Melissa Bank", "Rancho Test Credit Union"]
TransactionType	A list of Transaction Types.	"TransactionType": [ 0,1,109,21,3,43,7,9]
PublishedDate	A date range with start and end dates.	"PublishedDate": { "StartDate": "2024-01-01", "EndDate": "2024-12-01" }
CondoCode	A list of Condo Codes.	"CondoCode": ["C"]
MortgageAmount	A list of Mortgage Amounts.	"MortgageAmount": ["500","600"]
RateType	A list of Rate Types.	"RateType": ["ADJ","FIX","MULT","OTH","STP","UNK","VAR","NULL"," "]
LoanType	A list of Loan Types.	"LoanType": ["NULL","2nd Mtg covering 1st","420","ARM","Assumption", "Balloon","Building","Building or Construction","C", "Closed End Mortgage","CNV","Commercial","Conventional","FHA", "HME","Land - Agreement Sale","Line of Credit","Negative Amortization", "PP","Regional Government Programs","Reverse Mortgage","SBA", "Seller Take Back","Stand Alone 1st","Stand Alone 2nd", "Stand Alone Refi","USDA - US Department of Agriculture Loan","VA", "Veterans Administration Loan"]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "JobId": "returned_job_id",
  "Count": 406,
  "ResultCode": "LS01",
  "Sample": [
    {
      "MelissaAddressKey": null,
      "AddressLine": "10 Daffodil # 34",
      "PurchasePrice": 850,
      "SellDate": "2023-08-08T00:00:00"
    },
    {
      "MelissaAddressKey": null,
      "AddressLine": "17 Buckthorn # 168",
      "PurchasePrice": 580,
      "SellDate": "2023-08-10T00:00:00"
    }
  ]
}

Response Fields

Output Name	Description
JobId	The JobId to be used to purchase and access the full dataset.
Count	Number of records returned by the query.
ResultCode	Success or Error codes based on the response/request.
Sample	A 10 record sample response.

Consumer

All Consumer endpoints have the following buyable Columns. For more information on each column, please refer to Consumer Data Layout.

• Consumer

Column Name	Type	Definition
MelissaAddressKey	bigint	10-digit unique key assigned to each address.
BaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
TitlePrefixInd	varchar(1)	Title prefix Ex. “Mr.”
FirstName	varchar(30)	First name
MiddleNameInitial	varchar(1)	Middle name initial
LastName	varchar(30)	Last name
FullName	varchar(61)	Full Name
NameSuffix	varchar(20)	Name suffix EX. “Jr.”, “III”
AddressLine	varchar(75)	Address line
Suite	varchar(20)	Suite
City	varchar(35)	City
State	varchar(2)	State
ZIPCode	varchar(5)	ZIP Code
Plus4	varchar(4)	ZIP Code plus 4
DeliveryPoint	varchar(2)	A specific location where mail is delivered to an individual or entity. It is a precise point of delivery for a particular address.
AddressKey	varchar(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
ResultCodes	varchar(100)	Melissa result codes
AddressStreetNumber	varchar(10)	Address street number. Ex. ‘6450’
AddressDirectionPrefix	varchar(5)	Address directional prefix. Ex. ‘e’
AddressStreetName	varchar(50)	Street name. Ex. ‘Side’
AddressStreetSuffix	varchar(10)	Suffix of address. Ex. ‘Dr’
AddressDirectionSuffix	varchar(5)	Address directional suffix. Ex. ‘Ne’
AddressSuiteName	varchar(10)	Suite. Ex. ‘Apt’
AddressSuiteNumber	varchar(10)	Address suite number. Ex. ‘Q’
AddressTypeInd	varchar(1)	Address type indicator
AddressType	char(1)	Address type. Ex. P.O.Box or residential address
RBDI	char(1)	Business/residential indication
WalkSequencenumber	varchar(4)	Walk sequence. It is used by mail carriers to mark the mailing sequence of their deliveries.
CarrierRoute	varchar(4)	The carrier route for the location address assigned by the USPS.
FIPSCode	varchar(5)	The FIPSCode indicates the location of the address at both the state and county level.
FIPSMCDCode	varchar(5)	A unique identifier for each Minor Civil Division (MCD) or other county subdivisions in the U.S. MCDs are legal entities that are subdivisions of county or county equivalents other than incorporated places and are established by appropriate state or local governmental authorities and recognized by the Census Bureau as a primary county division.
PlaceCode	varchar(7)	Place identifier represented as State FIPS (2) + PlaceFIPS (5)
Latitude	decimal(18,6)	The latitude in decimal degrees using the WGS84 datum for the address.
Longitude	decimal(18,6)	The longitude in decimal degrees using the WGS84 datum for the address.
CensusKey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
CBSACode	varchar(5)	Core based statistical areas (CBSAs) may be either metropolitan statistical areas or micropolitan statistical areas.
OccupationCode1	varchar(1)	Indicates the occupation of the 1st individual in the household.
GenderCode	varchar(1)	Gender
ContactAgeGroup	varchar(2)	Contact age group
BirthYear1	varchar(4)	Indicates the year of the date of birth from the 1st individual in the household.
BirthMonth1	varchar(2)	Indicates the month of the date of birth from the 1st individual in the household.
BirthDay1	varchar(2)	Indicates the day of the date of birth from the 1st individual in the household.
Gender1	varchar(1)	Indicates the gender of the 1st ranked person in the household. The ranking is based on a series of InfoBase ranking rules.
PoliticalPartyCode1	varchar(1)	Indicates the political party of the 1st individual for voting purposes.
EducationCode1	varchar(1)	Indicates the highest known education of the 1st ranked person in the household. The ranking is based on a series of InfoBase ranking rules.
PhoneNumber	varchar(10)	Phone number
PhonePresenceInd	varchar(1)	Phone presence indicator
Email	varchar(450)	Email
EmailResultLevel	int	EmailResultLevel
eMailAppendAvailableInd	varchar(1)	Email append available indicator
AgeLessthan1Ind	varchar(1)	Indicates the presence of children less than age 1 in the household.
Age1Ind	varchar(1)	Indicates the presence of children age 1 in the household.
Age2Ind	varchar(1)	Indicates the presence of children age 2 in the household.
Age3Ind	varchar(1)	Indicates the presence of children age 3 in the household.
Age4Ind	varchar(1)	Indicates the presence of children age 4 in the household.
Age5Ind	varchar(1)	Indicates the presence of children age 5 in the household.
Age6Ind	varchar(1)	Indicates the presence of children age 6 in the household.
Age7Ind	varchar(1)	Indicates the presence of children age 7 in the household.
Age8Ind	varchar(1)	Indicates the presence of children age 8 in the household.
Age9Ind	varchar(1)	Indicates the presence of children age 9 in the household.
Age10Ind	varchar(1)	Indicates the presence of children age 10 in the household.
Age11Ind	varchar(1)	Indicates the presence of children age 11 in the household.
Age12Ind	varchar(1)	Indicates the presence of children age 12 in the household.
Age13Ind	varchar(1)	Indicates the presence of children age 13 in the household.
Age14Ind	varchar(1)	Indicates the presence of children age 14 in the household.
Age15Ind	varchar(1)	Indicates the presence of children age 15 in the household.
Age16Ind	varchar(1)	Indicates the presence of children age 16 in the household.
Age17Ind	varchar(1)	Indicates the presence of children age 17 in the household.
Age18Ind	varchar(1)	Indicates the presence of children age 18 in the household.
SupportsChildrensInd	varchar(1)	Indicates that the household financially supports children’s causes.
NumberOfChildrenCode	varchar(1)	Indicates the known number of children in the household.
PresenceOfChildrenInd	varchar(1)	Indicates the presence of children in the household.
NumberOfAdultsCode	varchar(1)	Indicates the known number of adults (18+) living in the household.
HouseholdSizeCode	varchar(1)	Indicates the known number of known people in the household, both adults and children. Household size is a sum of number of adults and number of children, with the exception of a small percentage of household size (0.04%) that will not sum to number of adults + number of children.
EstimatedHomeMarketValueCode	varchar(1)	Indicates the estimated market value of the home, in ranges. This home market value element is built with multiple sources of household level source data (91%) and with multiple sources of geographical data (9%).
HomeOwnerRenterCode	varchar(1)	Indicates whether a household is owner or renter occupied.
IncomeEstimatedHousehold	varchar(1)	Indicates the estimated household income in higher ranges
HouseholdAgeCode	varchar(1)	Internal data will replace when data is found and explained
Age0to2MaleInd	varchar(1)	Indicates the presence of male children age 0 to 2 in the household.
Age0to2FemaleInd	varchar(1)	Indicates the presence of female children age 0 to 2 in the household.
Age0to2UnknownGenderInd	varchar(1)	Indicates the presence of children of unknown gender(s) age 0 to 2 in the household.
Age3to5MaleInd	varchar(1)	Indicates the presence of male children age 3 to 5 in the household.
Age3to5FemaleInd	varchar(1)	Indicates the presence of female children age 3 to 5 in the household.
Age3to5UnknownGenderInd	varchar(1)	Indicates the presence of children of unknown gender(s) age 3 to 5 in the household.
Age6to10MaleInd	varchar(1)	Indicates the presence of male children age 6 to 10 in the household.
Age6to10FemaleInd	varchar(1)	Indicates the presence of female children age 6 to 10 in the household.
Age6to10UnknownGenderInd	varchar(1)	Indicates the presence of children of unknown gender(s) age 6 to 10 in the household.
Age11to15MaleInd	varchar(1)	Indicates the presence of male children age 11 to 15 in the household.
Age11to15FemaleInd	varchar(1)	Indicates the presence of female children age 11 to 15 in the household.
Age11to15UnknownGenderInd	varchar(1)	Indicates the presence of children of unknown gender(s) age 11 to 15 in the household.
Age16to17MaleInd	varchar(1)	Indicates the presence of male children age 16 to 17 in the household.
Age16to17FemaleInd	varchar(1)	Indicates the presence of female children age 16 to 17 in the household.
Age16to17UnknownGenderInd	varchar(1)	Indicates the presence of children of unknown gender(s) age 16 to 17 in the household.
Age18to24MaleInd	varchar(1)	Indicates the presence of males aged 18 to 24 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age18to24FeMaleInd	varchar(1)	Indicates the presence of females aged 18 to 24 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age18to24UnknownGenderInd	varchar(1)	Indicates the presence of people with an unknown gender aged 18 to 24 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age25to34MaleInd	varchar(1)	Indicates the presence of males aged 25 to 34 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age25to34FeMaleInd	varchar(1)	Indicates the presence of females aged 25 to 34 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age25to34UnknownGenderInd	varchar(1)	Indicates the presence of people of unknown gender aged 25 to 34 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age35to44MaleInd	varchar(1)	Indicates the presence of males aged 35 to 44 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age35to44FeMaleInd	varchar(1)	Indicates the presence of females aged 35 to 44 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age35to44UnknownGenderInd	varchar(1)	Indicates the presence of people of unknown gender aged 35 to 44 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age45to54MaleInd	varchar(1)	Indicates the presence of males aged 45 to 54 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age45to54FeMaleInd	varchar(1)	Indicates the presence of females aged 45 to 54 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age45to54UnknownGenderInd	varchar(1)	Indicates the presence of people of unknown gender aged 45 to 54 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age55to64MaleInd	varchar(1)	Indicates the presence of males aged 55 to 64 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age55to64FeMaleInd	varchar(1)	Indicates the presence of females aged 55 to 64 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age55to64UnknownGenderInd	varchar(1)	Indicates the presence of people of unknown gender aged 55 to 64 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age65to74MaleInd	varchar(1)	Indicates the presence of males aged 65 to 74 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age65to74FeMaleInd	varchar(1)	Indicates the presence of females aged 65 to 74 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age65to74UnknownGenderInd	varchar(1)	Indicates the presence of people of unknown gender aged 65 to 74 in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age75MaleInd	varchar(1)	Indicates the presence of males aged 75 plus in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age75FeMaleInd	varchar(1)	Indicates the presence of females aged 75 plus in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
Age75UnknownGenderInd	varchar(1)	Indicates the presence of people of unknown gender aged 75 plus in the household. See also 7600 adult age ranges 100%, which uses models and ZIP Code 9 and ZIP Code data to extend the coverage up to 100%.
YoungAdultinHouseholdInd	varchar(1)	Indicates that there is a young adult in the household where another adult is identified as the 1st individual. (Young adult is ages 18 to 25.)
GenerationsInHouseholdCount	varchar(1)	Indicates the number of family generations in a household.
SeniorAdultInHouseholdInd	varchar(1)	If in the household there is a person over age 55 and a person over age 25, and there is at least 18 years difference between them, then turn on ‘senior in household’.
HomeLengthofResidenceCode	varchar(2)	Indicates the years a household has lived at their address. The length of residence can apply to renters as well as homeowners.
CensusMedianHomeValue	varchar(5)	The median home value of specified owner-occupied housing units (in hundreds of us dollars).
CensusMedianHouseholdIncome	varchar(5)	Census median household income
DwellingTypeCode	varchar(1)	Indicates if more than one family lives at a particular address.
AdvantageDwellingTypeInd	varchar(1)	Internal Data Will replace when data is found and explained
HomeYearBuiltCode	varchar(1)	Indicates the year the home was built in ranges.
HomePropertyTypeCode	Indicates the year the home was built in ranges.	Indicates the type of property.
HomePurchaseDate	varchar(6)	Indicates both the year and month of purchase where available.
NewToBuildIndicator	varchar(1)	New to build indicator
HomeLotSquareFootageRangesCode	varchar(1)	Indicates the size of the home lot in ranged square footage.
HomePurchaseAmountRangesCode	varchar(1)	Indicates the purchase amount of the home in ranges.
HomePropertyTypeDetailCode	varchar(1)	Indicates the specific kind of home.
HomeLTVEstimatedRangesCode	varchar(1)	Loan-to-value (LTV) ratio expresses the amount of total loans (current and historical) as a percentage of home market value.
HomeLTVEstimatedActualCode	varchar(3)	Loan-to-value (LTV) ratio expresses the amount of total loans (current and historical) as a percentage of home market value.
MailOrderDonorInd	varchar(1)	The Household has made a donation via mail in the last 24 months.
LotCarrierlineOfTravelCode	varchar(5)	Lot carrier line of travel code
FileDate	varchar(6)	File date
CompanyId	varchar(5)	ID of company
IndividualId	varchar(5)	Id of an Individual
ConfidenceUseCode	varchar(1)	Confidence use code
SupportsCharitableInd	varchar(1)	Indicates that the household financially supports charitable causes.
SupportsAnimalWelfareInd	varchar(1)	Indicates that the household financially supports animal welfare causes.
SupportsArtsOrCulturalInd	varchar(1)	Indicates that the household financially supports arts or cultural causes.
SupportsEnvironmentOrWildlifeInd	varchar(1)	Indicates that the household financially supports environment or wildlife causes.
SupportsHealthInd	varchar	Indicates that the household financially supports health-related causes.
SupportsInternationalAidInd	varchar(1)	Indicates that the household financially supports international aid-related causes.
SupportsPoliticalInd	varchar(1)	Indicates that the household financially supports political causes.
SupportsPoliticalConservativeInd	varchar(1)	Indicates that the household financially supports conservative political causes.
SupportsPoliticalLiberalInd	varchar(1)	Indicates that the household financially supports liberal political causes.
SupportsReligiousInd	varchar(1)	Indicates that the household financially supports religious causes.
SupportsVeteransInd	varchar(1)	Indicates that the household financially supports veteran-related causes.
BusinessOwnerCode	varchar(1)	Indicates the type of business owned by someone in the household.
SingleParentInd	varchar(1)	Indicates that a single parent exists in the household.
OccupationDetailInputIndividualCode	varchar(4)	Indicates the detailed occupation of the input individual’s name appearing on the customer’s file. The values are the aggregate of the “overall”. Data inconsistency may be seen between this element and the other occupation elements due to differing sources.
InferredHouseholdRankCode	varchar(1)	Indicates the inferred household rank of the individual.
GreenLivingInd	varchar(1)	Green Living represents households that are living environmentally friendly.
AgeinTwoYearIncrInputIndReseller	varchar(2)	Indicates the age of the person ranked 1st in the household, based on a series of InfoBase ranking rules.
SmallOfficeHouseholdInd	varchar(1)	Indicates there is a small office located in the household.
TruckOwnerInd	varchar(1)	Someone in the household has indicated that they own a truck. This does not include SUVs.
InvestmentPropertiesOwnedEstimated	varchar(3)	Indicates the estimated number of housing investment properties owned by the Household.
WorkingWomanInd	varchar(1)	Indicates that a working woman is present in the household. There is a female in household with an occupation status not equal to Homemaker or retired. The absence of a positive indicator in this field does NOT indicate there is not a working woman in the household, only that the information was not available.
BankCardHolderInd	varchar(1)	Indicates possession of VISA or Mastercard bankcard(s) in a household.
GasDepartmentRetailCardHolderInd	varchar(1)	Indicates possession of gas, department store, or retail store credit card(s) in a household. A department store card is like JCPenney, Sears, or Montgomery Ward. A retail card is like Home Depot, Victoria Secret, or Best Buy.
TravelAndEntCardHolderInd	varchar(1)	Indicates possession of travel and entertainment credit card(s) in a household. Travel and entertainment cards are generally used to pay for hotel, airline, and other business related expenses.
CreditCardHolderUnknownTypeInd	varchar(1)	Indicates possession of credit card(s) of unknown type in a household.
PremiumCardHolderInd	varchar(1)	Indicates possession of premium credit card(s) in a household. Premium credit cards would be Gold or Platinum level.
UpscaleDeptStoreCardHolderInd	varchar(1)	Indicates possession of upscale department store credit card(s) in a household. Upscale department store credit cards would be high-end stores like Nordstrom or Neiman Marcus.
OccupationInputIndividualCode	varchar(1)	Indicates the occupation of the input individual’s name appearing on the customer’s file.
OverallMatchInd	varchar(1)	Overall match indicator
OwnerRenterCode	varchar(1)	Indicates whether a household is owner or renter occupied.
CatOwnerInd	varchar(1)	Someone in the household has an interest in owning a cat or actually owns a cat.
DogOwnerInd	varchar(1)	Someone in the household has an interest in owning a dog or actually owns a dog.
OtherPetOnwerInd	varchar(1)	Someone in the household has an interest in owning a pet other than a dog or cat, or they actually own an other pet. (i.e. hamster, rabbit, bird, fish, etc.)
MaritalStatus	varchar(1)	Indicates whether anyone in the household is married.
MailOrderResponderInd	varchar(1)	Household has responded to a piece of collateral via mail in the last 24 months.
SupportsOtherInd	varchar(1)	Indicates that the household financially supports other community causes.
CongressionalDistrictCode	varchar(2)	Identifies the 435 geographic areas within the United States served by a member of the U.S. House of Representatives. CDs are typically built from Census blocks. Use with State FIPS code for unique identifier.
MotorcycleOwnerInd	varchar(1)	Someone in the household has indicated that they own a motorcycle.
RecreationalVehicleInd	varchar(1)	Someone in the household has indicated that they own a recreational vehicle (RV).
PoliticalPartyInputIndividualCode	varchar(1)	Indicates the political party associated with the person for voting purposes.
BaseRecordVerificationDate	varchar(5)	Indicates when the last name was most recently verified at that address. (Year and quarter)
VehicleNewCarBuyer	varchar(1)	Indicates a history of new car buying in the household. This data cannot personally identify an individual’s vehicle.
VehicleKnownOwnedNumber	varchar(1)	Indicates the total number of vehicles owned in the household.
CreditCardUserInd	varchar(1)	Indicates households that have indicated credit card ownership.
EducationInputIndividualCount	varchar(1)	Indicates the highest known education of the person.
PrecisionLevelCode	varchar(1)	Indicates the precision of the data appended: Household, Household Inferred, ZIP Code +4 or ZIP Code
WirelessProductBuyerInd	varchar(1)	Indicates if anyone in the household purchases wireless products.
FashionInd	varchar(1)	Someone in the household has an interest in fashion. They are interested in the latest styles and trends of the fashion world.
HistoyMilitaryInd	varchar(1)	Someone in the household has an interest in history / military.
CelebritiesInd	varchar(1)	Someone in the household has an interest in Celebrities and their lives.
CurrentAffairsPoliticsInd	varchar(1)	Someone in the household has an interest in current affairs / politics.
TheaterPerformingArtsInd	varchar(1)	Someone in the household has an interest in the theater / performing arts.
CommunityCharitiesInd	varchar(1)	Someone in the household has an interest in their community and/or charitable organizations.
ReligiousInspirationalInd	varchar(1)	Someone in the household has an interest in religion / inspirational.
ScienceSpaceInd	varchar(1)	Someone in the household has an interest in science / space.
CareerImprovementInd	varchar(1)	Someone in the household has an interest in Career Improvement.
ArtsInd	varchar(1)	Someone in the household has an interest in fine arts, such as painting, sculpting, filming, architecture, literature, or textiles.
ReadingGeneralInd	varchar(1)	Someone in the household has a general interest in reading.
ReadingBestSellersInd	varchar(1)	Someone in the household has an interest in reading best sellers.
ReadingReligiousInspirationalInd	varchar(1)	Someone in the household has an interest in reading religious / inspirational items.
ReadingScienceFictionInd	varchar(1)	Someone in the household has an interest in reading science fiction.
ReadingMagazinesInd	varchar(1)	Someone in the household has an interest in reading magazines.
ReadingAudioBooksInd	varchar(1)	Someone in the household has an interest in listening to audio books.
CookingGeneralInd	varchar(1)	Someone in the household has a general interest in cooking.
CookingGourmetInd	varchar(1)	Someone in the household has an interest in gourmet cooking.
CookingLowFatInd	varchar(1)	Someone in the household has an interest in low fat cooking.
FoodsNaturalInd	varchar(1)	Someone in the household has an interest in natural or organic foods.
TravelDomesticInd	varchar(1)	Someone in the household has an interest in domestic traveling.
RecreationalVehiclesInd	varchar(1)	Someone in the household has an interest in recreational vehicles.
TravelFamilyVacationsInd	varchar(1)	Someone in the household has an interest in taking family vacations.
TravelCruiseVacationsInd	varchar(1)	Someone in the household has an interest in taking cruise vacations.
ExerciseRunningJoggingInd	varchar(1)	Someone in the household has an interest in running/jogging for exercise.
ExerciseWalkingInd	varchar(1)	Someone in the household has an interest in walking for exercise.
CraftsInd	varchar(1)	Someone in the household has an interest in crafts.
PhotographyInd	varchar(1)	Someone in the household has an interest in photography.
AviationInd	varchar(1)	Someone in the household has an interest in Aviation.
AutoWorkInd	varchar(1)	Someone in the household has an interest in working on vehicles and mechanics.
SewingKnittingNeedleworkInd	varchar(1)	Someone in the household has an interest in sewing / knitting / needlework.
WoodWorkingInd	varchar(1)	Someone in the household has an interest in woodworking.
GamesBoardGamesPuzzlesInd	varchar(1)	Someone in the household has an interest in board games / puzzles.
MusicPlayerInd	varchar(1)	Someone in the household has indicated they have an interest in music players. (i.e. iPod, MP3, etc.)
MusicCollectorInd	varchar(1)	Someone in the household has indicated they have an interest in collecting music.
MusicAvidListenerInd	varchar(1)	Someone in the household has indicated they have an interest in music and they are an avid music listener.
MovieCollectorInd	varchar(1)	Someone in the household has indicated they are interested in collecting movies.
TVCableInd	varchar(1)	Someone in the household has an interest in watching on TV Cable
MoviesatHomeInd	varchar(1)	Someone in the household has indicated they are interested in watching movies at home. These households have a DVD player or a VCR and they also enjoy home video recording.
TVSatelliteDishInd	varchar(1)	Someone in the household has an interest in watching TV on Satellite Dish
DietingWeightLossInd	varchar(1)	Someone in the household has an interest in dieting / weight loss.
SelfImprovementInd	varchar(1)	Someone in the household has an interest in self improvement.
ParentingInd	varchar(1)	Someone in the household has an interest in parenting.
ChildrensInterestsInd	varchar(1)	Denotes someone in household has purchased children’s items (clothes, books, toys, etc.) showing they have an interest in children.
GrandChildrenInd	varchar(1)	Someone in the household has an interest in grandchildren.
SpectatorSportsRacingInd	varchar(1)	Someone in the household has an interest in watching auto / motorcycle racing.
SpectatorSportsFootballInd	varchar(1)	Someone in the household has an interest in watching football.
NetWorthGoldRank	varchar(1)	Net Worth Gold is a modeled propensity element, assigning households to the most likely range of net worth, as determined by assets minus liabilities.

/web/V1/Consumer/doCount

Introduction

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/Consumer/doCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
            {"Zip": "92688","CarrierRoute": "C057"}
        ]
      },
      "Excludes" :{
        "AddressStreetName" : [
            {"ZipCode" : "92688","Street" : "Arado"}
        ]
      }
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122","CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]
AgeRange	The specified age range	"AgeRange":{ "minimum": 1, "maximum": 5 }
AgeRangeMale	The specified male age range	"AgeRangeMale":{ "minimum": 1, "maximum": 5 }
AgeRangeFemale	The specified female age range	"AgeRangeFemale":{ "minimum": 1, "maximum": 5 }
AgeRangeUnknownGender	The specified unknown gender age range	"AgeRangeUnknownGender":{ "minimum": 1, "maximum": 5 }
NetWorthGoldRank	The specified net worth gold rank	"NetWorthGoldRank": [ "", "1", "2"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]
AgeRange	The specified age range	"AgeRange":{ "minimum": 1, "maximum": 5 }
AgeRangeMale	The specified male age range	"AgeRangeMale":{ "minimum": 1, "maximum": 5 }
AgeRangeFemale	The specified female age range	"AgeRangeFemale":{ "minimum": 1, "maximum": 5 }
AgeRangeUnknownGender	The specified unknown gender age range	"AgeRangeUnknownGender":{ "minimum": 1, "maximum": 5 }
NetWorthGoldRank	The specified net worth gold rank	"NetWorthGoldRank": [ "", "1", "2"]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 606,
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/Consumer/doLookup

Introduction

This endpoint returns a paginated result view of the request. This can sometimes take awhile and should be used after DoCount has been used to filter down your dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/Consumer/doLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688", "CarrierRoute": "C057"}
        ]
      },
      "Excludes" :{
        "AddressStreetName" : [
          {"ZipCode" : "92688","Street" : "Arado"}
        ]
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "RBDI"
      ],
      "Pagination" : {
        "Page": 1
      },
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All Consumer Columns you want returned.
Pagination	Specify the desired page in the results to access. Pages are based on 100 records per page.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"Zip": "92688", "StreetName": "Rancho Santa Margarita"} ]
AgeRange	The specified age range	"AgeRange":{ "minimum": 1, "maximum": 5 }
AgeRangeMale	The specified male age range	"AgeRangeMale":{ "minimum": 1, "maximum": 5 }
AgeRangeFemale	The specified female age range	"AgeRangeFemale":{ "minimum": 1, "maximum": 5 }
AgeRangeUnknownGender	The specified unknown gender age range	"AgeRangeUnknownGender":{ "minimum": 1, "maximum": 5 }
NetWorthGoldRank	The specified net worth gold rank	"NetWorthGoldRank": [ "", "1", "2"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"Zip": "92688", "StreetName": "Rancho Santa Margarita"} ]
AgeRange	The specified age range	"AgeRange":{ "minimum": 1, "maximum": 5 }
AgeRangeMale	The specified male age range	"AgeRangeMale":{ "minimum": 1, "maximum": 5 }
AgeRangeFemale	The specified female age range	"AgeRangeFemale":{ "minimum": 1, "maximum": 5 }
AgeRangeUnknownGender	The specified unknown gender age range	"AgeRangeUnknownGender":{ "minimum": 1, "maximum": 5 }
NetWorthGoldRank	The specified net worth gold rank	"NetWorthGoldRank": [ "", "1", "2"]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access.	"Page": 1

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 606,
  "Results": [
    {
      "MelissaAddressKey": 1021975246,
      "AddressLine": "59 Timbre",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1021975246,
      "AddressLine": "59 Timbre",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1053263424,
      "AddressLine": "1 Conchito",
      "RBDI": "R"
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "NextPage": 2,
    "TotalPages": 6
  },
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of total records returned by the query.
Results	The returned records with requested columns. 100 records per page.
Pagination	Paginated information. CurrentPage The current page number. NextPage The next page number. TotalPages The total number of pages available.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/Consumer/getCount

Introduction

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/Consumer/getCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
            {"Zip": "92688", "CarrierRoute": "C057"}
        ]
      },
      "Excludes" :{
        "AddressStreetName" : [
            {"ZipCode" : "92688","Street" : "Arado"}
        ]
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "RBDI"
      ],
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All Consumer Columns you want returned.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]
AgeRange	The specified age range	"AgeRange":{ "minimum": 1, "maximum": 5 }
AgeRangeMale	The specified male age range	"AgeRangeMale":{ "minimum": 1, "maximum": 5 }
AgeRangeFemale	The specified female age range	"AgeRangeFemale":{ "minimum": 1, "maximum": 5 }
AgeRangeUnknownGender	The specified unknown gender age range	"AgeRangeUnknownGender":{ "minimum": 1, "maximum": 5 }
NetWorthGoldRank	The specified net worth gold rank	"NetWorthGoldRank": [ "", "1", "2"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]
AgeRange	The specified age range	"AgeRange":{ "minimum": 1, "maximum": 5 }
AgeRangeMale	The specified male age range	"AgeRangeMale":{ "minimum": 1, "maximum": 5 }
AgeRangeFemale	The specified female age range	"AgeRangeFemale":{ "minimum": 1, "maximum": 5 }
AgeRangeUnknownGender	The specified unknown gender age range	"AgeRangeUnknownGender":{ "minimum": 1, "maximum": 5 }
NetWorthGoldRank	The specified net worth gold rank	"NetWorthGoldRank": [ "", "1", "2"]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "JobId": "returned_job_id",
  "Count": 606,
  "ResultCode": "LS01",
  "Sample": [
    {
        "MelissaAddressKey": 1021975246,
        "AddressLine": "59 Timbre",
        "RBDI": "R"
    },
    {
        "MelissaAddressKey": 1053263424,
        "AddressLine": "1 Conchito",
        "RBDI": "R"
    },
    {
        "MelissaAddressKey": 1053263424,
        "AddressLine": "1 Conchito",
        "RBDI": "R"
    }
  ]
}

Response Fields

Output Name	Description
JobId	The JobId to be used to purchase and access the full dataset.
Count	Number of records returned by the query.
ResultCode	Success or Error codes based on the response/request.
Sample	A 10 record sample response.

Consumer Two

All consumer two endpoints have the following buyable Columns. For more information on each column, please refer to Consumer Two Data Layout.

• ConsumerTwo

Column Name	Type	Definition
MelissaAddressKey	bigint	10-digit unique key assigned to each address.
BaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
FirstName1	varchar(14)	Primary person’s first name
MiddleNameInitial1	varchar(1)	Primary person’s middle initial
LastName	varchar(20)	Primary person’s last name
NameSuffix1	varchar(2)	Primary person’s name suffix
AddressLine	varchar(50)	Address line
City	varchar(35)	City
State	varchar(2)	State
ZIPCode	varchar(5)	ZIP Code
Plus4	varchar(4)	ZIP plus 4
DeliveryPoint	varchar(2)	A specific location where mail is delivered to an individual or entity. It is a precise point of delivery for a particular address.
AddressKey	varchar(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
ResultCodes	varchar(100)	Melissa result codes
AddressStreetNumber	varchar(10)	Address street number. Ex.’6450’
AddressStreetName	varchar(40)	Address street name Ex. ‘Side’
AddressSuiteNumber	varchar(10)	Suite number. Ex. ‘Q’
AddressType	varchar(1)	Address type. Ex. P.O.Box or residential address
RBDI	varchar(1)	Address type. Ex. P.O.Box or residential address
CarrierRoute	varchar(4)	The carrier route for the location address assigned by the USPS.
FIPSCode	varchar(5)	The FIPSCode indicates the location of the address at both the state and county level.
FIPSCountyCode	varchar(3)	County code
RouteDesignatorAndNumber	varchar(6)	Route designator and number
BoxDesignatorAndNumber	varchar(15)	Box designator and number
AddressQualityCode	varchar(1)	Indicates whether an address matched in the delivery sequence file.
SeasonalDeliveryCode	varchar(1)	Used to denote seasonal delivery. Seasonal delivery is defined as a delivery point that is occupied during one, but less than four of the standard divisions of the year (fall, spring, summer winter)
DeliveryTypeCode	varchar(1)	Categorizes a delivery point as a residential, business, or other type.
AddressNameCensorCode	varchar(1)	Address name censor code
PlaceCode	varchar(7)	Place identifier represented as State FIPS (2) + PlaceFIPS (5)
Latitude	decimal(18, 6)	The latitude in decimal degree using the WGS84 datum for the address
Longitude	decimal(18, 6)	The longitude in decimal degree using the WGS84 datum for the address
CensusKey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
CensusTractBlockGroup2010	varchar(7)	2010 census geo tract or block group
FIPSStateCode2010	varchar(2)	2010 census geo state code
FIPSCountyCode2010	varchar(3)	2010 census geo county code
CBSACode	varchar(5)	The core based statistical area where the place is located.
Gender1	varchar(1)	The gender of the primary person
Age1	varchar(3)	The exact age of the primary person
BirthYear1	varchar(4)	Birth year of the primary person
BirthMonth1	varchar(2)	Birth month of the primary person
TitleCode1	varchar(1)	Primary person’s title code
PhoneNumberAreaCode	varchar(3)	Phone number area code
PhoneNumber	varchar(7)	Phone number
FullPhoneNumber	varchar(10)	Full phone number
LandlinePhoneAreaCode	varchar(3)	Phone number area code
LandlinePhoneNumber	varchar(7)	Landline-primary-all available
PhoneType	varchar(1)	Type of phone(landline)-primary-all available
CellPhoneNumber1	varchar(10)	Cell phone number1
CellPhoneNumber2	varchar(10)	Cell phone number2
CellPhoneNumber3	varchar(10)	Cell phone number3
CellPhoneNumber4	varchar(10)	Cell phone number4
SecondaryCellPhoneAreaCode1	varchar(3)	Secondary cell phone area code1
SecondaryCellPhoneNumber1	varchar(7)	Secondary cell phone number1
SecondaryCellPhoneAreaCode2	varchar(3)	Secondary cell phone area code2
SecondaryCellPhoneNumber2	varchar(7)	Secondary cell phone number2
SecondaryCellPhoneAreaCode3	varchar(3)	Secondary cell phone area code3
SecondaryCellPhoneNumber3	varchar(7)	Secondary cell phone number3
SecondaryCellPhoneAreaCode4	varchar(3)	Secondary cell phone area code4
SecondaryCellPhoneNumber4	varchar(7)	Secondary cell phone number4
Email	varchar(450)	Email
EmailResultLevel	int	Email result level
Age0to2Code	varchar(1)	Children age 0 to 2(enhanced)
Age3to5Code	varchar(1)	Children age 3 to 5(enhanced)
Age6to10Code	varchar(1)	Children age 6 to 10(enhanced)
Age11to15Code	varchar(1)	Children age 11 to 15(enhanced)
Age16to17Code	varchar(1)	Children age 16 to17(enhanced)
Age18to24Code	varchar(1)	Age 18 to 24 year old specific(enhanced)
Age25to34Code	varchar(1)	Age 25 to 34 year old specific(enhanced)
Age35to44Code	varchar(1)	Age 35 to 44 year old specific(enhanced)
Age45to54Code	varchar(1)	Age 45 to 54 year old specific(enhanced)
Age55to64Code	varchar(1)	Age 55 to 64 year old specific(enhanced)
Age65to74Code	varchar(1)	Age 65 to 74 year old specific(enhanced)
Age75PlusCode	varchar(1)	Presence of adults age 75 plus specific(enhanced)
AgeUnknownCode	varchar(1)	Presence of adults unknown age(enhanced)
Under35Ind	varchar(1)	Age under35 year old inferred(enhanced)
Age35to44Ind	varchar(1)	Age 35 to 44 year old inferred(enhanced)
Age45to64Ind	varchar(1)	Age 45 to 64 year old inferred(enhanced)
Age65PlusInd	varchar(1)	Age 65 plus year old inferred(enhanced)
NumberOfPersonsinHousehold	varchar(1)	Advantage household size(enhanced)
NumberOfAdultsinHousehold	varchar(1)	Advantage number of adults
AdvantageNumberOfAdultsInd	varchar(1)	Advantage number of adults indicator
NumberOfChildreninHousehold	varchar(1)	Number of children in household(enhanced)
PresenceOfChildren	varchar(1)	Advantage presence of children(enhanced)
PresenceOfChildrenInd	varchar(1)	Advantage presence of children indicator(enhanced)
TargetNetWorth	varchar(1)	Target net worth2.0
HouseholdsMedianHouseholdIncome	varchar(6)	Households: median household income
HouseholdAgeCode	varchar(1)	Advantage household age code(enhanced)
HouseholdTypeCode	varchar(2)	Household type/family composition(enhanced)
AdvantageHouseholdAgeInd	varchar(1)	Advantage household age indicator(enhanced)
AdvantageHouseholdSizeInd	varchar(1)	Advantage household size indicator(enhanced)
HouseholdVerificationDate	varchar(6)	Verification date of household
Occupation	varchar(2)	Occupation
MaritalStatusCode	varchar(1)	Advantage household marital status
LengthOfResidence	varchar(1)	Advantage length of residence
AdvantageLengthOfResidenceInd	varchar(1)	Advantage length of residence indicator
AdvantageHomeOwnerInd	varchar(1)	Advantage home owner indicator
AdvantageHouseholdMaritalStatusInd	varchar(1)	Advantage household marital status indicator
EstimatedHomeIncomePredictor	varchar(1)	Advantage target income2.0
AdvantageHouseholdIncomeIdentifierInd	varchar(1)	Advantage target income indicator2.0
FamiliesPercentHouseholdWithOwnChildren	varchar(2)	Families: %households with own children
PopulationPercentWhiteAlone	varchar(2)	The percentage of the white population
AvailableHomeEquityInThousands	varchar(4)	Available home equity in thousands
AvgVehiclesPerOccupiedUnit	varchar(3)	Occupied housing units: avg. number of vehicles available
DwellingType	varchar(1)	Advantage dwelling type
AdvantageDwellingTypeInd	varchar(1)	Advantage dwelling type indicator
HomeOwnerRenterCode	varchar(1)	Advantage home owner
MedianValueOwnerOccupiedHousingUnits	varchar(7)	Median value, owner-occupied housing units
YearHomeBuilt	varchar(4)	Year home built
LivingAreaSquareFootageRange	varchar(1)	Living area square footage range
LotCode	varchar(1)	Property lot size in acres
HomeSaleDate	varchar(6)	Home sale date
HomeSalePriceinThousands	varchar(4)	Home sale price(in thousands)
HomeMarketValueTaxRecord	varchar(4)	Home market value(tax record)
MortgageDate	varchar(6)	Mortgage date
OriginalMortgageAmount	varchar(4)	Original mortgage amount
FirstMortgageAmountInThousands	varchar(4)	First mortgage amount in thousands
SecondMortgageAmountinThousands	varchar(4)	Second mortgage amount in thousands
MortgageLoantypeorRefinance	varchar(1)	Mortgage loan type (or refinance)
MortgageInterestRateorRefinance	varchar(4)	Mortgage interest rate (or refinance)
MortgageInterestRateTypeorRefinance	varchar(1)	Mortgage interest rate type (or refinance)
RefinanceInd	varchar(1)	Refinance indicator
HomeEquityLoanDate	varchar(6)	Home equity loan date
HomeEquityLoaninThousands	varchar(4)	Home equity loan in thousands
HomeEquityLoanInd	varchar(1)	Home equity loan indicator
TargetHomeMarketValueOrig	varchar(5)	Target home market value
TargetHomeMarketValue	varchar(4)	Target home market value
TargetHomeMarketValueType	varchar(1)	Target home market value type
HousingUnitsPercentOwnerOccupied	varchar(2)	Housing units: %owner occupied housing units
HousingUnitsPercentOneUnitDetached	varchar(2)	Housing units: %1 unit detached
HousingUnitsPercentBuilt2000To2009	varchar(2)	Housing units percent built 2000 to2009
HousingUnitsPercentBuilt2010OrLater	varchar(2)	Housing units percent built 2010 or later
TypeOfCreditCardAmericanExpress	varchar(1)	Type of credit card-american express
TypeOfCreditCardAnyCreditCard	varchar(1)	Type of credit card-any credit card
CreditCardUsageBankCard	varchar(1)	Type of credit card-bank card
TypeOfCreditCardCatalogShowroom	varchar(1)	Type of credit card-catalog showroom
TypeOfCreditCardComputerElectronic	varchar(1)	Type of credit card-computer/electronic
TypeOfCreditCardDebitCard	varchar(1)	Type of credit card-debit card
CreditCardUsageFinanceCoCard	varchar(1)	Type of credit card-finance co card
TypeOfCreditCardFurniture	varchar(1)	Type of credit card-furniture
TypeOfCreditCardGrocery	varchar(1)	Type of credit card-grocery
TypeOfCreditCardHomeImprovement	varchar(1)	Type of credit card-home improvement
TypeOfCreditCardHomeOfficeSupply	varchar(1)	Type of credit card-home/office supply
TypeOfCreditCardLowEndDepartmentStore	varchar(1)	Type of credit card-low end department store
TypeOfCreditCardMainStreetRetail	varchar(1)	Type of credit card-main street retail
TypeOfCreditCardMastercard	varchar(1)	Type of credit card-Mastercard
TypeOfCreditCardMembershipWarehouse	varchar(1)	Type of credit card-membership warehouse
CreditCardUsageMiscellaneous	varchar(1)	Type of credit card-miscellaneous
CreditCardUsageOilGasCard	varchar(1)	Type of credit card-oil + gas card
TypeOfCreditCardSpecialtyApparel	varchar(1)	Type of credit card-specialty apparel
TypeOfCreditCardSportingGoods	varchar(1)	Type of credit card-sporting goods
CreditCardUsageStandardRetail	varchar(1)	Type of credit card-standard retail
CreditCardUsageStandardSpecialtyCard	varchar(1)	Type of credit card-standard specialty card
CreditCardUsageTravelEntertainment	varchar(1)	Type of credit card-travel+entertainment
TypeOfCreditCardTVMailOrder	varchar(1)	Type of credit card-TVmail order
CreditCardUsageUpscaleRetail	varchar(1)	Type of credit card-upscale retail
CreditCardUsageUpscaleSpecRetail	varchar(1)	Type of credit card-upscale spec retail
TypeOfCreditCardVisa	varchar(1)	Type of credit card-visa
StatusCodeOfRecords	varchar(1)	Record quality code
FileCode	varchar(1)	File code
Fraction	varchar(3)	Fraction
PostOfficeName	varchar(13)	Post office name
Niches2	varchar(3)	Niches2
MailResponsiveInd	varchar(1)	Mail order buyer
FirstName2	varchar(14)	Secondary person’s first name
MiddleNameInitial2	varchar(1)	Secondary person’s middle initial
Gender2	varchar(1)	Secondary person’s gender
Age2	varchar(3)	The exact age of the secondary person
BirthYear2	varchar(4)	Birth year of the secondary person
BirthMonth2	varchar(2)	Birth month of the secondary person
TitleCode2	varchar(1)	Secondary person’s title code
FirstName3	varchar(14)	Tertiary person’s first name
MiddleNameInitial3	varchar(1)	Tertiary person’s middle name
Gender3	varchar(1)	Tertiary person’s gender
Age3	varchar(3)	The exact age of tertiary person
BirthYear3	varchar(4)	Birth year of the tertiary person
BirthMonth3	varchar(2)	Birth month of the tertiary person
FirstName4	varchar(14)	Quaternary person’s first name
MiddleNameInitial4	varchar(1)	Quaternary person’s middle name
Gender4	varchar(1)	Quaternary person’s gender
Age4	varchar(3)	The exact age of the quaternary person
BirthYear4	varchar(4)	Birth year of the quaternary person
BirthMonth4	varchar(2)	Birth month of the quaternary person
FirstName5	varchar(14)	Quinary person’s first name
MiddleNameInitial5	varchar(1)	Quinary person’s middle name initial
Gender5	varchar(1)	Quinary person’s gender
Age5	varchar(3)	The exact age of the quinary person
BirthYear5	varchar(4)	Birth year of the quinary person
BirthMonth5	varchar(2)	Birth month of the quinary person

/web/V1/ConsumerTwo/doCount

Introduction

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/ConsumerTwo/doCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
            {"Zip": "92688", "CarrierRoute": "C057"}
        ]
      },
      "Excludes" :{
        "AddressStreetName" : [
            {"ZipCode" : "92688","Street" : "Arado"}
        ]
      }
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": ["1","true","null"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]
MailResponsiveInd	An indicator of mail responsiveness at the address.	"MailResponsiveInd": ["1","true","null"]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 500,
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/ConsumerTwo/doLookup

Introduction

This endpoint returns a paginated result view of the request. This can sometimes take awhile and should be used after DoCount has been used to filter down your dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/ConsumerTwo/doLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688", "CarrierRoute": "C057"}
        ]
      },
      "Excludes" :{
        "AddressStreetName" : [
          {"ZipCode" : "92688","Street" : "Arado"}
        ]
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "RBDI"
      ],
      "Pagination" :{
        "Page": 1
      },
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All Consumer Two Columns you want returned.
Pagination	Specify the desired page in the results to access. Pages are based on 100 records per page.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access.	"Page": 1

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "Count": 500,
  "Results": [
    {
      "MelissaAddressKey": 1007278045,
      "AddressLine": "139 Timbre",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1021975246,
      "AddressLine": "59 Timbre",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1053263424,
      "AddressLine": "1 Conchito",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1082194559,
      "AddressLine": "92 Abrigo",
      "RBDI": "R"
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "NextPage": 2,
    "TotalPages": 5
  },
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
Results	Returned records with requested Columns. 100 records per page.
Pagination	Paginated information. CurrentPage The current page number. NextPage The next page number. TotalPages The total number of pages available.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/ConsumerTwo/getCount

Introduction

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/ConsumerTwo/getCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Zips": [
          {"Zip": "92688", "CarrierRoute": "C057"}
        ]
      },
      "Excludes" :{
        "AddressStreetName" : [
          {"ZipCode" : "92688","Street" : "Arado"}
        ]
      },
      "Columns": [
        "MelissaAddressKey",
        "AddressLine",
        "RBDI"
      ],
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All Consumer Two Columns you want returned.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
RBDI	An RBDI code.	"RBDI": ["B"]
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
AddressStreetName	A list of Address Street Name objects	"AddressStreetName": [ {"ZipCode": "92688", "Street": "Rancho Santa Margarita"} ]

Headers

• POST JSON

Content-Type: application/json
Accept: application/json

Response

• POST JSON

{
  "JobId": "returned_job_id",
  "Count": 500,
  "ResultCode": "LS01",
  "Sample": [
    {
      "MelissaAddressKey": 1021975246,
      "AddressLine": "59 Timbre",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1053263424,
      "AddressLine": "1 Conchito",
      "RBDI": "R"
    },
    {
      "MelissaAddressKey": 1082194559,
      "AddressLine": "92 Abrigo",
      "RBDI": "R"
    }
  ]
}

Response Fields

Output Name	Description
JobId	The JobId to be used to purchase and access the full dataset.
Count	Number of records returned by the query.
ResultCode	Success or Error codes based on the response/request.
Sample	A 10 record sample response.

Business

All Business endpoints have the following buyable Columns. For more information on each Column, please refer to the Business Data Layout.

• Business

Column Name	Type	Definition
MelissaAddressKey	bigint	10-digit unique key assigned to each address.
BaseMelissaAddressKey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
Name	varchar(256)	The place’s common, recognized name, or “doing business as” name.
AddressLine	varchar(255)	Address line
Suite	varchar(50)	Suite
City	varchar(100)	City
State	varchar(2)	State
ZIPCode	varchar(5)	ZIP code
Plus4	varchar(4)	ZIP plus 4
DeliveryPoint	varchar(2)	A specific location where mail is delivered to an individual or entity. It is a precise point of delivery for a particular address.
AddressKey	varchar(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
ResultCodes	varchar(200)	Melissa result codes
AddressStreetNumber	varchar(50)	Address street number. Ex. ‘6450’
AddressDirectionPrefix	varchar(50)	Address directional prefix. Ex. ‘e’
AddressStreetName	varchar(50)	Street name. Ex. ‘Side’
AddressStreetSuffix	varchar(50)	Suffix of address. Ex. ‘Dr’
AddressDirectionSuffix	varchar(50)	Address directional suffix. Ex. ‘Ne’
AddressSuiteName	varchar(50)	Suite. Ex. ‘Apt’
AddressSuiteNumber	varchar(50)	Suite number. Ex. ‘Q’
AddressTypeCode	varchar(256)	The type of address for the location.
CarrierRoute	varchar(4)	The carrier route for the location address as assigned by the USPS.
FIPSCode	varchar(5)	The FIPSCode indicates the location of the address at both the state and county level.
CMRAInd	bit	Indicates whether the location is a Commercial Mail Receiving Agency.
AddressChangedDate	varchar(256)	The date when the business changed location.
LandmarkAddress	varchar(1000)	The name of the complex, building, or mall where the place resides.
MailingMelissaAddresskey	bigint	10-digit unique key assigned to each address.
MailingBaseMelissaAddresskey	bigint	Displays the parent Melissa Address Key of an address if it is a part of or within a building. Ex. Apartment
MailingAddressLine	varchar(255)	Address line
MailingAddressSuite	varchar(50)	Suite
MailingAddressCity	varchar(100)	City
MailingAddressState	varchar(2)	State
MailingAddressZIPCode	varchar(5)	ZIP code
MailingAddressPlus4	varchar(4)	Plus 4
MailingDeliveryPoint	varchar(2)	A specific location where mail is delivered to an individual or entity. It is a precise point of delivery for a particular address.
MailingAddressKey	varchar(11)	Address key is a combination of a location’s ZIPCode + Plus4 + DeliveryPoint
MailingResultCodes	varchar(200)	Melissa result codes
MailingAddressStreetNumber	varchar(50)	Address street number. Ex. ‘6450’
MailingAddressDirectionPrefix	varchar(50)	Address directional prefix. Ex. ‘e’
MailingAddressStreetName	varchar(50)	Street name. Ex. ‘Side’
MailingAddressStreetSuffix	varchar(50)	Suffix of address. Ex. ‘Dr’
MailingAddressDirectionSuffix	varchar(50)	Address directional suffix. Ex. ‘Ne’
MailingAddressSuiteName	varchar(50)	Suite. Ex. ‘Apt’
MailingAddressSuiteNumber	varchar(50)	Suite number. Ex. ‘Q’
MailingAddressTypeCode	varchar(256)	Address type code
MailingAddressCarrierRoute	varchar(4)	The carrier route for the location address as assigned by the USPS.
MailingAddressFIPSCode	varchar(5)	The FIPSCode indicates the location of the address at both the state and county level.
MailingAddressCMRAInd	bit	Information on whether the mailing address listed for the place is a Commercial Mail Receiving Agency.
PrimarySICCodeId	varchar(256)	The primary line of business represented by a Standard Industrial Classification code.
SecondarySicCodeIds	varchar(500)	The lines of business represented by Standard Industrial Classification codes.
NAICSCode1	int	The primary line of business represented by a Standard Industrial Classification code.
NAICSCode2	varchar(1000)	The lines of business represented by North American Industry Classification System codes
ContactFirstName	varchar(256)	The first name of the individual.
ContactLastName	varchar(256)	The last name of the individual.
PhoneNumber	varchar(30)	The telephone number for the place.
TollFreeNumber	varchar(30)	The toll-free phone number for the place.
PhoneNumber2	varchar(30)	An additional phone number for the place.
FaxNumber	varchar(30)	The fax number for the place.
CorporateEmployeeCount	int	The actual, reported total number of employees at all locations in a corporate family.
EstimatedCorporateEmployeeCount	int	Estimates the total number of employees at all locations in a corporate family.
LocationEmployeeCount	int	The number of employees who work at this place.
EstimatedLocationEmployeeCount	int	Estimates the number of employees who work at this location.
LocationSalesVolume	bigint	An estimation of the place’s sales revenue.
ContactEmail	varchar(75)	The email address of the contact.
ContactEmailDeliverableInd	bit	The deliverability status of the email address.
ContactEmailMarketableInd	bit	The marketable status of the email address.
Latitude	decimal(18,6)	The latitude in decimal degree using the WGS84 datum for the address
Longitude	decimal(18,6)	The longitude in decimal degree using the WGS84 datum for the address
Censuskey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
CensusBlock	int	The census block group of the location as defined by the US Census Bureau.
CensusTract	varchar(6)	The census tract of the location as defined by the US Census Bureau.
SgcDivision	varchar(256)	The unique identifier for counties based on the Standard Geographical Classification (SGC).
CBSACode	int	The core based statistical area where the place is located.
CBSALevel	int	Information on whether the CBSA is a micropolitan or metropolitan area.
CSACode	int	The combined statistical area code where the place is located.
MailingLatitude	decimal(18, 6)	The latitude in decimal degree using the WGS84 datum for the address
MailingLongitude	decimal(18, 6)	The longitude in decimal degree using the WGS84 datum for the address
MailingCensusKey	varchar(16)	Census key is a 15 or 16-character key combination of the state FIPS code + county FIPS code + tract number + block number + block suffix. The Census key was created by the US Government to correctly identify, classify, and pull statistical data from areas across the United States.
ContactId	varchar(256)	The unique ID for the contact.
ContactGender	varchar(256)	The gender of the individual.
ContactJobFunctionId	int	Describes the type of work an employee performs in their organization.
ContactJobTitles	varchar(500)	Descriptive label of the individual’s job
ContactJobTitlesCount	int	The total number of Job titles associated with the contact.
ContactManagementLevel	varchar(256)	Describes the contact’s position relative to others in their organization.
ContactProfessionalTitle	varchar(256)	The professional degree or title of the individual.
ContactIndicator	bit	Information on whether the individual is the primary contact for the location.
ContactSuppressedFields	varchar(256)	The fields on the individual that are suppressed.
ContactTitleCodes	varchar(256)	A list of the individual’s job titles.
Website	varchar(max)	The primary homepage URL of the business.
FacebookURL	varchar(max)	The link to the place on Facebook.
TwitterUrl	varchar(500)	The link to the place on Twitter.
LinkedInURL	varchar(1000)	The link to the place on LinkedIn.
YelpUrl	varchar(500)	The link to the place on Yelp.
PinterestUrl	varchar(500)	The link to the place on Pinterest.
YoutubeUrl	varchar(500)	The link to the place’s YouTube channel or company video.
TumblrUrl	varchar(500)	The link to the place on Tumblr.
FoursquareUrl	varchar(500)	The link to the place on Foursquare.
InstagramUrl	varchar(500)	The link to the place on Instagram.
LogoUrl	varchar(1000)	The link to the place’s logo image.
WebsiteKeywords	varchar(max)	Keywords from company website HTML.
LocationProfessionalSizeCode	varchar(256)	The number of professionals practicing at the place.
PlaceType	varchar(256)	The type of place within a corporation.
AlternativeName	varchar(2000)	An additional business name or DBA for the place.
HistoricalNames	varchar(2000)	Previously used names for the business.
LegalNames	varchar(2000)	The legal names of the place.
BusinessID	int	The unique identifier for a Place.
WorkAtHome	bit	The place is a work at home business.
InBusiness	bit	The operational status of the business.
VerifiedOn	varchar(256)	The date the business was most recently verified.
DuplicateOf	varchar(256)	The ID of the valid record that this place is a duplicate of.
Suppressed	bit	The place is suppressed from customer feeds.
SuppressedFields	varchar(1000)	The list of fields that are suppressed from display.
CreatedAt	varchar(256)	The date and time when the place record was created.
UpdatedAt	varchar(256)	The date and time when the place was last updated.
OpenedForBusinessOn	varchar(256)	The date when the place opened for business.
EstimatedOpenedForBusinessLower	varchar(256)	Estimated opened for business lower
EstimatedOpenedForBusinessUpper	varchar(256)	Estimated opened for business upper
LocationParentId	int	primary
LocationParentRelationship	varchar(256)	The relationship to the primary business at a location
NumberOfTenants	int	The number of places at a multi-tenant location.
BusinessTypeIdsLabels	varchar(500)	Business type Ids labels
ContactsCount	int	Contacts count
OwnershipChangedOn	varchar(256)	The date when ownership of the place changed.
HeadquartersId	varchar(256)	The direct headquarters of this place in its corporate family.
AncestorHeadquartersIds	varchar(256)	The full list of all ancestors in the corporate family.
AncestorHeadquartersIdsCount	int	The total number of Ancestor Headquarters associated with the place.
UltimateHeadquartersId	varchar(256)	The top-level headquarters of a corporate family.
ChainIdLabels	varchar(256)	Chain Id labels
CorporateFranchising	bit	Determine if the corporation includes franchised branches.
CorporateSalesRevenue	bigint	The actual, reported sales revenue for the corporate family.
EstimatedCorporateSalesRevenue	bigint	Estimates total sales revenue for the corporate family.
BranchCount	int	The number of branches reporting to a headquarter record.
ForeignParentInd	bit	The place is owned by a corporation outside the US or Canada.
FortuneRanking	int	The place’s ranking on the Fortune Magazine Top 1000 list.
StockExchangeCode	int	The Stock Exchange where the corporation conducts trading activity.
StockTickerSymbol	varchar(256)	The abbreviation used to identify the company on a stock market.
TheCentralIndexKey	varchar(256)	The Central Index Key (CIK) assigned to the corporation for filing with the SEC.
AffiliationIdsLabels	varchar(256)	Affiliation Ids Labels
BrandIdsLabels	varchar(256)	Brand Ids labels
CompanyDescription	varchar(max)	The description of the business.
DressCode	varchar(2000)	Details about the place’s dress code.
EquipmentRentals	varchar(256)	Information on whether equipment rentals are available.
HasEcommerce	bit	The presence of a shopping cart on the business’s website.
LanguagesSpoken	varchar(256)	The languages spoken at the place.
PriceRange	varchar(500)	The price range for products and services sold at the place.
ProfessionalSpecialty	varchar(500)	Professional specialty Ids labels
PublicAccess	bit	Indicates whether the place is publicly accessible.
ShoppingCenterAtm	bit	The location has an ATM.
OperatingHoursCount	int	The number of operating hours at the place.
PaymentTypes	varchar(256)	The types of payments accepted at the location.
InsurancesAccepted	varchar(500)	The types of insurances accepted by the business.
MedicareAccepted	bit	Information on whether the place accepts Medicare.
MedicaidAccepted	bit	Information on whether the place accepts Medicaid.
ServiceAreaPostalCodes	varchar(256)	The list of postal codes making up the service area of the place.
NbrcCorporationFilingType	varchar(256)	The type of business registration filing.
NbrcCorporateDate	varchar(256)	Date when place registered as a business.
CarMakeIdsLabels	varchar(256)	Car Make Ids labels
ReligiousDenominationIdsLabels	varchar(256)	Religious denomination ids labels
RestaurantCuisines	varchar(500)	The type of cuisine served at the place.
RestaurantLimitedService	bit	Indicates the restaurant service offering of the place.
RestaurantReservations	bit	The restaurant has reservations.
RestaurantTakeout	bit	The restaurant has takeout.
HappyHoursCount	int	The number of Happy Hour records on the place.
HotelCableTV	bit	The hotel has Cable TV.
HotelContinentalBreakfast	bit	The hotel offers continental breakfast.
HotelElevator	bit	The hotel has an elevator.
HotelExerciseFacility	bit	The hotel has an exercise facility.
HotelGuestLaundry	bit	The hotel has guest laundry services.
HotelHotTub	bit	The hotel has a hot tub.
HotelIndoorPool	bit	The hotel has an indoor pool.
HotelKitchens	bit	The hotel has guest kitchens.
HotelOutdoorPool	bit	The hotel has an outdoor pool.
HotelPetFriendly	bit	The hotel allows pets.
HotelRoomService	bit	The hotel offers room service.
HospitalHasEmergencyRoom	bit	The hospital has an emergency room.
EstimatedFleetSizeLower	int	Estimates the number of vehicles owned or used by the location.
EstimatedFleetSizeUpper	int	Estimated fleet size upper
GrowingBusinessGode	varchar(256)	Information on whether the business is growing or shrinking a significant percentage.
SquareFootage	int	An estimate of the space the place occupies.
WhiteCollarPercentage	int	An estimation of white collar workers at the place.
PopulationDensity	varchar(256)	The actual population density of the city.
PopulationCodeForZIP	int	The population size of the city by ZIP code.
WealthyAreaInd	bit	An estimation on whether the place is located in a wealthy area.
PhysicianYearOfGraduation	int	The year the physician graduated from medical school.
MedicalSchoolCode	varchar(256)	The medical school the physician attended.
HospitalNumber	varchar(256)	The hospital the physician is associated with.
Upin	varchar(256)	The physician’s unique physician identification number (UPIN).
LicenseNumber	varchar(256)	The physician’s medical license number.
StateOfLicense	varchar(256)	The state where the physician’s medical license was issued.
PhysicianYearOfBirth	int	The physician’s year of birth.
ResidencyHospitalCode	varchar(256)	The hospital where the physician completed their residency.
ResidencyGraduationYear	int	The year the physician graduated from their residency program.
NationalProviderID	bigint	Ami national provider indicator
MedicalDeaNumber	varchar(256)	The physician’s DEA number.
AcceptingNewPatientsIndicator	bit	The medical professional or office is accepting new patients.
PhysicianPrimarySpecialtyCode	int	The physician’s primary medical specialty.
PhysicianSecondarySpecialtyCode	int	The physician’s secondary medical specialty.
BoardCertifiedInd	bit	Information on whether the physician is board certified.

/web/V1/Business/doCount

Introduction

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/Business/doCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Cities": [
          {"City": "Rancho Santa Margarita","State":"CA"},
          {"City": "Irvine","State":"CA"}
        ],
        "EmailDeliverableInd": ["true"],
        "RestaurantCuisines": ["pizza","burgers"]
      }
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
PrimarySICCodeId (Required)	The primary line of business represented by a Standard Industrial Classification code. NOTE: You can use the “all” keyword to query all SICCodes as well.	"PrimarySICCodeId": ["171102"] "PrimarySICCodeId": ["all"]
RBDI	An RBDI code.	"RBDI": "B"
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
Email	Email address.	"Email": ["contact@melissa.com"]
EmailDeliverableInd	The deliverability status of the email address.	"EmailDeliverableInd": ["1","true","null"]
EmailMarketableInd	The marketable status of the email address.	"EmailMarketableInd": true
JobTitles	Descriptive label of the individual’s job.	"JobTitles": ["Engineer"]
LanguagesSpoken	A list of the languages spoken.	"LanguagesSpoken": ["en","es"]
ManagementLevelLabels	Describes the position relative to others in their organization.	"ManagementLevelLabels": ["C-Level"]
TitleCodes	A list of title codes.	"TitleCodes": ["(","3","K"]
TitleCodesLabels	A list of title codes labels.	"TitleCodesLabels": ["Partner","President","Human Resources"]
SecondarySicCodeIds	The secondary line of business represented by Standard Industrial Classification code.	"SecondarySicCodeIds": ["73"]
NAICSCode1	The primary line of business represented by a North American Industry Classification System code.	"NAICSCode1": ["44424012"]
NAICSCode2	The secondary line of business represented by North American Industry Classification System code.	"NAICSCode2": ["44424012"]
CorporateEmployeeCount	The actual, reported total number of employees at all locations in a corporate family.	"CorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
EstimatedCorporateEmployeeCount	Estimated total number of employees at all locations in a corporate family.	"EstimatedCorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
LocationEmployeeCount	The number of employees who work at this place.	"LocationEmployeeCount": { "minimum": 50, "maximum": 100 }
EstimatedLocationEmployeeCount	Estimated number of employees who work at this location.	"EstimatedLocationEmployeeCount": { "minimum": 50, "maximum": 100 }
LocationSalesVolume	An estimation of the place’s sales revenue.	"LocationSalesVolume": { "minimum": 50, "maximum": 5000000 }
ContactEmail	The email address of the contact.	"ContactEmail": ["info@melissa.com"]
ContactEmailDeliverableInd	The deliverability status of the email address.	"ContactEmailDeliverableInd": ["1","true","null"]
ContactEmailMarketableInd	The marketable status of the email address.	"ContactEmailMarketableInd": true
CBSACode	The core based statistical area where the place is located.	"CBSACode": ["31080"]
CBSALevel	Information on whether the CBSA is a micropolitan or metropolitan area.	"CBSALevel": ["2"]
CSACode	The combined statistical area code where the place is located.	"CSACode": ["348"]
ContactApider	The gender of the individual.	"ContactApider": ["F"]
ContactJobFunctionId	Describes the type of work an employee performs in their organization.	"ContactJobFunctionId": ["270"]
ContactJobTitles	Descriptive label of the individual’s job associated with the contact.	"ContactJobTitles": ["Owner"]
ContactJobTitlesCount	The total number of Job titles associated with the contact.	"ContactJobTitlesCount": ["1"]
ContactManagementLevel	Describes the contact’s position relative to others in their organization.	"ContactManagementLevel": ["manager"]
ContactProfessionalTitle	The professional degree or title of the individual.	"ContactProfessionalTitle": ["manager"]
ContactIndicator	Information on whether the individual is the primary contact for the location.	"ContactIndicator": ["true"]
ContactSuppressedFields	The fields on the individual that are suppressed.	"ContactSuppressedFields": ["email"]
ContactTitleCodes	A list of the individual’s job titles.	"ContactTitleCodes": ["5"]
Website	The primary homepage URL of the business.	"Website": ["melissa.com"]
WorkAtHome	The place is a work at home business.	"WorkAtHome": true
OpenedForBusinessOn	The date when the place opened for business.	"OpenedForBusinessOn": ["1996-05-11", "1996"]
EstimatedOpenedForBusiness	Range of the estimated date when the place opened for business.	"EstimatedOpenedForBusiness": { "minimum": "1998-01-01", "maximum": "1998-12-31" }
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"]
EstimatedCorporateSalesRevenue	Estimated total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]
PrimaryContactInd	The status of PrimaryContactInd	"PrimaryContactInd": [true]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
PrimarySICCodeId	The primary line of business represented by a Standard Industrial Classification code. NOTE: You can use the “all” keyword to query all SICCodes as well.	"PrimarySICCodeId": ["171102"] "PrimarySICCodeId": ["all"]
RBDI	An RBDI code.	"RBDI": "B"
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
Email	Email address.	"Email": ["contact@melissa.com"]
EmailDeliverableInd	The deliverability status of the email address.	"EmailDeliverableInd": ["1","true","null"]
EmailMarketableInd	The marketable status of the email address.	"EmailMarketableInd": true
JobTitles	Descriptive label of the individual’s job.	"JobTitles": ["Engineer"]
LanguagesSpoken	A list of the languages spoken.	"LanguagesSpoken": ["en","es"]
ManagementLevelLabels	Describes the position relative to others in their organization.	"ManagementLevelLabels": ["C-Level"]
SecondarySicCodeIds	The secondary line of business represented by Standard Industrial Classification code.	"SecondarySicCodeIds": ["73"]
NAICSCode1	The primary line of business represented by a North American Industry Classification System code.	"NAICSCode1": ["44424012"]
NAICSCode2	The secondary lines of business represented by North American Industry Classification System code.	"NAICSCode2": ["44424012"]
CorporateEmployeeCount	The actual, reported total number of employees at all locations in a corporate family.	"CorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
EstimatedCorporateEmployeeCount	Estimated total number of employees at all locations in a corporate family.	"EstimatedCorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
LocationEmployeeCount	The number of employees who work at this place.	"LocationEmployeeCount": { "minimum": 50, "maximum": 100 }
EstimatedLocationEmployeeCount	Estimated number of employees who work at this location.	"EstimatedLocationEmployeeCount": { "minimum": 50, "maximum": 100 }
LocationSalesVolume	An estimation of the place’s sales revenue.	"LocationSalesVolume": { "minimum": 50, "maximum": 5000000 }
ContactEmail	The email address of the contact.	"ContactEmail": ["info@melissa.com"]
ContactEmailDeliverableInd	The deliverability status of the email address.	"ContactEmailDeliverableInd": ["1","true","null"]
ContactEmailMarketableInd	The marketable status of the email address.	"ContactEmailMarketableInd": true
CBSACode	The core based statistical area where the place is located.	"CBSACode": ["31080"]
CBSALevel	Information on whether the CBSA is a micropolitan or metropolitan area.	"CBSALevel": ["2"]
CSACode	The combined statistical area code where the place is located.	"CSACode": ["348"]
ContactApider	The gender of the individual.	"ContactApider": ["F"]
ContactJobFunctionId	Describes the type of work an employee performs in their organization.	"ContactJobFunctionId": ["270"]
ContactJobTitles	Descriptive label of the individual’s job associated with the contact.	"ContactJobTitles": ["Owner"]
ContactJobTitlesCount	The total number of Job titles associated with the contact.	"ContactJobTitlesCount": ["1"]
ContactManagementLevel	Describes the contact’s position relative to others in their organization.	"ContactManagementLevel": ["manager"]
ContactProfessionalTitle	The professional degree or title of the individual.	"ContactProfessionalTitle": ["manager"]
ContactIndicator	Information on whether the individual is the primary contact for the location.	"ContactIndicator": ["true"]
ContactSuppressedFields	The fields on the individual that are suppressed.	"ContactSuppressedFields": ["email"]
ContactTitleCodes	A list of the individual’s job titles.	"ContactTitleCodes": ["5"]
Website	The primary homepage URL of the business.	"Website": ["melissa.com"]
WorkAtHome	The place is a work at home business.	"WorkAtHome": true
OpenedForBusinessOn	The date when the place opened for business.	"OpenedForBusinessOn": ["1996-05-11", "1996"]
EstimatedOpenedForBusiness	Range of the estimated date when the place opened for business.	"EstimatedOpenedForBusiness": { "minimum": "1998-01-01", "maximum": "1998-12-31" }
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"]
EstimatedCorporateSalesRevenue	Estimated total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]
PrimaryContactInd	The status of PrimaryContactInd	"PrimaryContactInd": [true]

Headers

• POST JSON

 Content-Type: application/json
 Accept: application/json

Response

• POST JSON

{
  "Count": 108,
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/Business/doLookup

Introduction

This endpoint returns a paginated result view of the request. This can sometimes take awhile and should be used after DoCount has been used to filter down your dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/Business/doLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Cities": [
          {"City": "Rancho Santa Margarita","State":"CA"},
          {"City": "Irvine","State":"CA"}
        ],
        "EmailDeliverableInd": ["true"],
        "RestaurantCuisines": ["pizza","burgers"]
      },
      "Columns": [
        "MelissaAddressKey",
        "Name"
      ],
      "Pagination" :{
        "Page": 1
      },
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All Business Columns you want returned.
Pagination	Specify the desired page in the results to access. Pages are based on 100 records per page.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
PrimarySICCodeId (Required)	The primary line of business represented by a Standard Industrial Classification code. NOTE: You can use the “all” keyword to query all SICCodes as well.	"PrimarySICCodeId": ["171102"] "PrimarySICCodeId": ["all"]
RBDI	An RBDI code.	"RBDI": "B"
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
Email	Email address.	"Email": ["contact@melissa.com"]
EmailDeliverableInd	The deliverability status of the email address.	"EmailDeliverableInd": ["1","true","null"]
EmailMarketableInd	The marketable status of the email address.	"EmailMarketableInd": true
JobTitles	Descriptive label of the individual’s job.	"JobTitles": ["Engineer"]
LanguagesSpoken	A list of the languages spoken.	"LanguagesSpoken": ["en","es"]
ManagementLevelLabels	Describes the position relative to others in their organization.	"ManagementLevelLabels": ["C-Level"]
TitleCodes	A list of title codes.	"TitleCodes": ["(","3","K"]
TitleCodesLabels	A list of title codes labels.	"TitleCodesLabels": ["Partner","President","Human Resources"]
SecondarySicCodeIds	The secondary line of business represented by Standard Industrial Classification code.	"SecondarySicCodeIds": ["73"]
NAICSCode1	The primary line of business represented by a North American Industry Classification System code.	"NAICSCode1": ["44424012"]
NAICSCode2	The secondary line of business represented by North American Industry Classification System code.	"NAICSCode2": ["44424012"]
CorporateEmployeeCount	The actual, reported total number of employees at all locations in a corporate family.	"CorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
EstimatedCorporateEmployeeCount	Estimated total number of employees at all locations in a corporate family.	"EstimatedCorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
LocationEmployeeCount	The number of employees who work at this place.	"LocationEmployeeCount": { "minimum": 50, "maximum": 100 }
EstimatedLocationEmployeeCount	Estimated number of employees who work at this location.	"EstimatedLocationEmployeeCount": { "minimum": 50, "maximum": 100 }
LocationSalesVolume	An estimation of the place’s sales revenue.	"LocationSalesVolume": { "minimum": 50, "maximum": 5000000 }
ContactEmail	The email address of the contact.	"ContactEmail": ["info@melissa.com"]
ContactEmailDeliverableInd	The deliverability status of the email address.	"ContactEmailDeliverableInd": ["1","true","null"]
ContactEmailMarketableInd	The marketable status of the email address.	"ContactEmailMarketableInd": true
CBSACode	The core based statistical area where the place is located.	"CBSACode": ["31080"]
CBSALevel	Information on whether the CBSA is a micropolitan or metropolitan area.	"CBSALevel": ["2"]
CSACode	The combined statistical area code where the place is located.	"CSACode": ["348"]
ContactApider	The gender of the individual.	"ContactApider": ["F"]
ContactJobFunctionId	Describes the type of work an employee performs in their organization.	"ContactJobFunctionId": ["270"]
ContactJobTitles	Descriptive label of the individual’s job associated with the contact.	"ContactJobTitles": ["Owner"]
ContactJobTitlesCount	The total number of Job titles associated with the contact.	"ContactJobTitlesCount": ["1"]
ContactManagementLevel	Describes the contact’s position relative to others in their organization.	"ContactManagementLevel": ["manager"]
ContactProfessionalTitle	The professional degree or title of the individual.	"ContactProfessionalTitle": ["manager"]
ContactIndicator	Information on whether the individual is the primary contact for the location.	"ContactIndicator": ["true"]
ContactSuppressedFields	The fields on the individual that are suppressed.	"ContactSuppressedFields": ["email"]
ContactTitleCodes	A list of the individual’s job titles.	"ContactTitleCodes": ["5"]
Website	The primary homepage URL of the business.	"Website": ["melissa.com"]
WorkAtHome	The place is a work at home business.	"WorkAtHome": true
OpenedForBusinessOn	The date when the place opened for business.	"OpenedForBusinessOn": ["1996-05-11", "1996"]
EstimatedOpenedForBusiness	Range of the estimated date when the place opened for business.	"EstimatedOpenedForBusiness": { "minimum": "1998-01-01", "maximum": "1998-12-31" }
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"]
EstimatedCorporateSalesRevenue	Estimated total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]
PrimaryContactInd	The status of PrimaryContactInd	"PrimaryContactInd": [true]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
PrimarySICCodeId	The primary line of business represented by a Standard Industrial Classification code. NOTE: You can use the “all” keyword to query all SICCodes as well.	"PrimarySICCodeId": ["171102"] "PrimarySICCodeId": ["all"]
RBDI	An RBDI code.	"RBDI": "B"
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
Email	Email address.	"Email": ["contact@melissa.com"]
EmailDeliverableInd	The deliverability status of the email address.	"EmailDeliverableInd": ["1","true","null"]
EmailMarketableInd	The marketable status of the email address.	"EmailMarketableInd": true
JobTitles	Descriptive label of the individual’s job.	"JobTitles": ["Engineer"]
LanguagesSpoken	A list of the languages spoken.	"LanguagesSpoken": ["en","es"]
ManagementLevelLabels	Describes the position relative to others in their organization.	"ManagementLevelLabels": ["C-Level"]
SecondarySicCodeIds	The secondary line of business represented by Standard Industrial Classification code.	"SecondarySicCodeIds": ["73"]
NAICSCode1	The primary line of business represented by a North American Industry Classification System code.	"NAICSCode1": ["44424012"]
NAICSCode2	The secondary lines of business represented by North American Industry Classification System code.	"NAICSCode2": ["44424012"]
CorporateEmployeeCount	The actual, reported total number of employees at all locations in a corporate family.	"CorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
EstimatedCorporateEmployeeCount	Estimated total number of employees at all locations in a corporate family.	"EstimatedCorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
LocationEmployeeCount	The number of employees who work at this place.	"LocationEmployeeCount": { "minimum": 50, "maximum": 100 }
EstimatedLocationEmployeeCount	Estimated number of employees who work at this location.	"EstimatedLocationEmployeeCount": { "minimum": 50, "maximum": 100 }
LocationSalesVolume	An estimation of the place’s sales revenue.	"LocationSalesVolume": { "minimum": 50, "maximum": 5000000 }
ContactEmail	The email address of the contact.	"ContactEmail": ["info@melissa.com"]
ContactEmailDeliverableInd	The deliverability status of the email address.	"ContactEmailDeliverableInd": ["1","true","null"]
ContactEmailMarketableInd	The marketable status of the email address.	"ContactEmailMarketableInd": true
CBSACode	The core based statistical area where the place is located.	"CBSACode": ["31080"]
CBSALevel	Information on whether the CBSA is a micropolitan or metropolitan area.	"CBSALevel": ["2"]
CSACode	The combined statistical area code where the place is located.	"CSACode": ["348"]
ContactApider	The gender of the individual.	"ContactApider": ["F"]
ContactJobFunctionId	Describes the type of work an employee performs in their organization.	"ContactJobFunctionId": ["270"]
ContactJobTitles	Descriptive label of the individual’s job associated with the contact.	"ContactJobTitles": ["Owner"]
ContactJobTitlesCount	The total number of Job titles associated with the contact.	"ContactJobTitlesCount": ["1"]
ContactManagementLevel	Describes the contact’s position relative to others in their organization.	"ContactManagementLevel": ["manager"]
ContactProfessionalTitle	The professional degree or title of the individual.	"ContactProfessionalTitle": ["manager"]
ContactIndicator	Information on whether the individual is the primary contact for the location.	"ContactIndicator": ["true"]
ContactSuppressedFields	The fields on the individual that are suppressed.	"ContactSuppressedFields": ["email"]
ContactTitleCodes	A list of the individual’s job titles.	"ContactTitleCodes": ["5"]
Website	The primary homepage URL of the business.	"Website": ["melissa.com"]
WorkAtHome	The place is a work at home business.	"WorkAtHome": true
OpenedForBusinessOn	The date when the place opened for business.	"OpenedForBusinessOn": ["1996-05-11", "1996"]
EstimatedOpenedForBusiness	Range of the estimated date when the place opened for business.	"EstimatedOpenedForBusiness": { "minimum": "1998-01-01", "maximum": "1998-12-31" }
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"]
EstimatedCorporateSalesRevenue	Estimated total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]
PrimaryContactInd	The status of PrimaryContactInd	"PrimaryContactInd": [true]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access.	"Page": 1

Headers

• POST JSON

 Content-Type: application/json
 Accept: application/json

Response

• POST JSON

{
  "Count": 108,
  "Results": [
    {
      "MelissaAddressKey": 1406630346,
      "Name": "Cosmo's Italian Kitchen"
    },
    {
      "MelissaAddressKey": 1912776685,
      "Name": "The Stand"
    },
    {
      "MelissaAddressKey": 3129966465,
      "Name": "Ray's Pizza"
    },
  ],
  "Pagination": {
    "CurrentPage": 1,
    "NextPage": 0,
    "TotalPages": 1
  },
  "JobId": "returned_job_id",
  "ResultCode": "LS01"
}

Response Fields

Output Name	Description
Count	Number of records returned by the query.
Results	Returned records with requested Columns. 100 records per page.
Pagination	Paginated information. CurrentPage The current page number. NextPage The next page number. TotalPages The total number of pages available.
JobId	The JobId to be used to purchase and access the full dataset.
ResultCode	Success or Error codes based on the response/request.

/web/V1/Business/getCount

Introduction

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Try It Now

Note

Make sure to replace {{customerId}} with your License Key!

• POST JSON

curl -X POST "https://dataretriever.melissadata.net/web/V1/Business/getCount" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "CustomerID": "{{customerId}}",
      "Includes": {
        "Cities": [
          {"City": "Rancho Santa Margarita","State":"CA"},
          {"City": "Irvine","State":"CA"}
        ],
        "EmailDeliverableInd": ["true"],
        "RestaurantCuisines": ["pizza","burgers"]
      },
      "Columns": [
        "MelissaAddressKey",
        "Name"
      ],
      "OrderBy": [
        { "column": "MelissaAddressKey", "sortorder": "desc" }
      ]
}'

Request Parameters

• POST JSON

Code	Description
CustomerID	The License Key issued by Melissa.
Includes	Any parameter you would like to include in the query. At least one from the Required list.
Excludes (Optional)	Any parameter you would like to exclude in the query.
Columns	All Business Columns you want returned.
OrderBy (Optional)	Specify the desired column to order the responses by.

• POST JSON (Includes)

Code	Description	JSON
Zips (Required)	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities (Required)	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
Radius (Required)	A radius object containing a Latitude, Longitude, and Distance represented in miles.	"Radius": { "Latitude": 33.637654, "Longitude": -117.607075, "Distance": 2 }
ShapeWKTs (Required)	A list of polygon Shapes.	"ShapeWKTs": [ "POLYGON( (-117.63908729625203 33.54947105992495, -117.64000192952611 33.54939952783131, -117.6398195393131 33.548657378865364, -117.63903901648976 33.54871326379859, -117.63885394406773 33.548791502644384, -117.63875202012517 33.54936823252172, -117.63908729625203 33.54947105992495), (-117.63959372373107 33.54874903013689, -117.63959372373107 33.549088809612265, -117.63967687221053 33.549088809612265, -117.63967419000151 33.549370467901376, -117.63947034211638 33.54937270328092, -117.63936841817382 33.549048572638874, -117.63941133351805 33.54875126553252, -117.63959372373107 33.54874903013689) )" ]
PrimarySICCodeId (Required)	The primary line of business represented by a Standard Industrial Classification code. NOTE: You can use the “all” keyword to query all SICCodes as well.	"PrimarySICCodeId": ["171102"] "PrimarySICCodeId": ["all"]
RBDI	An RBDI code.	"RBDI": "B"
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
Email	Email address.	"Email": ["contact@melissa.com"]
EmailDeliverableInd	The deliverability status of the email address.	"EmailDeliverableInd": ["1","true","null"]
EmailMarketableInd	The marketable status of the email address.	"EmailMarketableInd": true
JobTitles	Descriptive label of the individual’s job.	"JobTitles": ["Engineer"]
LanguagesSpoken	A list of the languages spoken.	"LanguagesSpoken": ["en","es"]
ManagementLevelLabels	Describes the position relative to others in their organization.	"ManagementLevelLabels": ["C-Level"]
TitleCodes	A list of title codes.	"TitleCodes": ["(","3","K"]
TitleCodesLabels	A list of title codes labels.	"TitleCodesLabels": ["Partner","President","Human Resources"]
SecondarySicCodeIds	The secondary line of business represented by Standard Industrial Classification code.	"SecondarySicCodeIds": ["73"]
NAICSCode1	The primary line of business represented by a North American Industry Classification System code.	"NAICSCode1": ["44424012"]
NAICSCode2	The secondary line of business represented by North American Industry Classification System code.	"NAICSCode2": ["44424012"]
CorporateEmployeeCount	The actual, reported total number of employees at all locations in a corporate family.	"CorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
EstimatedCorporateEmployeeCount	Estimated total number of employees at all locations in a corporate family.	"EstimatedCorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
LocationEmployeeCount	The number of employees who work at this place.	"LocationEmployeeCount": { "minimum": 50, "maximum": 100 }
EstimatedLocationEmployeeCount	Estimated number of employees who work at this location.	"EstimatedLocationEmployeeCount": { "minimum": 50, "maximum": 100 }
LocationSalesVolume	An estimation of the place’s sales revenue.	"LocationSalesVolume": { "minimum": 50, "maximum": 5000000 }
ContactEmail	The email address of the contact.	"ContactEmail": ["info@melissa.com"]
ContactEmailDeliverableInd	The deliverability status of the email address.	"ContactEmailDeliverableInd": ["1","true","null"]
ContactEmailMarketableInd	The marketable status of the email address.	"ContactEmailMarketableInd": true
CBSACode	The core based statistical area where the place is located.	"CBSACode": ["31080"]
CBSALevel	Information on whether the CBSA is a micropolitan or metropolitan area.	"CBSALevel": ["2"]
CSACode	The combined statistical area code where the place is located.	"CSACode": ["348"]
ContactApider	The gender of the individual.	"ContactApider": ["F"]
ContactJobFunctionId	Describes the type of work an employee performs in their organization.	"ContactJobFunctionId": ["270"]
ContactJobTitles	Descriptive label of the individual’s job associated with the contact.	"ContactJobTitles": ["Owner"]
ContactJobTitlesCount	The total number of Job titles associated with the contact.	"ContactJobTitlesCount": ["1"]
ContactManagementLevel	Describes the contact’s position relative to others in their organization.	"ContactManagementLevel": ["manager"]
ContactProfessionalTitle	The professional degree or title of the individual.	"ContactProfessionalTitle": ["manager"]
ContactIndicator	Information on whether the individual is the primary contact for the location.	"ContactIndicator": ["true"]
ContactSuppressedFields	The fields on the individual that are suppressed.	"ContactSuppressedFields": ["email"]
ContactTitleCodes	A list of the individual’s job titles.	"ContactTitleCodes": ["5"]
Website	The primary homepage URL of the business.	"Website": ["melissa.com"]
WorkAtHome	The place is a work at home business.	"WorkAtHome": true
OpenedForBusinessOn	The date when the place opened for business.	"OpenedForBusinessOn": ["1996-05-11", "1996"]
EstimatedOpenedForBusiness	Range of the estimated date when the place opened for business.	"EstimatedOpenedForBusiness": { "minimum": "1998-01-01", "maximum": "1998-12-31" }
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"]
EstimatedCorporateSalesRevenue	Estimated total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]
PrimaryContactInd	The status of PrimaryContactInd	"PrimaryContactInd": [true]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of Zips objects containing Zip codes and optionally Plus4.	"Zips": [ {"Zip": "92688", "Plus4": "2122", "CarrierRoute": "C0123"} ]
Cities	A list of cities objects each containing City and State.	"Cities": [ {"City": "Rancho Santa Margarita", "State": "CA"} ]
PrimarySICCodeId	The primary line of business represented by a Standard Industrial Classification code. NOTE: You can use the “all” keyword to query all SICCodes as well.	"PrimarySICCodeId": ["171102"] "PrimarySICCodeId": ["all"]
RBDI	An RBDI code.	"RBDI": "B"
FIPSCode	A list of FIPS Codes.	"FIPSCode": ["12345"]
Email	Email address.	"Email": ["contact@melissa.com"]
EmailDeliverableInd	The deliverability status of the email address.	"EmailDeliverableInd": ["1","true","null"]
EmailMarketableInd	The marketable status of the email address.	"EmailMarketableInd": true
JobTitles	Descriptive label of the individual’s job.	"JobTitles": ["Engineer"]
LanguagesSpoken	A list of the languages spoken.	"LanguagesSpoken": ["en","es"]
ManagementLevelLabels	Describes the position relative to others in their organization.	"ManagementLevelLabels": ["C-Level"]
SecondarySicCodeIds	The secondary line of business represented by Standard Industrial Classification code.	"SecondarySicCodeIds": ["73"]
NAICSCode1	The primary line of business represented by a North American Industry Classification System code.	"NAICSCode1": ["44424012"]
NAICSCode2	The secondary lines of business represented by North American Industry Classification System code.	"NAICSCode2": ["44424012"]
CorporateEmployeeCount	The actual, reported total number of employees at all locations in a corporate family.	"CorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
EstimatedCorporateEmployeeCount	Estimated total number of employees at all locations in a corporate family.	"EstimatedCorporateEmployeeCount": { "minimum": 50, "maximum": 500 }
LocationEmployeeCount	The number of employees who work at this place.	"LocationEmployeeCount": { "minimum": 50, "maximum": 100 }
EstimatedLocationEmployeeCount	Estimated number of employees who work at this location.	"EstimatedLocationEmployeeCount": { "minimum": 50, "maximum": 100 }
LocationSalesVolume	An estimation of the place’s sales revenue.	"LocationSalesVolume": { "minimum": 50, "maximum": 5000000 }
ContactEmail	The email address of the contact.	"ContactEmail": ["info@melissa.com"]
ContactEmailDeliverableInd	The deliverability status of the email address.	"ContactEmailDeliverableInd": ["1","true","null"]
ContactEmailMarketableInd	The marketable status of the email address.	"ContactEmailMarketableInd": true
CBSACode	The core based statistical area where the place is located.	"CBSACode": ["31080"]
CBSALevel	Information on whether the CBSA is a micropolitan or metropolitan area.	"CBSALevel": ["2"]
CSACode	The combined statistical area code where the place is located.	"CSACode": ["348"]
ContactApider	The gender of the individual.	"ContactApider": ["F"]
ContactJobFunctionId	Describes the type of work an employee performs in their organization.	"ContactJobFunctionId": ["270"]
ContactJobTitles	Descriptive label of the individual’s job associated with the contact.	"ContactJobTitles": ["Owner"]
ContactJobTitlesCount	The total number of Job titles associated with the contact.	"ContactJobTitlesCount": ["1"]
ContactManagementLevel	Describes the contact’s position relative to others in their organization.	"ContactManagementLevel": ["manager"]
ContactProfessionalTitle	The professional degree or title of the individual.	"ContactProfessionalTitle": ["manager"]
ContactIndicator	Information on whether the individual is the primary contact for the location.	"ContactIndicator": ["true"]
ContactSuppressedFields	The fields on the individual that are suppressed.	"ContactSuppressedFields": ["email"]
ContactTitleCodes	A list of the individual’s job titles.	"ContactTitleCodes": ["5"]
Website	The primary homepage URL of the business.	"Website": ["melissa.com"]
WorkAtHome	The place is a work at home business.	"WorkAtHome": true
OpenedForBusinessOn	The date when the place opened for business.	"OpenedForBusinessOn": ["1996-05-11", "1996"]
EstimatedOpenedForBusiness	Range of the estimated date when the place opened for business.	"EstimatedOpenedForBusiness": { "minimum": "1998-01-01", "maximum": "1998-12-31" }
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"]
EstimatedCorporateSalesRevenue	Estimated total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]
PrimaryContactInd	The status of PrimaryContactInd	"PrimaryContactInd": [true]

Headers

• POST JSON

 Content-Type: application/json
 Accept: application/json

Response

• POST JSON

{
  "JobId": "returned_job_id",
  "Count": 108,
  "ResultCode": "LS01",
  "Sample": [
    {
      "MelissaAddressKey": 1912776685,
      "Name": "The Stand"
    },
    {
      "MelissaAddressKey": 2451836118,
      "Name": "Jack in the Box"
    },
    {
      "MelissaAddressKey": 3111765339,
      "Name": "Pieology Pizzeria"
    },
    {
      "MelissaAddressKey": 3129966465,
      "Name": "Ray's Pizza"
    }
  ]
}

Response Fields

Output Name	Description
JobId	The JobId to be used to purchase and access the full dataset.
Count	Number of records returned by the query.
ResultCode	Success or Error codes based on the response/request.
Sample	A 10 record sample response.

Download Controller

/web/v1/Download/StreamFile

Introduction

This endpoint is used after a GetCount or DoLookup job has been ran. It allows the user to download a large portion of the file at one (limited at 100,000 rows). Users can specify a limit to the download by using the optional parameter “Top”. NOTE: Top must be less than the cap off 100,000 records

Request Parameters

Code	Description
JobID	The job identifier returned from the GetCount/DoLookup endpoint.
CustomerID	The License Key issued by Melissa.
Product	Product name associated with the job (e.g., consumertwo).
top (Optional)	Optional row limit to stream (e.g., 200). If omitted, the full file is streamed (up to the cap of 100,000).

Input Best Practices

This service can deal with multiple languages and scripts. It expects UTF-8 encoding. Be on the lookout for question marks (?), squares (▖) or other unwanted characters like �. They may be an indication of encoding issues and may result in data loss. Bad encoding or character loss is not something our service can correct for you.

Result Codes

Result codes yield more granular information about a given request or if there are any errors while getting a response.

Note

The Service Level result codes apply to the service as a whole.

Code	Description
Transmission Service Error
SE01	The Cloud API experienced an internal error.
General Transmission Error
GE04	The License Key is empty.
GE05	The License Key is invalid.
GE06	The License Key is disabled.
LS - Data Retriever Status
LS01	Successfully returned response
LS02	Successfully returned, results is 0 or empty
LS03	Success - Not enough results to show sample
LE - Data Retriever Error
LE01	Error - Unable to doCount
LE02	Error - Unable to doLookup
LE03	Error - Could not create JobId
LE04	Error - Unable to handle MAK conditions
LE05	Error - There was a problem building select count query
LE06	Error - There was a problem building select record query
LE07	Error - There was a problem executing count query
LE08	Error - There was a problem inserting record into table
LE09	Error - There was a problem adding pagination to query
LE10	Error - Could not execute paginated result
LE11	Error - SQL query timed out
LE12	Error - Invalid page size for query (must be between 100 and 500)
LE13	Error - Data lookups do not currently support queries on both polygon and radius at the same time
LE14	Download Error - JobId does not belong to the requesting customer
LE15	Download Error - Requested row limit exceeds maximum allowed
LE16	Download Error - Top must be a positive integer
LE17	Error - Radius distance cannot exceed 50 miles
LE18	Error - Total shape area cannot exceed 8000 square miles