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 Api Cloud APIs

Base URL

https://datagen.melissadata.net

Licensing

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

Products

MAK

All MAK endpoints use the following buyable columns:

MAK
MelissaAddressKey
BaseMelissaAddressKey
AddressLine
Suite
Urbanization
City
State
AddressKey
BaseRecord
ResultCodes
AddressStreetNumber
AddressDirectionPrefix
AddressStreetName
AddressStreetSuffix
AddressDirectionSuffix
AddressSuiteName
AddressSuiteNumber
AddressType
RBDI
CommercialMailReceivingAgency
County
CongressionalDistrict
CarrierRoute
CityAbbreviation
FIPSCode
Vacant
NeighborhoodName
ApartmentName
NonUSPS
PlaceCode
Latitude
Longitude
GeoLevel
CensusKey
CensusKeyDecennial
ElevationInMeters

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/MAK/doCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "Status":"string",
     "ResultCode":"string"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/MAK/doLookup\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}, "pagination": {"page": 1}'

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 columns you want returned.
Pagination (optional)	Specify the desired page in the results to access. Pages are based on 100 records per page. Defaults to 1 if not included.

• POST JSON (Includes)

Code	Description	JSON
Zips (required)	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access; defaults to 1 if not included	"page": 1

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Results":"string (JSON Datatable)",
     "Pagination": {
       "Page":"int",
       "NextPage":"int"
     }
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/MAK/getCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Sample":"string (JSON Datatable)"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

NewMovers

All NewMovers Endpoints use the following buyable columns:

NewMovers
MelissaAddressKey
BaseMelissaAddressKey
FullName
FirstName
MiddleName
LastName
AddressLine
City
State
ZIPCode
Plus4
AddressKey
ResultCodes
Latitude
Longitude
CensusKey
PreviousMelissaAddressKey
PreviousBaseMelissaAddressKey
PreviousAddressLine
PreviousSuite
PreviousCity
PreviousState
PreviousZIPCode
PreviousPlus4
PreviousAddressKey
PreviousResultCodes
PreviousLatitude
PreviousLongitude
PhoneNumber
MoveEffectiveDate
EstimatedHouseholdIncomeCode
AgeOfHouseholdCode
EstimatedHousingValueCode
HomeOwnershipCode
PresenceOfChildrenCode
DwellingSpecificCode
MoveDistanceCode

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/NewMovers/doCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 columns you want returned.

• POST JSON (Includes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
HomeownershipCode	A list of HomeownershipCodes.	"HomeownershipCode": ["AX"]
PhoneNumber	A list of PhoneNumbers.	"PhoneNumber": ["1234567890"]
DwellingCodeNormal	A list of DwellingCodeNormals.	"DwellingCodeNormal": ["AX"]
ConstructionTypeCode	A list of ConstructionTypeCodes.	"ConstructionTypeCode": ["B"]
AgeOfHouseholdCode	A list of AgeOfHouseholdCodes.	"AgeOfHouseholdCode": ["B"]
CensusKey (required)	A list of CensusKeys.	"CensusKey": ["1234"]
MoveEffectiveDate	A date range with start and end dates	“MoveEffectiveDate”: {“startdate”: “2023/01/01”, “enddate”: “2024/01/01”}

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
HomeownershipCode	A list of HomeownershipCodes.	"HomeownershipCode": ["AX"]
PhoneNumber	A list of PhoneNumbers.	"PhoneNumber": ["1234567890"]
DwellingCodeNormal	A list of DwellingCodeNormals.	"DwellingCodeNormal": ["AX"]
ConstructionTypeCode	A list of ConstructionTypeCodes.	"ConstructionTypeCode": ["B"]
AgeOfHouseholdCode	A list of AgeOfHouseholdCodes.	"AgeOfHouseholdCode": ["B"]
CensusKey (required)	A list of CensusKeys.	"CensusKey": ["1234"]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "Status":"string",
     "ResultCode":"string"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/NewMovers/doLookup\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}, "pagination": {"page": 1}'

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 columns you want returned.
Pagination (optional)	Specify the desired page in the results to access. Pages are based on 100 records per page. Defaults to 1 if not included.

• POST JSON (Includes)

Code	Description	JSON
Zips (required)	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
HomeownershipCode	A list of HomeownershipCodes.	"HomeownershipCode": ["AX"]
PhoneNumber	A list of PhoneNumbers.	"PhoneNumber": ["1234567890"]
DwellingCodeNormal	A list of DwellingCodeNormals.	"DwellingCodeNormal": ["AX"]
ConstructionTypeCode	A list of ConstructionTypeCodes.	"ConstructionTypeCode": ["B"]
AgeOfHouseholdCode	A list of AgeOfHouseholdCodes.	"AgeOfHouseholdCode": ["B"]
CensusKey (required)	A list of CensusKeys.	"CensusKey": ["1234"]
MoveEffectiveDate	A date range with start and end dates	"MoveEffectiveDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
HomeownershipCode	A list of HomeownershipCodes.	"HomeownershipCode": ["AX"]
PhoneNumber	A list of PhoneNumbers.	"PhoneNumber": ["1234567890"]
DwellingCodeNormal	A list of DwellingCodeNormals.	"DwellingCodeNormal": ["AX"]
ConstructionTypeCode	A list of ConstructionTypeCodes.	"ConstructionTypeCode": ["B"]
AgeOfHouseholdCode	A list of AgeOfHouseholdCodes.	"AgeOfHouseholdCode": ["B"]
CensusKey (required)	A list of CensusKeys.	"CensusKey": ["1234"]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access; defaults to 1 if not included	"page": 1

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Results":"string (JSON Datatable)",
     "Pagination": {
       "Page":"int",
       "NextPage":"int"
     }
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/NewMovers/getCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
HomeownershipCode	A list of HomeownershipCodes.	"HomeownershipCode": ["AX"]
PhoneNumber	A list of PhoneNumbers.	"PhoneNumber": ["1234567890"]
DwellingCodeNormal	A list of DwellingCodeNormals.	"DwellingCodeNormal": ["AX"]
ConstructionTypeCode	A list of ConstructionTypeCodes.	"ConstructionTypeCode": ["B"]
AgeOfHouseholdCode	A list of AgeOfHouseholdCodes.	"AgeOfHouseholdCode": ["B"]
CensusKey (required)	A list of CensusKeys.	"CensusKey": ["1234"]
MoveEffectiveDate	A date range with start and end dates	"MoveEffectiveDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
AddressLines	A list of Address Lines.	"AddressLines": ["123 Main St"]
HomeownershipCode	A list of HomeownershipCodes.	"HomeownershipCode": ["AX"]
PhoneNumber	A list of PhoneNumbers.	"PhoneNumber": ["1234567890"]
DwellingCodeNormal	A list of DwellingCodeNormals.	"DwellingCodeNormal": ["AX"]
ConstructionTypeCode	A list of ConstructionTypeCodes.	"ConstructionTypeCode": ["B"]
AgeOfHouseholdCode	A list of AgeOfHouseholdCodes.	"AgeOfHouseholdCode": ["B"]
CensusKey (required)	A list of CensusKeys.	"CensusKey": ["1234"]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Sample":"string (JSON Datatable)"
     }
   ]
 }

