Skip to content

Data Retriever

Overview

The Data Retriever Cloud API allows you to generate, download, and access lists of contacts, addresses, businesses, and more.

Data Retriever offers the following capabilities:

  • Retrieve a count of results based on provided filters, including City/State, Radius, Zip code, and polygon Shape.
  • Purchase a complete result set, navigate through the list of contacts and addresses using pagination.

Documentation

Useful Resources

Product Page

Support Center

Download OpenAPI description
Languages
Servers
Data Retriever Server
https://dataretriever.melissadata.net/web/V1/

MAK

Use this endpoint to retrieve lists of addresses.

Operations

NewMovers

Use this endpoint to retrieve lists of new movers.

Operations

Get total record count of new movers

Request

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.

Bodyapplication/jsonrequired
CustomerIDstring(CustomerID)required

The License Key issued by Melissa.

Includesobject(NewMovers_Includes)required

Any parameter you would like to include in the query.

Requires at least one from:

  • CensusKey
  • Zips
  • Cities
  • Radius
  • ShapeWKTs
Includes.​CensusKeyArray of strings(CensusKey)

A list of CensusKeys.

Includes.​ZipsArray of objects(Zips)

A list of Zips objects containing Zip codes and optionally Plus4.

Includes.​CitiesArray of objects(Cities)

A list of cities objects each containing City and State.

Includes.​Radiusobject(Radius)

A Radius object containing a Latitude, Longitude, and Distance represented in miles.

Includes.​ShapeWKTsArray of strings(wkt)(ShapeWKTs)

A list of WKT polygon strings

Includes.​MelissaAddressKeyArray of strings(MelissaAddressKey)

A list of Melissa address keys.

Includes.​BaseMelissaAddressKeyArray of strings(BaseMelissaAddressKey)

A list of BaseMelissaAddressKeys.

Includes.​FullNameArray of strings(FullName)

A list of FullNames.

Includes.​FirstNameArray of strings(FirstName)

A list of FirstNames.

Includes.​MiddleNameArray of strings(MiddleName)

A list of MiddleNames.

Includes.​LastNameArray of strings(LastName)

A list of LastNames.

Includes.​RBDIArray of strings(RBDI)

An RBDI code.

Includes.​AddressLinesArray of strings(AddressLines)

A list of Address Lines.

Includes.​StateArray of strings(State)

A list of States.

Includes.​Plus4Array of strings(Plus4)

A list of Plus4s.

Includes.​AddressKeyArray of strings(AddressKey)

A list of AddressKeys.

Includes.​ResultCodesArray of strings(ResultCodes)

A list of ResultCodes.

Includes.​LatitudeArray of strings(Latitude)

A list of Latitudes.

Includes.​LongitudeArray of strings(Longitude)

A list of Longitudes.

Includes.​PreviousMelissaAddressKeyArray of strings(PreviousMelissaAddressKey)

A list of PreviousMelissaAddressKeys.

Includes.​PreviousBaseMelissaAddressKeyArray of strings(PreviousBaseMelissaAddressKey)

A list of PreviousBaseMelissaAddressKeys.

Includes.​PreviousAddressLineArray of strings(PreviousAddressLine)

A list of PreviousAddressLines.

Includes.​PreviousSuiteArray of strings(PreviousSuite)

A list of PreviousSuites.

Includes.​PreviousCitiesArray of strings(PreviousCities)

A list of PreviousCities.

Includes.​PreviousCountyNameArray of strings(PreviousCountyName)

A list of PreviousCountyNames.

Includes.​PreviousStateArray of strings(PreviousState)

A list of PreviousStates.

Includes.​PreviousZIPCodeArray of strings(PreviousZIPCode)

A list of PreviousZIPCodes.

Includes.​PreviousAddressKeyArray of strings(PreviousAddressKey)

A list of PreviousAddressKeys.

Includes.​PreviousPlus4Array of strings(PreviousPlus4)

A list of PreviousPlus4s.

Includes.​PreviousResultCodesArray of strings(PreviousResultCodes)

A list of PreviousResultCodes.

Includes.​PreviousLatitudeArray of strings(PreviousLatitude)

A list of PreviousLatitudes.

Includes.​PreviousLongitudeArray of strings(PreviousLongitude)

A list of PreviousLongitudes.

Includes.​PhoneNumberArray of strings(PhoneNumber)

A list of PhoneNumbers.

Includes.​MoveEffectiveDateobject(MoveEffectiveDate)

A date range with start and end dates.

Includes.​EstimatedHouseholdIncomeCodeArray of strings(EstimatedHouseholdIncomeCode)

A list of EstimatedHouseholdIncomeCodes.

Includes.​AgeOfHouseholdCodeArray of strings(AgeOfHouseholdCode)

A list of AgeOfHouseholdCodes.

