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

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

Get total record count of businesses

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(Business_Includes)required

Any parameter you would like to include in the query.

Requires at least one from:

  • Zips
  • Cities
  • Radius
  • ShapeWKTs
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.​RBDIArray of strings(RBDI)

An RBDI code.

Includes.​FIPSCodeArray of strings(FIPSCode)

A list of FIPSCodes.

Includes.​EmailArray of strings(Email)

Email.

Includes.​DeliverableEmailboolean(DeliverableEmail)

The deliverability status of the email address.

Includes.​MarketableEmailboolean(MarketableEmail)

The marketable status of the email address.

Includes.​JobTitleArray of strings(JobTitle)

Descriptive label of the individual's job.

Includes.​JobTitlesArray of strings(JobTitles)

Descriptive label of the individual's job.

Includes.​ManagementLevelLabelArray of strings(ManagementLevelLabel)

Describes the contact's position relative to others in their organization.

Includes.​ManagementLevelLabelsArray of strings(ManagementLevelLabels)

Describes the contact's position relative to others in their organization.

Includes.​SICCodeArray of strings(SICCode)

The primary line of business represented by a Standard Industrial Classification code.

Includes.​SecondarySICCodeArray of strings(SecondarySICCode)

The line of business represented by a Standard Industrial Classification code.

Includes.​NAICSCode1Array of strings(NAICSCode1)

The primary line of business represented by a North American Industry Classification System code.

Includes.​NAICSCode2Array of strings(NAICSCode2)

The lines of business represented by North American Industry Classification System codes.

Includes.​NumberCorporateEmployeesArray of strings(NumberCorporateEmployees)

The actual, reported total number of employees at all locations in a corporate family.

Includes.​EstNumberCorporateEmployeesArray of strings(EstNumberCorporateEmployees)

Estimates the total number of employees at all locations in a corporate family.

Includes.​NumberLocalEmployeesArray of strings(NumberLocalEmployees)

The number of employees who work at this place.

Includes.​EstNumberLocalEmployeesArray of strings(EstNumberLocalEmployees)

Estimates the number of employees who work at this location.

Includes.​LocSalesVolumeArray of strings(LocSalesVolume)

An estimation of the place's sales revenue.

Includes.​ContactEmailArray of strings(ContactEmail)

The email address of the contact.

Includes.​ContactDeliverableEmailboolean(ContactDeliverableEmail)

The deliverability status of the email address.

Includes.​ContactMarketableEmailboolean(ContactMarketableEmail)

The marketable status of the email address.

Includes.​CBSACodeArray of strings(CBSACode)

The core based statistical area where the place is located.

Includes.​CBSALevelArray of strings(CBSALevel)

Information on whether the CBSA is a micropolitan or metropolitan area.

Includes.​CSACodeArray of strings(CSACode)

The combined statistical area code where the place is located.

Includes.​ContactApiderArray of strings(ContactApider)

The gender of the individual.

Includes.​ContactJobFunctionIdArray of strings(ContactJobFunctionId)

Describes the type of work an employee performs in their organization.

Includes.​ContactJobTitlesArray of strings(ContactJobTitles)

Descriptive label of the individual's job.

Includes.​ContactJobTitlesCountArray of strings(ContactJobTitlesCount)

The total number of Job titles associated with the contact.

Includes.​ContactManagementLevelArray of strings(ContactManagementLevel)

Describes the contact's position relative to others in their organization.

Includes.​ContactProfessionalTitleArray of strings(ContactProfessionalTitle)

The professional degree or title of the individual.

Includes.​ContactIndicatorArray of strings(ContactIndicator)

Information on whether the individual is the primary contact for the location.

Includes.​ContactSuppressedFieldsArray of strings(ContactSuppressedFields)

The fields on the individual that are suppressed.

Includes.​ContactTitleCodesArray of strings(ContactTitleCodes)

A list of the individual's job titles.

Includes.​WebsiteArray of strings(Website)

The primary homepage URL of the business.

Includes.​WorkAtHomeboolean(WorkAtHome)

The place is a work at home business.

Includes.​OpenedForBusinessOnArray of strings(OpenedForBusinessOn)

The date when the place opened for business.

Includes.​EstimatedOpenedForBusinessLowerArray of strings(EstimatedOpenedForBusinessLower)