Record Level 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:

NewHomeowners
MelissaAddressKey
BaseMelissaAddressKey
FirstName
LastName
AddressLine
City
State
ZIPCode
Plus4
DeliveryPoint
AddressKey
CarrierRoute
FIPSCode
PlaceCode
Latitude
Longitude
CensusKey
PhoneNumber
PurchasePrice
SellDate
Lender
TransactionType
PublishedDate
CondoCode
MortgageAmount
RateType
LoanType

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/NewHomeowners/doCount
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
Address	A list of Addresses.	"Address": ["123 Main St"]
CondoCode	A list of CondoCodes.	"CondoCode": ["B"]
FirstName	A list of FirstNames.	"FirstName": ["Joe"]
Street	A list of Streets.	"Street": ["Main St"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
PurchasePrice	A Range of PurchasePrices	"PurchasePrice": { "minimum": 0, "maximum": 400 }
PublishedDate	A date range with start and end dates	"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
Address	A list of Addresses.	"Address": ["123 Main St"]
CondoCode	A list of CondoCodes.	"CondoCode": ["B"]
FirstName	A list of FirstNames.	"FirstName": ["Joe"]
Street	A list of Streets.	"Street": ["Main St"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
PurchasePrice	A Range of PurchasePrices	"PurchasePrice": { "minimum": 0, "maximum": 400 }
PublishedDate	A date range with start and end dates	"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "Status":"string",
     "ResultCode":"string"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/NewHomeowners/doLookup\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}, "pagination": {"page": 1}'

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 columns you want returned.
Pagination (optional)	Specify the desired page in the results to access. Pages are based on 100 records per page. Defaults to 1 if not included.

• POST JSON (Includes)

Code	Description	JSON
Zips (required)	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
Address	A list of Addresses.	"Address": ["123 Main St"]
CondoCode	A list of CondoCodes.	"CondoCode": ["B"]
FirstName	A list of FirstNames.	"FirstName": ["Joe"]
Street	A list of AgeOfHouseholdCodes.	"Street": ["Main St"]
FIPSCode	A list of AgeOfHouseholdCodes.	"FIPSCode": ["12345"]
PurchasePrice	A list of AgeOfHouseholdCodes.	"PurchasePrice": { "minimum": 0, "maximum": 400 }
PublishedDate	A date range with start and end dates	"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
Address	A list of Addresses.	"Address": ["123 Main St"]
CondoCode	A list of CondoCodes.	"CondoCode": ["B"]
FirstName	A list of FirstNames.	"FirstName": ["Joe"]
Street	A list of AgeOfHouseholdCodes.	"Street": ["Main St"]
FIPSCode	A list of AgeOfHouseholdCodes.	"FIPSCode": ["12345"]
PurchasePrice	A list of AgeOfHouseholdCodes.	"PurchasePrice": { "minimum": 0, "maximum": 400 }
PublishedDate	A date range with start and end dates	"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access; defaults to 1 if not included	"page": 1

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Results":"string (JSON Datatable)",
     "Pagination": {
       "Page":"int",
       "NextPage":"int"
     }
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/NewHomeowners/getCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
   "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
Address	A list of Addresses.	"Address": ["123 Main St"]
CondoCode	A list of CondoCodes.	"CondoCode": ["B"]
FirstName	A list of FirstNames.	"FirstName": ["Joe"]
Street	A list of AgeOfHouseholdCodes.	"Street": ["Main St"]
FIPSCode	A list of AgeOfHouseholdCodes.	"FIPSCode": ["12345"]
PurchasePrice	A list of AgeOfHouseholdCodes.	"PurchasePrice": { "minimum": 0, "maximum": 400 }
PublishedDate	A date range with start and end dates	"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
Address	A list of Addresses.	"Address": ["123 Main St"]
CondoCode	A list of CondoCodes.	"CondoCode": ["B"]
FirstName	A list of FirstNames.	"FirstName": ["Joe"]
Street	A list of AgeOfHouseholdCodes.	"Street": ["Main St"]
FIPSCode	A list of AgeOfHouseholdCodes.	"FIPSCode": ["12345"]
PurchasePrice	A list of AgeOfHouseholdCodes.	"PurchasePrice": { "minimum": 0, "maximum": 400 }
PublishedDate	A date range with start and end dates	"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Sample":"string (JSON Datatable)"
     }
   ]
 }

Record Level 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 One

All Consumer endpoints have the following buyable columns:

Consumer
MelissaAddressKey
BaseMelissaAddressKey
TitlePrefixInd
FirstName
MiddleNameInitial
LastName
FullName
NameSuffix
AddressLine
Suite
City
State
ZIPCode
Plus4
DeliveryPoint
AddressKey
ResultCodes
AddressStreetNumber
AddressDirectionPrefix
AddressStreetName
AddressStreetSuffix
AddressDirectionSuffix
AddressSuiteName
AddressSuiteNumber
AddressTypeInd
AddressType
RBDI
WalkSequencenumber
CarrierRoute
FIPSCode
FIPSMCDCode
PlaceCode
Latitude
Longitude
CensusKey
CBSACode
OccupationCode1
ApiderCode
ContactAgeGroup
BirthYear1
BirthMonth1
BirthDay1
Apider1
PoliticalPartyCode1
EducationCode1
PhoneNumber
PhonePresenceInd
Email
EmailResultLevel
eMailAppendAvailableInd
AgeLessthan1Ind
Age1Ind
Age2Ind
Age3Ind
Age4Ind
Age5Ind
Age6Ind
Age7Ind
Age8Ind
Age9Ind
Age10Ind
Age11Ind
Age12Ind
Age13Ind
Age14Ind
Age15Ind
Age16Ind
Age17Ind
Age18Ind
SupportsChildrensInd
NumberOfChildrenCode
PresenceOfChildrenInd
NumberOfAdultsCode
HouseholdSizeCode
EstimatedHomeMarketValueCode
HomeOwnerRenterCode
IncomeEstimatedHousehold
HouseholdAgeCode
Age0to2MaleInd
Age0to2FemaleInd
Age0to2UnknownApiderInd
Age3to5MaleInd
Age3to5FemaleInd
Age3to5UnknownApiderInd
Age6to10MaleInd
Age6to10FemaleInd
Age6to10UnknownApiderInd
Age11to15MaleInd
Age11to15FemaleInd
Age11to15UnknownApiderInd
Age16to17MaleInd
Age16to17FemaleInd
Age16to17UnknownApiderInd
Age18to24MaleInd
Age18to24FeMaleInd
Age18to24UnknownApiderInd
Age25to34MaleInd
Age25to34FeMaleInd
Age25to34UnknownApiderInd
Age35to44MaleInd
Age35to44FeMaleInd
Age35to44UnknownApiderInd
Age45to54MaleInd
Age45to54FeMaleInd
Age45to54UnknownApiderInd
Age55to64MaleInd
Age55to64FeMaleInd
Age55to64UnknownApiderInd
Age65to74MaleInd
Age65to74FeMaleInd
Age65to74UnknownApiderInd
Age75MaleInd
Age75FeMaleInd
Age75UnknownApiderInd
YoungAdultinHouseholdInd
ApierationsInHouseholdCount
SeniorAdultInHouseholdInd
HomeLengthofResidenceCode
CensusMedianHomeValue
CensusMedianHouseholdIncome
DwellingTypeCode
AdvantageDwellingTypeInd
HomeYearBuiltCode
HomePropertyTypeCode
HomePurchaseDate
NewToBuildIndicator
HomeLotSquareFootageRangesCode
HomePurchaseAmountRangesCode
HomePropertyTypeDetailCode
HomeLTVEstimatedRangesCode
HomeLTVEstimatedActualCode
MailOrderDonorInd
LotCarrierlineOfTravelCode
FileDate
CompanyId
IndividualId
ConfidenceUseCode
SupportsCharitableInd
SupportsAnimalWelfareInd
SupportsArtsOrCulturalInd
SupportsEnvironmentOrWildlifeInd
SupportsHealthInd
SupportsInternationalAidInd
SupportsPoliticalInd
SupportsPoliticalConservativeInd
SupportsPoliticalLiberalInd
SupportsReligiousInd
SupportsVeteransInd
AfricanAmericanProfessionals
BusinessOwnerCode
SingleParentInd
VeteranInd
OccupationDetailInputIndividualCode
InferredHouseholdRankCode
VehicleNewUsedInd1
VehicleNewUsedInd2
GreenLivingInd
AgeinTwoYearIncrInputIndReseller
SmallOfficeHouseholdInd
TruckOwnerInd
InvestmentPropertiesOwnedEstimated
NetWorthCode
WorkingWomanInd
BankCardHolderInd
GasDepartmentRetailCardHolderInd
TravelAndEntCardHolderInd
CreditCardHolderUnknownTypeInd
PremiumCardHolderInd
UpscaleDeptStoreCardHolderInd
OccupationInputIndividualCode
InfoBasePositiveMatchInd
OverallMatchInd
OwnerRenterCode
CatOwnerInd
DogOwnerInd
OtherPetOnwerInd
MaritalStatus
MailOrderResponderInd
SupportsOtherInd
CongressionalDistrictCode
MotorcycleOwnerInd
RecreationalVehicleInd
PoliticalPartyInputIndividualCode
BaseRecordVerificationDate
NumberofSources
VehicleNewCarBuyer
VehicleKnownOwnedNumber
VehicleDominantLifestyleCode
CreditCardUserInd
CRAIncomeClassificationCode
EducationInputIndividualCount
CollegeGraduateInd
PrecisionLevelCode
WirelessProductBuyerInd
FashionInd
HistoyMilitaryInd
CelebritiesInd
CurrentAffairsPoliticsInd
TheaterPerformingArtsInd
CommunityCharitiesInd
ReligiousInspirationalInd
ScienceSpaceInd
StrangeandUnusualInd
CareerImprovementInd
ArtsInd
ReadingApieralInd
ReadingBestSellersInd
ReadingReligiousInspirationalInd
ReadingScienceFictionInd
ReadingMagazinesInd
ReadingAudioBooksInd
CookingApieralInd
CookingGourmetInd
CookingLowFatInd
FoodsVegetarianInd
FoodsNaturalInd
TravelDomesticInd
TravelInternationalInd
RecreationalVehiclesInd
TravelFamilyVacationsInd
TravelCruiseVacationsInd
ExerciseRunningJoggingInd
ExerciseWalkingInd
ExerciseAerobicInd
CraftsInd
PhotographyInd
AviationInd
AutoWorkInd
SewingKnittingNeedleworkInd
WoodWorkingInd
GamesBoardGamesPuzzlesInd
MusicHomeStereoInd
MusicPlayerInd
MusicCollectorInd
MusicAvidListenerInd
MovieCollectorInd
TVCableInd
GamesVideoGamesInd
MoviesatHomeInd
TVSatelliteDishInd
DietingWeightLossInd
SelfImprovementInd
HousePlantsInd
ParentingInd
ChildrensInterestsInd
GrandChildrenInd
SpectatorSportsRacingInd
SpectatorSportsFootballInd