Includes.​EstimatedHousingValueCodeArray of strings(EstimatedHousingValueCode)

A list of EstimatedHousingValueCodes.

Includes.​HomeownershipCodeArray of strings(HomeownershipCode)

A list of HomeownershipCodes.

Includes.​PresenceOfChildrenCodeArray of strings(PresenceOfChildrenCode)

A list of PresenceOfChildrenCodes.

Includes.​DwellingCodeNormalArray of strings(DwellingCodeNormal)

A list of DwellingCodeNormals.

Includes.​DwellingSpecificCodeArray of strings(DwellingSpecificCode)

A list of DwellingSpecificCodes.

Includes.​MoveDistanceCodeArray of strings(MoveDistanceCode)

A list of MoveDistanceCodes.

Includes.​ConstructionTypeCodeArray of strings(ConstructionTypeCode)

A list of ConstructionTypeCodes.

Excludesobject(NewMovers_Excludes)

Any parameter you would like to exclude in the query.

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

Responses

Successful response

Bodyapplication/json
Countinteger

Number of records returned by the query.

JobIdstring

The JobId to be used to purchase and access the full dataset.

ResultCodestring

Success or Error codes based on the response/request.

Response
application/json
{ "Count": 370, "JobId": "returned_job_id", "ResultCode": "LS01" }

Get a paginated result view of new movers

Request

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.

Bodyapplication/jsonrequired
CustomerIDstring(CustomerID)required

The License Key issued by Melissa.

Includesobject(NewMovers_Includes)required

Any parameter you would like to include in the query.

Requires at least one from:

  • CensusKey
  • Zips
  • Cities
  • Radius
  • ShapeWKTs
Includes.​CensusKeyArray of strings(CensusKey)

A list of CensusKeys.

Includes.​ZipsArray of objects(Zips)

A list of Zips objects containing Zip codes and optionally Plus4.

Includes.​CitiesArray of objects(Cities)

A list of cities objects each containing City and State.

Includes.​Radiusobject(Radius)

A Radius object containing a Latitude, Longitude, and Distance represented in miles.

Includes.​ShapeWKTsArray of strings(wkt)(ShapeWKTs)

A list of WKT polygon strings

Includes.​MelissaAddressKeyArray of strings(MelissaAddressKey)

A list of Melissa address keys.

Includes.​BaseMelissaAddressKeyArray of strings(BaseMelissaAddressKey)

A list of BaseMelissaAddressKeys.

Includes.​FullNameArray of strings(FullName)

A list of FullNames.

Includes.​FirstNameArray of strings(FirstName)

A list of FirstNames.

Includes.​MiddleNameArray of strings(MiddleName)

A list of MiddleNames.

Includes.​LastNameArray of strings(LastName)

A list of LastNames.

Includes.​RBDIArray of strings(RBDI)

An RBDI code.

Includes.​AddressLinesArray of strings(AddressLines)

A list of Address Lines.

Includes.​StateArray of strings(State)

A list of States.

Includes.​Plus4Array of strings(Plus4)

A list of Plus4s.

Includes.​AddressKeyArray of strings(AddressKey)

A list of AddressKeys.

Includes.​ResultCodesArray of strings(ResultCodes)

A list of ResultCodes.

Includes.​LatitudeArray of strings(Latitude)

A list of Latitudes.

Includes.​LongitudeArray of strings(Longitude)

A list of Longitudes.

Includes.​PreviousMelissaAddressKeyArray of strings(PreviousMelissaAddressKey)

A list of PreviousMelissaAddressKeys.

Includes.​PreviousBaseMelissaAddressKeyArray of strings(PreviousBaseMelissaAddressKey)

A list of PreviousBaseMelissaAddressKeys.

Includes.​PreviousAddressLineArray of strings(PreviousAddressLine)

A list of PreviousAddressLines.

Includes.​PreviousSuiteArray of strings(PreviousSuite)

A list of PreviousSuites.

Includes.​PreviousCitiesArray of strings(PreviousCities)

A list of PreviousCities.

Includes.​PreviousCountyNameArray of strings(PreviousCountyName)

A list of PreviousCountyNames.

Includes.​PreviousStateArray of strings(PreviousState)

A list of PreviousStates.

Includes.​PreviousZIPCodeArray of strings(PreviousZIPCode)

A list of PreviousZIPCodes.

Includes.​PreviousAddressKeyArray of strings(PreviousAddressKey)

A list of PreviousAddressKeys.

Includes.​PreviousPlus4Array of strings(PreviousPlus4)

A list of PreviousPlus4s.

Includes.​PreviousResultCodesArray of strings(PreviousResultCodes)

A list of PreviousResultCodes.

Includes.​PreviousLatitudeArray of strings(PreviousLatitude)

A list of PreviousLatitudes.