Estimated opened for business lower.

Includes.​EstimatedOpenedForBusinessUpperArray of strings(EstimatedOpenedForBusinessUpper)

Estimated opened for business upper.

Includes.​CorporateFranchisingboolean(CorporateFranchising)

Determine if the corporation includes franchised branches.

Includes.​CorporateSalesRevenueArray of strings(CorporateSalesRevenue)

The actual, reported sales revenue for the corporate family.

Includes.​EstimatedCorporateSalesRevenueArray of strings(EstimatedCorporateSalesRevenue)

Estimates total sales revenue for the corporate family.

Includes.​RestaurantCuisinesArray of strings(RestaurantCuisines)

The type of cuisine served at the place.

Excludesobject(Business_Excludes)

Any parameter you would like to exclude in the query.

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

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": 108, "JobId": "returned_job_id", "ResultCode": "LS01" }

Get a paginated result view of businesses

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(Business_Includes)required

Any parameter you would like to include in the query.

Requires at least one from:

  • Zips
  • Cities
  • Radius
  • ShapeWKTs
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.​RBDIArray of strings(RBDI)

An RBDI code.

Includes.​FIPSCodeArray of strings(FIPSCode)

A list of FIPSCodes.

Includes.​EmailArray of strings(Email)

Email.

Includes.​DeliverableEmailboolean(DeliverableEmail)

The deliverability status of the email address.

Includes.​MarketableEmailboolean(MarketableEmail)

The marketable status of the email address.

Includes.​JobTitleArray of strings(JobTitle)

Descriptive label of the individual's job.

Includes.​JobTitlesArray of strings(JobTitles)

Descriptive label of the individual's job.

Includes.​ManagementLevelLabelArray of strings(ManagementLevelLabel)

Describes the contact's position relative to others in their organization.

Includes.​ManagementLevelLabelsArray of strings(ManagementLevelLabels)

Describes the contact's position relative to others in their organization.

Includes.​SICCodeArray of strings(SICCode)

The primary line of business represented by a Standard Industrial Classification code.

Includes.​SecondarySICCodeArray of strings(SecondarySICCode)

The line of business represented by a Standard Industrial Classification code.

Includes.​NAICSCode1Array of strings(NAICSCode1)

The primary line of business represented by a North American Industry Classification System code.

Includes.​NAICSCode2Array of strings(NAICSCode2)

The lines of business represented by North American Industry Classification System codes.

Includes.​NumberCorporateEmployeesArray of strings(NumberCorporateEmployees)

The actual, reported total number of employees at all locations in a corporate family.

Includes.​EstNumberCorporateEmployeesArray of strings(EstNumberCorporateEmployees)

Estimates the total number of employees at all locations in a corporate family.

Includes.​NumberLocalEmployeesArray of strings(NumberLocalEmployees)

The number of employees who work at this place.

Includes.​EstNumberLocalEmployeesArray of strings(EstNumberLocalEmployees)

Estimates the number of employees who work at this location.

Includes.​LocSalesVolumeArray of strings(LocSalesVolume)

An estimation of the place's sales revenue.

Includes.​ContactEmailArray of strings(ContactEmail)

The email address of the contact.

Includes.​ContactDeliverableEmailboolean(ContactDeliverableEmail)

The deliverability status of the email address.

Includes.​ContactMarketableEmailboolean(ContactMarketableEmail)

The marketable status of the email address.

Includes.​CBSACodeArray of strings(CBSACode)

The core based statistical area where the place is located.

Includes.​CBSALevelArray of strings(CBSALevel)

Information on whether the CBSA is a micropolitan or metropolitan area.

Includes.​CSACodeArray of strings(CSACode)

The combined statistical area code where the place is located.

Includes.​ContactApiderArray of strings(ContactApider)

The gender of the individual.

Includes.​ContactJobFunctionIdArray of strings(ContactJobFunctionId)

Describes the type of work an employee performs in their organization.

Includes.​ContactJobTitlesArray of strings(ContactJobTitles)

Descriptive label of the individual's job.

Includes.​ContactJobTitlesCountArray of strings(ContactJobTitlesCount)

The total number of Job titles associated with the contact.

Includes.​ContactManagementLevelArray of strings(ContactManagementLevel)