/web/V1/ConsumerOne/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/ConsumerOne/doCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "Status":"string",
     "ResultCode":"string"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request

/web/V1/ConsumerOne/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/ConsumerOne/doLookup\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}, "pagination": {"page": 1}'

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 columns you want returned.
Pagination (optional)	Specify the desired page in the results to access. Pages are based on 100 records per page. Defaults to 1 if not included.

• POST JSON (Includes)

Code	Description	JSON
Zips (required)	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access; defaults to 1 if not included	"page": 1

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Results":"string (JSON Datatable)",
     "Pagination": {
       "Page":"int",
       "NextPage":"int"
     }
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

/web/V1/ConsumerOne/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/ConsumerOne/getCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Sample":"string (JSON Datatable)"
     }
   ]
 }

Record Level 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:

ConsumerTwo
MelissaAddressKey
BaseMelissaAddressKey
FirstName1
MiddleNameInitial1
LastName
NameSuffix1
AddressLine
City
State
ZIPCode
Plus4
DeliveryPoint
AddressKey
ResultCodes
AddressStreetNumber
AddressStreetName
AddressSuiteNumber
AddressType
RBDI
CarrierRoute
FIPSCode
FIPSCountyCode
RouteDesignatorAndNumber
BoxDesignatorAndNumber
AddressQualityCode
SeasonalDeliveryCode
DeliveryTypeCode
AddressNameCensorCode
PlaceCode
Latitude
Longitude
CensusKey
CensusTractBlockGroup2010
FIPSStateCode2010
FIPSCountyCode2010
CBSACode
Apider1
Age1
BirthYear1
BirthMonth1
TitleCode1
PhoneNumberAreaCode
PhoneNumber
FullPhoneNumber
LandlinePhoneAreaCode
LandlinePhoneNumber
PhoneType
CellPhoneNumber1
CellPhoneNumber2
CellPhoneNumber3
CellPhoneNumber4
SecondaryCellPhoneAreaCode1
SecondaryCellPhoneNumber1
SecondaryCellPhoneAreaCode2
SecondaryCellPhoneNumber2
SecondaryCellPhoneAreaCode3
SecondaryCellPhoneNumber3
SecondaryCellPhoneAreaCode4
SecondaryCellPhoneNumber4
Email
EmailResultLevel
Age0to2Code
Age3to5Code
Age6to10Code
Age11to15Code
Age16to17Code
Age18to24Code
Age25to34Code
Age35to44Code
Age45to54Code
Age55to64Code
Age65to74Code
Age75PlusCode
AgeUnknownCode
Under35Ind
Age35to44Ind
Age45to64Ind
Age65PlusInd
NumberOfPersonsinHousehold
NumberOfAdultsinHousehold
AdvantageNumberOfAdultsInd
NumberOfChildreninHousehold
PresenceOfChildren
PresenceOfChildrenInd
TargetNetWorth
HouseholdsMedianHouseholdIncome
HouseholdAgeCode
HouseholdTypeCode
AdvantageHouseholdAgeInd
AdvantageHouseholdSizeInd
HouseholdVerificationDate
Occupation
MaritalStatusCode
LengthOfResidence
AdvantageLengthOfResidenceInd
AdvantageHomeOwnerInd
AdvantageHouseholdMaritalStatusInd
EstimatedHomeIncomePredictor
AdvantageHouseholdIncomeIdentifierInd
FamiliesPercentHouseholdIwthOwnChildren
PopulationPercentWhiteAlone
AvailableHomeEquityInThousands
AvgVehiclesPerOccupiedUnit
DwellingType
AdvantageDwellingTypeInd
HomeOwnerRenterCode
MedianValueOwnerOccupiedHousingUnits
YearHomeBuilt
LivingAreaSquareFootageRange
LotCode
HomeSaleDate
HomeSalePriceinThousands
HomeMarketValueTaxRecord
MortgageDate
OriginalMortgageAmount
FirstMortgageAmountInThousands
SecondMortgageAmountinThousands
MortgageLoantypeorRefinance
MortgageInterestRateorRefinance
MortgageInterestRateTypeorRefinance
RefinanceInd
HomeEquityLoanDate
HomeEquityLoaninThousands
HomeEquityLoanInd
TargetHomeMarketValueOrig
TargetHomeMarketValue
TargetHomeMarketValueType
HousingUnitsPercentOwnerOccupied
HousingUnitsPercentOneUnitDetached
HousingUnitsPercentBuilt2000To2004
HousingUnitsPercentBuilt2005OrLater
TypeOfCreditCardAmericanExpress
TypeOfCreditCardAnyCreditCard
CreditCardUsageBankCard
TypeOfCreditCardCatalogShowroom
TypeOfCreditCardComputerElectronic
TypeOfCreditCardDebitCard
CreditCardUsageFinanceCoCard
TypeOfCreditCardFurniture
TypeOfCreditCardGrocery
TypeOfCreditCardHomeImprovement
TypeOfCreditCardHomeOfficeSupply
TypeOfCreditCardLowEndDepartmentStore
TypeOfCreditCardMainStreetRetail
TypeOfCreditCardMastercard
TypeOfCreditCardMembershipWarehouse
CreditCardUsageMiscellaneous
CreditCardUsageOilGasCard
TypeOfCreditCardSpecialtyApparel
TypeOfCreditCardSportingGoods
CreditCardUsageStandardRetail
CreditCardUsageStandardSpecialtyCard
CreditCardUsageTravelEntertainment
TypeOfCreditCardTVMailOrder
CreditCardUsageUpscaleRetail
CreditCardUsageUpscaleSpecRetail
TypeOfCreditCardVisa
StatusCodeOfRecords
FileCode
Fraction
PostOfficeName
Niches2
MailResponsiveBuyerInd
FirstName2
MiddleNameInitial2
Apider2
Age2
BirthYear2
BirthMonth2
TitleCode2
FirstName3
MiddleNameInitial3
Apider3
Age3
BirthYear3
BirthMonth3
FirstName4
MiddleNameInitial4
Apider4
Age4
BirthYear4
BirthMonth4
FirstName5
MiddleNameInitial5
Apider5
Age5
BirthYear5
BirthMonth5

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/ConsumerTwo/doCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "Status":"string",
     "ResultCode":"string"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/ConsumerTwo/doLookup\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}, "pagination": {"page": 1}'

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 columns you want returned.
Pagination (optional)	Specify the desired page in the results to access. Pages are based on 100 records per page. Defaults to 1 if not included.