Includes.​PreviousLongitudeArray of strings(PreviousLongitude)

A list of PreviousLongitudes.

Includes.​PhoneNumberArray of strings(PhoneNumber)

A list of PhoneNumbers.

Includes.​MoveEffectiveDateobject(MoveEffectiveDate)

A date range with start and end dates.

Includes.​EstimatedHouseholdIncomeCodeArray of strings(EstimatedHouseholdIncomeCode)

A list of EstimatedHouseholdIncomeCodes.

Includes.​AgeOfHouseholdCodeArray of strings(AgeOfHouseholdCode)

A list of AgeOfHouseholdCodes.

Includes.​EstimatedHousingValueCodeArray of strings(EstimatedHousingValueCode)

A list of EstimatedHousingValueCodes.

Includes.​HomeownershipCodeArray of strings(HomeownershipCode)

A list of HomeownershipCodes.

Includes.​PresenceOfChildrenCodeArray of strings(PresenceOfChildrenCode)

A list of PresenceOfChildrenCodes.

Includes.​DwellingCodeNormalArray of strings(DwellingCodeNormal)

A list of DwellingCodeNormals.

Includes.​DwellingSpecificCodeArray of strings(DwellingSpecificCode)

A list of DwellingSpecificCodes.

Includes.​MoveDistanceCodeArray of strings(MoveDistanceCode)

A list of MoveDistanceCodes.

Includes.​ConstructionTypeCodeArray of strings(ConstructionTypeCode)

A list of ConstructionTypeCodes.

Excludesobject(NewMovers_Excludes)

Any parameter you would like to exclude in the query.

ColumnsArray of strings(NewMovers_Columns)required

All NewMovers Columns you want returned.

Items Enum"MelissaAddressKey""BaseMelissaAddressKey""FullName""FirstName""MiddleName""LastName""AddressLine""City""State""ZIPCode"
Paginationobject(Pagination)required

Specify the desired page in the results to access. Pages are based on 100 records per page.

Pagination.​Pageinteger
curl -i -X POST \
  https://dataretriever.melissadata.net/web/V1/NewMovers/doLookup \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "Includes": {
      "Zips": [
        {
          "Zip": "92688"
        }
      ],
      "MoveEffectiveDate": {
        "StartDate": "2023/01/01",
        "EndDate": "2024/01/01"
      }
    },
    "Columns": [
      "MelissaAddressKey",
      "AddressLine",
      "PreviousAddressLine"
    ],
    "Pagination": {
      "Page": 1
    }
  }'

Responses

Successful response

Bodyapplication/json
Countinteger

Number of records returned by the query.

ResultsArray of objects

Returned records with requested Columns.

Paginationobject

The current page number and the next page number.

JobIdstring

The JobId to be used to purchase and access the full dataset.

ResultCodestring

Success or Error codes based on the response/request.

Response
application/json
{ "Count": 370, "Results": [ {}, {} ], "Pagination": { "CurrentPage": 1, "NextPage": 2, "TotalPages": 3 }, "JobId": "returned_job_id", "ResultCode": "LS01" }

Get record count and sample of new movers

Request

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.

Bodyapplication/jsonrequired
CustomerIDstring(CustomerID)required

The License Key issued by Melissa.

Includesobject(NewMovers_Includes)required

Any parameter you would like to include in the query.

Requires at least one from:

  • CensusKey
  • Zips
  • Cities
  • Radius
  • ShapeWKTs
Includes.​CensusKeyArray of strings(CensusKey)

A list of CensusKeys.

Includes.​ZipsArray of objects(Zips)

A list of Zips objects containing Zip codes and optionally Plus4.

Includes.​CitiesArray of objects(Cities)

A list of cities objects each containing City and State.

Includes.​Radiusobject(Radius)

A Radius object containing a Latitude, Longitude, and Distance represented in miles.

Includes.​ShapeWKTsArray of strings(wkt)(ShapeWKTs)

A list of WKT polygon strings

Includes.​MelissaAddressKeyArray of strings(MelissaAddressKey)

A list of Melissa address keys.

Includes.​BaseMelissaAddressKeyArray of strings(BaseMelissaAddressKey)

A list of BaseMelissaAddressKeys.

Includes.​FullNameArray of strings(FullName)

A list of FullNames.

Includes.​FirstNameArray of strings(FirstName)

A list of FirstNames.

Includes.​MiddleNameArray of strings(MiddleName)

A list of MiddleNames.

Includes.​LastNameArray of strings(LastName)

A list of LastNames.

Includes.​RBDIArray of strings(RBDI)

An RBDI code.

Includes.​AddressLinesArray of strings(AddressLines)

A list of Address Lines.

Includes.​StateArray of strings(State)

A list of States.

Includes.​Plus4Array of strings(Plus4)