Describes the contact's position relative to others in their organization.

Includes.​ContactProfessionalTitleArray of strings(ContactProfessionalTitle)

The professional degree or title of the individual.

Includes.​ContactIndicatorArray of strings(ContactIndicator)

Information on whether the individual is the primary contact for the location.

Includes.​ContactSuppressedFieldsArray of strings(ContactSuppressedFields)

The fields on the individual that are suppressed.

Includes.​ContactTitleCodesArray of strings(ContactTitleCodes)

A list of the individual's job titles.

Includes.​WebsiteArray of strings(Website)

The primary homepage URL of the business.

Includes.​WorkAtHomeboolean(WorkAtHome)

The place is a work at home business.

Includes.​OpenedForBusinessOnArray of strings(OpenedForBusinessOn)

The date when the place opened for business.

Includes.​EstimatedOpenedForBusinessLowerArray of strings(EstimatedOpenedForBusinessLower)

Estimated opened for business lower.

Includes.​EstimatedOpenedForBusinessUpperArray of strings(EstimatedOpenedForBusinessUpper)

Estimated opened for business upper.

Includes.​CorporateFranchisingboolean(CorporateFranchising)

Determine if the corporation includes franchised branches.

Includes.​CorporateSalesRevenueArray of strings(CorporateSalesRevenue)

The actual, reported sales revenue for the corporate family.

Includes.​EstimatedCorporateSalesRevenueArray of strings(EstimatedCorporateSalesRevenue)

Estimates total sales revenue for the corporate family.

Includes.​RestaurantCuisinesArray of strings(RestaurantCuisines)

The type of cuisine served at the place.

Excludesobject(Business_Excludes)

Any parameter you would like to exclude in the query.

ColumnsArray of strings(Business_Columns)required

All Business Columns you want returned.

Items Enum"MelissaAddressKey""BaseMelissaAddressKey""Name""AddressLine""Suite""City""State""ZIPCode""Plus4""DeliveryPoint"
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/Business/doLookup \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "Includes": {
      "Cities": [
        {
          "City": "Rancho Santa Margarita",
          "State": "CA"
        },
        {
          "City": "Irvine",
          "State": "CA"
        }
      ],
      "DeliverableEmail": true,
      "RestaurantCuisines": [
        "pizza",
        "burgers"
      ]
    },
    "Columns": [
      "MelissaAddressKey",
      "Name"
    ],
    "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": 108, "Results": [ {}, {} ], "Pagination": { "CurrentPage": 1, "NextPage": 0, "TotalPages": 1 }, "JobId": "returned_job_id", "ResultCode": "LS01" }

Get record count and sample of businesses

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(Business_Includes)required

Any parameter you would like to include in the query.

Requires at least one from:

  • Zips
  • Cities
  • Radius
  • ShapeWKTs
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.​RBDIArray of strings(RBDI)

An RBDI code.

Includes.​FIPSCodeArray of strings(FIPSCode)

A list of FIPSCodes.

Includes.​EmailArray of strings(Email)

Email.

Includes.​DeliverableEmailboolean(DeliverableEmail)

The deliverability status of the email address.

Includes.​MarketableEmailboolean(MarketableEmail)

The marketable status of the email address.

Includes.​JobTitleArray of strings(JobTitle)

Descriptive label of the individual's job.

Includes.​JobTitlesArray of strings(JobTitles)

Descriptive label of the individual's job.

Includes.​ManagementLevelLabelArray of strings(ManagementLevelLabel)

Describes the contact's position relative to others in their organization.

Includes.​ManagementLevelLabelsArray of strings(ManagementLevelLabels)

Describes the contact's position relative to others in their organization.

Includes.​SICCodeArray of strings(SICCode)

The primary line of business represented by a Standard Industrial Classification code.

Includes.​SecondarySICCodeArray of strings(SecondarySICCode)

The line of business represented by a Standard Industrial Classification code.

Includes.​NAICSCode1Array of strings(NAICSCode1)

The primary line of business represented by a North American Industry Classification System code.

Includes.​NAICSCode2Array of strings(NAICSCode2)

The lines of business represented by North American Industry Classification System codes.

Includes.​NumberCorporateEmployeesArray of strings(NumberCorporateEmployees)