• POST JSON (Includes)

Code	Description	JSON
Zips (required)	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access; defaults to 1 if not included	"page": 1

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Results":"string (JSON Datatable)",
     "Pagination": {
       "Page":"int",
       "NextPage":"int"
     }
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

/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!

• POST JSON

 curl -X POST https://datagen.melissadata.net/web/V1/ConsumerTwo/getCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"RBDI": ["B"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
AddressStreetName	A list of address street name objects	"addressstreetname": [ {"zip": "12345", "streetname": "6789"}} ]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Sample":"string (JSON Datatable)"
     }
   ]
 }

Record Level 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 fields:

Business
MelissaAddressKey
BaseMelissaAddressKey
Name
AddressLine
Suite
City
State
ZIPCode
Plus4
DeliveryPoint
AddressKey
ResultCodes
AddressStreetNumber
AddressDirectionPrefix
AddressStreetName
AddressStreetSuffix
AddressDirectionSuffix
AddressSuiteName
AddressSuiteNumber
AddressTypeCode
CarrierRoute
FIPSCode
CMRAInd
AddressChangedDate
LandmarkAddress
MailingMelissaAddresskey
MailingBaseMelissaAddresskey
MailingAddressLine
MailingAddressSuite
MailingAddressCity
MailingAddressState
MailingAddressZIPCode
MailingAddressPlus4
MailingDeliveryPoint
MailingAddressKey
MailingResultCodes
MailingAddressStreetNumber
MailingAddressDirectionPrefix
MailingAddressStreetName
MailingAddressStreetSuffix
MailingAddressDirectionSuffix
MailingAddressSuiteName
MailingAddressSuiteNumber
MailingAddressTypeCode
MailingAddressCarrierRoute
MailingAddressFIPSCode
MailingAddressCMRAInd
PrimarySICCodeId
SecondarySicCodeIds
NAICSCode1
NAICSCode2
ContactFirstName
ContactLastName
PhoneNumber
TollFreeNumber
PhoneNumber2
FaxNumber
CorporateEmployeeCount
EstimatedCorporateEmployeeCount
LocationEmployeeCount
EstimatedLocationEmployeeCount
LocationSalesVolume
ContactEmail
ContactEmailDeliverableInd
ContactEmailMarketableInd
Latitude
Longitude
Censuskey
CensusBlock
CensusTract
SgcDivision
CBSACode
CBSALevel
CSACode
MailingLatitude
MailingLongitude
MailingCensusKey
ContactId
ContactApider
ContactJobFunctionId
ContactJobTitles
ContactJobTitlesCount
ContactManagementLevel
ContactProfessionalTitle
ContactIndicator
ContactSuppressedFields
ContactTitleCodes
Website
FacebookURL
TwitterUrl
LinkedInURL
YelpUrl
PinterestUrl
YoutubeUrl
TumblrUrl
FoursquareUrl
InstagramUrl
LogoUrl
WebsiteKeywords
LocationProfessionalSizeCode
PlaceType
AlternativeName
HistoricalNames
LegalNames
BusinessID
WorkAtHome
InBusiness
VerifiedOn
DuplicateOf
Suppressed
SuppressedFields
CreatedAt
UpdatedAt
OpenedForBusinessOn
EstimatedOpenedForBusinessLower
EstimatedOpenedForBusinessUpper
LocationParentId
LocationParentRelationship
NumberOfTenants
BusinessTypeIdsLabels
ContactsCount
OwnershipChangedOn
HeadquartersId
AncestorHeadquartersIds
AncestorHeadquartersIdsCount
UltimateHeadquartersId
ChainIdLabels
CorporateFranchising
CorporateSalesRevenue
EstimatedCorporateSalesRevenue
BranchCount
ForeignParentInd
FortuneRanking
StockExchangeCode
CtockTickerSymbol
TheCentralIndexKey
AffiliationIdsLabels
BrandIdsLabels
CompanyDescription
DressCode
EquipmentRentals
HasEcommerce
LanguagesSpoken
PriceRange
ProfessionalSpecialty
PublicAccess
ShoppingCenterAtm
OperatingHoursCount
PaymentTypes
InsurancesAccepted
MedicareAccepted
MedicaidAccepted
ServiceAreaPostalCodes
NbrcCorporationFilingType
NbrcCorporateDate
CarMakeIdsLabels
ReligiousDenominationIdsLabels
RestaurantCuisines
RestaurantLimitedService
RestaurantReservations
RestaurantTakeout
HappyHoursCount
HotelCableTV
HotelContinentalBreakfast
HotelElevator
HotelExerciseFacility
HotelGuestLaundry
HotelHotTub
HotelIndoorPool
HotelKitchens
HotelOutdoorPool
HotelPetFriendly
HotelRoomService
HospitalHasEmergencyRoom
EstimatedFleetSizeLower
EstimatedFleetSizeUpper
GrowingBusinessGode
SquareFootage
WhiteCollarPercentage
PopulationDensity
PopulationCodeForZIP
WealthyAreaInd
PhysicianYearOfGraduation
MedicalSchoolCode
HospitalNumber
Upin
LicenseNumber
StateOfLicense
PhysicianYearOfBirth
ResidencyHospitalCode
ResidencyGraduationYear
NationalProviderID
MedicalDeaNumber
AcceptingNewPatientsIndicator
PhysicianPrimarySpecialtyCode
PhysicianSecondarySpecialtyCode
BoardCertifiedInd
BusinessID
FirstName
LastName
Apider
Email
EmailDeliverableInd
EmailMarketableInd
JobTitles
JobTitlesCount
ManagementLevelLabels
TitleCodes
TitleCodesLabels
JobFunctionId
LabelsJobFunctionId
ProfessionalTitle
LabelsProfessionalTitle
PrimaryContactInd