A list of Plus4s.

Includes.​AddressKeyArray of strings(AddressKey)

A list of AddressKeys.

Includes.​ResultCodesArray of strings(ResultCodes)

A list of ResultCodes.

Includes.​LatitudeArray of strings(Latitude)

A list of Latitudes.

Includes.​LongitudeArray of strings(Longitude)

A list of Longitudes.

Includes.​PreviousMelissaAddressKeyArray of strings(PreviousMelissaAddressKey)

A list of PreviousMelissaAddressKeys.

Includes.​PreviousBaseMelissaAddressKeyArray of strings(PreviousBaseMelissaAddressKey)

A list of PreviousBaseMelissaAddressKeys.

Includes.​PreviousAddressLineArray of strings(PreviousAddressLine)

A list of PreviousAddressLines.

Includes.​PreviousSuiteArray of strings(PreviousSuite)

A list of PreviousSuites.

Includes.​PreviousCitiesArray of strings(PreviousCities)

A list of PreviousCities.

Includes.​PreviousCountyNameArray of strings(PreviousCountyName)

A list of PreviousCountyNames.

Includes.​PreviousStateArray of strings(PreviousState)

A list of PreviousStates.

Includes.​PreviousZIPCodeArray of strings(PreviousZIPCode)

A list of PreviousZIPCodes.

Includes.​PreviousAddressKeyArray of strings(PreviousAddressKey)

A list of PreviousAddressKeys.

Includes.​PreviousPlus4Array of strings(PreviousPlus4)

A list of PreviousPlus4s.

Includes.​PreviousResultCodesArray of strings(PreviousResultCodes)

A list of PreviousResultCodes.

Includes.​PreviousLatitudeArray of strings(PreviousLatitude)

A list of PreviousLatitudes.

Includes.​PreviousLongitudeArray of strings(PreviousLongitude)

A list of PreviousLongitudes.

Includes.​PhoneNumberArray of strings(PhoneNumber)

A list of PhoneNumbers.

Includes.​MoveEffectiveDateobject(MoveEffectiveDate)

A date range with start and end dates.

Includes.​EstimatedHouseholdIncomeCodeArray of strings(EstimatedHouseholdIncomeCode)

A list of EstimatedHouseholdIncomeCodes.

Includes.​AgeOfHouseholdCodeArray of strings(AgeOfHouseholdCode)

A list of AgeOfHouseholdCodes.

Includes.​EstimatedHousingValueCodeArray of strings(EstimatedHousingValueCode)

A list of EstimatedHousingValueCodes.

Includes.​HomeownershipCodeArray of strings(HomeownershipCode)

A list of HomeownershipCodes.

Includes.​PresenceOfChildrenCodeArray of strings(PresenceOfChildrenCode)

A list of PresenceOfChildrenCodes.

Includes.​DwellingCodeNormalArray of strings(DwellingCodeNormal)

A list of DwellingCodeNormals.

Includes.​DwellingSpecificCodeArray of strings(DwellingSpecificCode)

A list of DwellingSpecificCodes.

Includes.​MoveDistanceCodeArray of strings(MoveDistanceCode)

A list of MoveDistanceCodes.

Includes.​ConstructionTypeCodeArray of strings(ConstructionTypeCode)

A list of ConstructionTypeCodes.

Excludesobject(NewMovers_Excludes)

Any parameter you would like to exclude in the query.

ColumnsArray of strings(NewMovers_Columns)required

All NewMovers Columns you want returned.

Items Enum"MelissaAddressKey""BaseMelissaAddressKey""FullName""FirstName""MiddleName""LastName""AddressLine""City""State""ZIPCode"
curl -i -X POST \
  https://dataretriever.melissadata.net/web/V1/NewMovers/getCount \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "Includes": {
      "Zips": [
        {
          "Zip": "92688"
        }
      ],
      "MoveEffectiveDate": {
        "StartDate": "2023/01/01",
        "EndDate": "2024/01/01"
      }
    },
    "Columns": [
      "MelissaAddressKey",
      "AddressLine",
      "PreviousAddressLine"
    ]
  }'

Responses

Successful response

Bodyapplication/json
JobIdstring

The JobId to be used to purchase and access the full dataset.

Countinteger

Number of records returned by the query.

ResultCodestring

Success or Error codes based on the response/request.

SampleArray of objects

A 10 record sample response.

Response
application/json
{ "JobId": "returned_job_id", "Count": 370, "ResultCode": "LS01", "Sample": [ {}, {} ] }

NewHomeowners

Use this endpoint to retrieve lists of new homeowners.

Operations

Consumer

Use this endpoint to retrieve lists of consumers.

Operations

Consumer Two

Use this endpoint to retrieve lists of consumers.

Operations

Business

Use this endpoint to retrieve lists of businesses.

Operations