The actual, reported total number of employees at all locations in a corporate family.

Includes.​EstNumberCorporateEmployeesArray of strings(EstNumberCorporateEmployees)

Estimates the total number of employees at all locations in a corporate family.

Includes.​NumberLocalEmployeesArray of strings(NumberLocalEmployees)

The number of employees who work at this place.

Includes.​EstNumberLocalEmployeesArray of strings(EstNumberLocalEmployees)

Estimates the number of employees who work at this location.

Includes.​LocSalesVolumeArray of strings(LocSalesVolume)

An estimation of the place's sales revenue.

Includes.​ContactEmailArray of strings(ContactEmail)

The email address of the contact.

Includes.​ContactDeliverableEmailboolean(ContactDeliverableEmail)

The deliverability status of the email address.

Includes.​ContactMarketableEmailboolean(ContactMarketableEmail)

The marketable status of the email address.

Includes.​CBSACodeArray of strings(CBSACode)

The core based statistical area where the place is located.

Includes.​CBSALevelArray of strings(CBSALevel)

Information on whether the CBSA is a micropolitan or metropolitan area.

Includes.​CSACodeArray of strings(CSACode)

The combined statistical area code where the place is located.

Includes.​ContactApiderArray of strings(ContactApider)

The gender of the individual.

Includes.​ContactJobFunctionIdArray of strings(ContactJobFunctionId)

Describes the type of work an employee performs in their organization.

Includes.​ContactJobTitlesArray of strings(ContactJobTitles)

Descriptive label of the individual's job.

Includes.​ContactJobTitlesCountArray of strings(ContactJobTitlesCount)

The total number of Job titles associated with the contact.

Includes.​ContactManagementLevelArray of strings(ContactManagementLevel)

Describes the contact's position relative to others in their organization.

Includes.​ContactProfessionalTitleArray of strings(ContactProfessionalTitle)

The professional degree or title of the individual.

Includes.​ContactIndicatorArray of strings(ContactIndicator)

Information on whether the individual is the primary contact for the location.

Includes.​ContactSuppressedFieldsArray of strings(ContactSuppressedFields)

The fields on the individual that are suppressed.

Includes.​ContactTitleCodesArray of strings(ContactTitleCodes)

A list of the individual's job titles.

Includes.​WebsiteArray of strings(Website)

The primary homepage URL of the business.

Includes.​WorkAtHomeboolean(WorkAtHome)

The place is a work at home business.

Includes.​OpenedForBusinessOnArray of strings(OpenedForBusinessOn)

The date when the place opened for business.

Includes.​EstimatedOpenedForBusinessLowerArray of strings(EstimatedOpenedForBusinessLower)

Estimated opened for business lower.

Includes.​EstimatedOpenedForBusinessUpperArray of strings(EstimatedOpenedForBusinessUpper)

Estimated opened for business upper.

Includes.​CorporateFranchisingboolean(CorporateFranchising)

Determine if the corporation includes franchised branches.

Includes.​CorporateSalesRevenueArray of strings(CorporateSalesRevenue)

The actual, reported sales revenue for the corporate family.

Includes.​EstimatedCorporateSalesRevenueArray of strings(EstimatedCorporateSalesRevenue)

Estimates total sales revenue for the corporate family.

Includes.​RestaurantCuisinesArray of strings(RestaurantCuisines)

The type of cuisine served at the place.

Excludesobject(Business_Excludes)

Any parameter you would like to exclude in the query.

ColumnsArray of strings(Business_Columns)required

All Business Columns you want returned.

Items Enum"MelissaAddressKey""BaseMelissaAddressKey""Name""AddressLine""Suite""City""State""ZIPCode""Plus4""DeliveryPoint"
curl -i -X POST \
  https://dataretriever.melissadata.net/web/V1/Business/getCount \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "Includes": {
      "Cities": [
        {
          "City": "Rancho Santa Margarita",
          "State": "CA"
        },
        {
          "City": "Irvine",
          "State": "CA"
        }
      ],
      "DeliverableEmail": true,
      "RestaurantCuisines": [
        "pizza",
        "burgers"
      ]
    },
    "Columns": [
      "MelissaAddressKey",
      "Name"
    ]
  }'

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": 108, "ResultCode": "LS01", "Sample": [ {}, {} ] }