/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!

• POST JSON

 curl -X POST http://dataapi.melissadata.net/web/V1/business/doCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"rbdis": "B"
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
Email	Email	"Email": ["johndoe@gmail.com"]
DeliverableEmail	The deliverability status of the email address.	"DeliverableEmail": true
MarketableEmail	The marketable status of the email address.	"MarketableEmail": false
JobTitle	Descriptive label of the individual’s job	"JobTitle": ["president"]
ManagementLevelLabel	Describes the contact’s position relative to others in their organization.	"ManagementLevelLabel": ["board of directors"]
SICCode	The primary line of business represented by a Standard Industrial Classification code.	"SICCode": ["171102"]
SecondarySICCode	The lines of business represented by Standard Industrial Classification codes.	"SecondarySicCode": ["171102"]
NAICSCode1	The primary line of business represented by a Standard Industrial Classification code.	"NAICSCode1": ["44424012"]
NAICSCode2	The lines of business represented by North American Industry Classification System codes	"NAICSCode2": ["44424012"]
NumberCorporateEmployees	The actual, reported total number of employees at all locations in a corporate family.	"NumberCorporateEmployees": ["12200"]
EstNumberCorporateEmployees	Estimates the total number of employees at all locations in a corporate family.	"EstNumberCorporateEmployees": ["12200"]
NumberLocalEmployees	The number of employees who work at this place.	"NumberLocalEmployees": ["12200"]
EstNumberLocalEmployees	Estimates the number of employees who work at this location.	"EstNumberLocalEmployees": ["12200"]
LocSalesVolume	An estimation of the place’s sales revenue.	"LocSalesVolume": ["6476000"]
ContactDeliverableEmail	The deliverability status of the email address.	"ContactDeliverableEmail": true
ContactMarketableEmail	The marketable status of the email address.	"ContactMarketableEmail": 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	"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": [".org"]
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"]
EstimatedOpenedForBusinessLower	Estimated opened for business lower	"EstimatedOpenedForBusinessLower": [ "1996"]
EstimatedOpenedForBusinessUpper	Estimated opened for business upper	"EstimatedOpenedForBusinessUpper": [ "1996"]
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"],
EstimatedCorporateSalesRevenue	Estimates total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"rbdis": "B"
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
Email	Email	"Email": ["johndoe@gmail.com"]
DeliverableEmail	The deliverability status of the email address.	"DeliverableEmail": true
MarketableEmail	The marketable status of the email address.	"MarketableEmail": false
JobTitle	Descriptive label of the individual’s job	"JobTitle": ["president"]
ManagementLevelLabel	Describes the contact’s position relative to others in their organization.	"ManagementLevelLabel": ["board of directors"]
SICCode	The primary line of business represented by a Standard Industrial Classification code.	"SICCode": ["171102"]
SecondarySICCode	The lines of business represented by Standard Industrial Classification codes.	"SecondarySicCode": ["171102"]
NAICSCode1	The primary line of business represented by a Standard Industrial Classification code.	"NAICSCode1": ["44424012"]
NAICSCode2	The lines of business represented by North American Industry Classification System codes	"NAICSCode2": ["44424012"]
NumberCorporateEmployees	The actual, reported total number of employees at all locations in a corporate family.	"NumberCorporateEmployees": ["12200"]
EstNumberCorporateEmployees	Estimates the total number of employees at all locations in a corporate family.	"EstNumberCorporateEmployees": ["12200"]
NumberLocalEmployees	The number of employees who work at this place.	"NumberLocalEmployees": ["12200"]
EstNumberLocalEmployees	Estimates the number of employees who work at this location.	"EstNumberLocalEmployees": ["12200"]
LocSalesVolume	An estimation of the place’s sales revenue.	"LocSalesVolume": ["6476000"]
ContactDeliverableEmail	The deliverability status of the email address.	"ContactDeliverableEmail": true
ContactMarketableEmail	The marketable status of the email address.	"ContactMarketableEmail": 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	"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": [".org"]
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"]
EstimatedOpenedForBusinessLower	Estimated opened for business lower	"EstimatedOpenedForBusinessLower": [ "1996"]
EstimatedOpenedForBusinessUpper	Estimated opened for business upper	"EstimatedOpenedForBusinessUpper": [ "1996"]
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"],
EstimatedCorporateSalesRevenue	Estimates total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "Status":"string",
     "ResultCode":"string"
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
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!

• POST JSON

 curl -X POST http://dataapi.melissadata.net/web/V1/business/doLookup\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}, "pagination": {"page": 1}'

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 columns you want returned.
Pagination (optional)	Specify the desired page in the results to access. Pages are based on 100 records per page. Defaults to 1 if not included.

• POST JSON (Includes)

Code	Description	JSON
Zips (required)	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"rbdis": "B"
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
Email	Email	"Email": ["johndoe@gmail.com"]
DeliverableEmail	The deliverability status of the email address.	"DeliverableEmail": true
MarketableEmail	The marketable status of the email address.	"MarketableEmail": false
JobTitle	Descriptive label of the individual’s job	"JobTitle": ["president"]
ManagementLevelLabel	Describes the contact’s position relative to others in their organization.	"ManagementLevelLabel": ["board of directors"]
SICCode	The primary line of business represented by a Standard Industrial Classification code.	"SICCode": ["171102"]
SecondarySICCode	The lines of business represented by Standard Industrial Classification codes.	"SecondarySicCode": ["171102"]
NAICSCode1	The primary line of business represented by a Standard Industrial Classification code.	"NAICSCode1": ["44424012"]
NAICSCode2	The lines of business represented by North American Industry Classification System codes	"NAICSCode2": ["44424012"]
NumberCorporateEmployees	The actual, reported total number of employees at all locations in a corporate family.	"NumberCorporateEmployees": ["12200"]
EstNumberCorporateEmployees	Estimates the total number of employees at all locations in a corporate family.	"EstNumberCorporateEmployees": ["12200"]
NumberLocalEmployees	The number of employees who work at this place.	"NumberLocalEmployees": ["12200"]
EstNumberLocalEmployees	Estimates the number of employees who work at this location.	"EstNumberLocalEmployees": ["12200"]
LocSalesVolume	An estimation of the place’s sales revenue.	"LocSalesVolume": ["6476000"]
ContactDeliverableEmail	The deliverability status of the email address.	"ContactDeliverableEmail": true
ContactMarketableEmail	The marketable status of the email address.	"ContactMarketableEmail": 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	"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": [".org"]
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"]
EstimatedOpenedForBusinessLower	Estimated opened for business lower	"EstimatedOpenedForBusinessLower": [ "1996"]
EstimatedOpenedForBusinessUpper	Estimated opened for business upper	"EstimatedOpenedForBusinessUpper": [ "1996"]
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"],
EstimatedCorporateSalesRevenue	Estimates total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"rbdis": "B"
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
Email	Email	"Email": ["johndoe@gmail.com"]
DeliverableEmail	The deliverability status of the email address.	"DeliverableEmail": true
MarketableEmail	The marketable status of the email address.	"MarketableEmail": false
JobTitle	Descriptive label of the individual’s job	"JobTitle": ["president"]
ManagementLevelLabel	Describes the contact’s position relative to others in their organization.	"ManagementLevelLabel": ["board of directors"]
SICCode	The primary line of business represented by a Standard Industrial Classification code.	"SICCode": ["171102"]
SecondarySICCode	The lines of business represented by Standard Industrial Classification codes.	"SecondarySicCode": ["171102"]
NAICSCode1	The primary line of business represented by a Standard Industrial Classification code.	"NAICSCode1": ["44424012"]
NAICSCode2	The lines of business represented by North American Industry Classification System codes	"NAICSCode2": ["44424012"]
NumberCorporateEmployees	The actual, reported total number of employees at all locations in a corporate family.	"NumberCorporateEmployees": ["12200"]
EstNumberCorporateEmployees	Estimates the total number of employees at all locations in a corporate family.	"EstNumberCorporateEmployees": ["12200"]
NumberLocalEmployees	The number of employees who work at this place.	"NumberLocalEmployees": ["12200"]
EstNumberLocalEmployees	Estimates the number of employees who work at this location.	"EstNumberLocalEmployees": ["12200"]
LocSalesVolume	An estimation of the place’s sales revenue.	"LocSalesVolume": ["6476000"]
ContactDeliverableEmail	The deliverability status of the email address.	"ContactDeliverableEmail": true
ContactMarketableEmail	The marketable status of the email address.	"ContactMarketableEmail": 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	"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": [".org"]
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"]
EstimatedOpenedForBusinessLower	Estimated opened for business lower	"EstimatedOpenedForBusinessLower": [ "1996"]
EstimatedOpenedForBusinessUpper	Estimated opened for business upper	"EstimatedOpenedForBusinessUpper": [ "1996"]
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"],
EstimatedCorporateSalesRevenue	Estimates total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]

• POST JSON (Pagination)

Code	Description	JSON
Page	The page number to access; defaults to 1 if not included	"page": 1

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Results":"string (JSON Datatable)",
     "Pagination": {
       "Page":"int",
       "NextPage":"int"
     }
     }
   ]
 }

Record Level Response Fields

Output Name	Description
JobId	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Count	Number of records returned by the query
ResultCode	Success or Error codes based on the response/request
Results	The results as a JSON string Datatable
Pagination	The current page number and the next page number

/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!

• POST JSON

 curl -X POST http://dataapi.melissadata.net/web/V1/business/getCount\
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -D '{"customerid": "thisisanident", "includes": {"zips": [{"zip": "78727"}]},
    "columns": ["melissaaddresskey","city","state"]}'

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 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": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities (required)	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
Radius (required)	A radius object containing a latitude, longitude, and radius represented by meters.	"radius": { "latitude": 33.637654, "longitude": -117.607075, "distance": 500 }
Shapes (required)	A list of polygon shapes.	"shapes": [ {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]} ]
RBDI	An RBDI code	"rbdis": "B"
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
Email	Email	"Email": ["johndoe@gmail.com"]
DeliverableEmail	The deliverability status of the email address.	"DeliverableEmail": true
MarketableEmail	The marketable status of the email address.	"MarketableEmail": false
JobTitle	Descriptive label of the individual’s job	"JobTitle": ["president"]
ManagementLevelLabel	Describes the contact’s position relative to others in their organization.	"ManagementLevelLabel": ["board of directors"]
SICCode	The primary line of business represented by a Standard Industrial Classification code.	"SICCode": ["171102"]
SecondarySICCode	The lines of business represented by Standard Industrial Classification codes.	"SecondarySicCode": ["171102"]
NAICSCode1	The primary line of business represented by a Standard Industrial Classification code.	"NAICSCode1": ["44424012"]
NAICSCode2	The lines of business represented by North American Industry Classification System codes	"NAICSCode2": ["44424012"]
NumberCorporateEmployees	The actual, reported total number of employees at all locations in a corporate family.	"NumberCorporateEmployees": ["12200"]
EstNumberCorporateEmployees	Estimates the total number of employees at all locations in a corporate family.	"EstNumberCorporateEmployees": ["12200"]
NumberLocalEmployees	The number of employees who work at this place.	"NumberLocalEmployees": ["12200"]
EstNumberLocalEmployees	Estimates the number of employees who work at this location.	"EstNumberLocalEmployees": ["12200"]
LocSalesVolume	An estimation of the place’s sales revenue.	"LocSalesVolume": ["6476000"]
ContactDeliverableEmail	The deliverability status of the email address.	"ContactDeliverableEmail": true
ContactMarketableEmail	The marketable status of the email address.	"ContactMarketableEmail": 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	"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": [".org"]
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"]
EstimatedOpenedForBusinessLower	Estimated opened for business lower	"EstimatedOpenedForBusinessLower": [ "1996"]
EstimatedOpenedForBusinessUpper	Estimated opened for business upper	"EstimatedOpenedForBusinessUpper": [ "1996"]
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"],
EstimatedCorporateSalesRevenue	Estimates total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]

• POST JSON (Excludes)

Code	Description	JSON
Zips	A list of zips objects containing zip codes and optionally plus4.	"zips": [ {"zip": "78727"}, {"zip": "12345", "plus4": "6789"}, {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}} ]
Cities	A list of cities objects each containing city and state.	"cities": [ {"city": "Austin", "state": "TX"} ]
RBDI	An RBDI code	"rbdis": "B"
FIPSCode	A list of FIPSCodes.	"FIPSCode": ["12345"]
Email	Email	"Email": ["johndoe@gmail.com"]
DeliverableEmail	The deliverability status of the email address.	"DeliverableEmail": true
MarketableEmail	The marketable status of the email address.	"MarketableEmail": false
JobTitle	Descriptive label of the individual’s job	"JobTitle": ["president"]
ManagementLevelLabel	Describes the contact’s position relative to others in their organization.	"ManagementLevelLabel": ["board of directors"]
SICCode	The primary line of business represented by a Standard Industrial Classification code.	"SICCode": ["171102"]
SecondarySICCode	The lines of business represented by Standard Industrial Classification codes.	"SecondarySicCode": ["171102"]
NAICSCode1	The primary line of business represented by a Standard Industrial Classification code.	"NAICSCode1": ["44424012"]
NAICSCode2	The lines of business represented by North American Industry Classification System codes	"NAICSCode2": ["44424012"]
NumberCorporateEmployees	The actual, reported total number of employees at all locations in a corporate family.	"NumberCorporateEmployees": ["12200"]
EstNumberCorporateEmployees	Estimates the total number of employees at all locations in a corporate family.	"EstNumberCorporateEmployees": ["12200"]
NumberLocalEmployees	The number of employees who work at this place.	"NumberLocalEmployees": ["12200"]
EstNumberLocalEmployees	Estimates the number of employees who work at this location.	"EstNumberLocalEmployees": ["12200"]
LocSalesVolume	An estimation of the place’s sales revenue.	"LocSalesVolume": ["6476000"]
ContactDeliverableEmail	The deliverability status of the email address.	"ContactDeliverableEmail": true
ContactMarketableEmail	The marketable status of the email address.	"ContactMarketableEmail": 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	"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": [".org"]
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"]
EstimatedOpenedForBusinessLower	Estimated opened for business lower	"EstimatedOpenedForBusinessLower": [ "1996"]
EstimatedOpenedForBusinessUpper	Estimated opened for business upper	"EstimatedOpenedForBusinessUpper": [ "1996"]
CorporateFranchising	Determine if the corporation includes franchised branches.	"CorporateFranchising": true
CorporateSalesRevenue	The actual, reported sales revenue for the corporate family.	"CorporateSalesRevenue": ["12230000"],
EstimatedCorporateSalesRevenue	Estimates total sales revenue for the corporate family.	"EstimatedCorporateSalesRevenue": ["12230000"]
RestaurantCuisines	The type of cuisine served at the place.	"RestaurantCuisines": ["american"]

Headers

• POST JSON

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

Response

• POST JSON

 {
   "Version":"string",
   "TransmissionReference":"string",
   "TransmissionResults":"string",
   "Records": [
     {
     "JobId":"string",
     "Count":"int",
     "ResultCode":"string",
     "Sample":"string (JSON Datatable)"
     }
   ]
 }

Record Level 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

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	Short Description	Long Description
Transmission Service Error
SE01	SE01	SE01-D
Apieral Transmission Error
GE04	GE04	Empty License Key
GE05	GE05	Invalid License Key
GE06	GE06	Disabled License Key

Record Level Result Codes

Note

The Record Level result codes apply to the individual request records.

Code	Short Description	Long Description
LS - DataApi Cloud API Status
LS01	LS01	Successfully returned response
LS02	LS02	Successfully returned, results is 0 or empty
LE - DataApi Cloud API Error
LE01	LE01	Apieral Error - Unable to doCount
LE02	LE02	Apieral Error - Unable to doLookup
LE03	LE03	Error with creating JobId
LE04	LE04	Unable to handle MAK Conditions
LE05	LE05	Error building select count query
LE06	LE06	Error building select record query
LE07	LE07	Error executing count query
LE08	LE08	Error inserting record to table
LE09	LE09	Error adding pagination
LE10	LE10	Error executing paginated result
LE11	LE11	Query timed out. Try adding additinal filters or trying again later.