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 Gen 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#

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

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

Pagination (optional)

DG-Pagination

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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#

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

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

AddressLines

DG-AddressLines

"AddressLines": ["123 Main St"]

HomeownershipCode

DG-HomeownershipCode

"HomeownershipCode": ["AX"]

PhoneNumber

DG-PhoneNumber

"PhoneNumber": ["1234567890"]

DwellingCodeNormal

DG-DwellingCodeNormal

"DwellingCodeNormal": ["AX"]

ConstructionTypeCode

DG-ConstructionTypeCode

"ConstructionTypeCode": ["B"]

AgeOfHouseholdCode

DG-AgeOfHouseholdCode

"AgeOfHouseholdCode": ["B"]

CensusKey (required)

DG-CensusKey

"CensusKey": ["1234"]

MoveEffectiveDate

DG-DateRange


“MoveEffectiveDate”: {“startdate”: “2023/01/01”, “enddate”: “2024/01/01”}

  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

AddressLines

DG-AddressLines

"AddressLines": ["123 Main St"]

HomeownershipCode

DG-HomeownershipCode

"HomeownershipCode": ["AX"]

PhoneNumber

DG-PhoneNumber

"PhoneNumber": ["1234567890"]

DwellingCodeNormal

DG-DwellingCodeNormal

"DwellingCodeNormal": ["AX"]

ConstructionTypeCode

DG-ConstructionTypeCode

"ConstructionTypeCode": ["B"]

AgeOfHouseholdCode

DG-AgeOfHouseholdCode

"AgeOfHouseholdCode": ["B"]

CensusKey (required)

DG-CensusKey

"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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

Pagination (optional)

DG-Pagination

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"

AddressLines

DG-AddressLines

"AddressLines": ["123 Main St"]

HomeownershipCode

DG-HomeownershipCode

"HomeownershipCode": ["AX"]

PhoneNumber

DG-PhoneNumber

"PhoneNumber": ["1234567890"]

DwellingCodeNormal

DG-DwellingCodeNormal

"DwellingCodeNormal": ["AX"]

ConstructionTypeCode

DG-ConstructionTypeCode

"ConstructionTypeCode": ["B"]

AgeOfHouseholdCode

DG-AgeOfHouseholdCode

"AgeOfHouseholdCode": ["B"]

CensusKey (required)

DG-CensusKey

"CensusKey": ["1234"]

MoveEffectiveDate

DG-DateRange

"MoveEffectiveDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

AddressLines

DG-AddressLines

"AddressLines": ["123 Main St"]

HomeownershipCode

DG-HomeownershipCode

"HomeownershipCode": ["AX"]

PhoneNumber

DG-PhoneNumber

"PhoneNumber": ["1234567890"]

DwellingCodeNormal

DG-DwellingCodeNormal

"DwellingCodeNormal": ["AX"]

ConstructionTypeCode

DG-ConstructionTypeCode

"ConstructionTypeCode": ["B"]

AgeOfHouseholdCode

DG-AgeOfHouseholdCode

"AgeOfHouseholdCode": ["B"]

CensusKey (required)

DG-CensusKey

"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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"

AddressLines

DG-AddressLines

"AddressLines": ["123 Main St"]

HomeownershipCode

DG-HomeownershipCode

"HomeownershipCode": ["AX"]

PhoneNumber

DG-PhoneNumber

"PhoneNumber": ["1234567890"]

DwellingCodeNormal

DG-DwellingCodeNormal

"DwellingCodeNormal": ["AX"]

ConstructionTypeCode

DG-ConstructionTypeCode

"ConstructionTypeCode": ["B"]

AgeOfHouseholdCode

DG-AgeOfHouseholdCode

"AgeOfHouseholdCode": ["B"]

CensusKey (required)

DG-CensusKey

"CensusKey": ["1234"]

MoveEffectiveDate

DG-DateRange

"MoveEffectiveDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

AddressLines

DG-AddressLines

"AddressLines": ["123 Main St"]

HomeownershipCode

DG-HomeownershipCode

"HomeownershipCode": ["AX"]

PhoneNumber

DG-PhoneNumber

"PhoneNumber": ["1234567890"]

DwellingCodeNormal

DG-DwellingCodeNormal

"DwellingCodeNormal": ["AX"]

ConstructionTypeCode

DG-ConstructionTypeCode

"ConstructionTypeCode": ["B"]

AgeOfHouseholdCode

DG-AgeOfHouseholdCode

"AgeOfHouseholdCode": ["B"]

CensusKey (required)

DG-CensusKey

"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#

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

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"},
       {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"

Address

DG-Address

"Address": ["123 Main St"]

CondoCode

DG-CondoCode

"CondoCode": ["B"]

FirstName

DG-FirstName

"FirstName": ["Joe"]

Street

DG-Street

"Street": ["Main St"]

FIPSCode

DG-FIPSCode

"FIPSCode": ["12345"]

PurchasePrice

DG-PurchasePrice

"PurchasePrice": { "minimum": 0, "maximum": 400 }

PublishedDate

DG-DateRange

"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"},
       {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

Address

DG-Address

"Address": ["123 Main St"]

CondoCode

DG-CondoCode

"CondoCode": ["B"]

FirstName

DG-FirstName

"FirstName": ["Joe"]

Street

DG-Street

"Street": ["Main St"]

FIPSCode

DG-FIPSCode

"FIPSCode": ["12345"]

PurchasePrice

DG-PurchasePrice

"PurchasePrice": { "minimum": 0, "maximum": 400 }

PublishedDate

DG-DateRange

"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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

Pagination (optional)

DG-Pagination

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"},
       {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"

Address

DG-Address

"Address": ["123 Main St"]

CondoCode

DG-CondoCode

"CondoCode": ["B"]

FirstName

DG-FirstName

"FirstName": ["Joe"]

Street

DG-AgeOfHouseholdCode

"Street": ["Main St"]

FIPSCode

DG-AgeOfHouseholdCode

"FIPSCode": ["12345"]

PurchasePrice

DG-AgeOfHouseholdCode

"PurchasePrice": { "minimum": 0, "maximum": 400 }

PublishedDate

DG-DateRange

"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"},
       {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

Address

DG-Address

"Address": ["123 Main St"]

CondoCode

DG-CondoCode

"CondoCode": ["B"]

FirstName

DG-FirstName

"FirstName": ["Joe"]

Street

DG-AgeOfHouseholdCode

"Street": ["Main St"]

FIPSCode

DG-AgeOfHouseholdCode

"FIPSCode": ["12345"]

PurchasePrice

DG-AgeOfHouseholdCode

"PurchasePrice": { "minimum": 0, "maximum": 400 }

PublishedDate

DG-DateRange

"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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"},
       {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"

Address

DG-Address

"Address": ["123 Main St"]

CondoCode

DG-CondoCode

"CondoCode": ["B"]

FirstName

DG-FirstName

"FirstName": ["Joe"]

Street

DG-AgeOfHouseholdCode

"Street": ["Main St"]

FIPSCode

DG-AgeOfHouseholdCode

"FIPSCode": ["12345"]

PurchasePrice

DG-AgeOfHouseholdCode

"PurchasePrice": { "minimum": 0, "maximum": 400 }

PublishedDate

DG-DateRange

"PublishedDate": {"startdate": "2023/01/01", "enddate": "2024/01/01"}
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"},
       {"zip": "12345", "plus4": "6789", "carrierroute": "C0123"}}}}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "B"

Address

DG-Address

"Address": ["123 Main St"]

CondoCode

DG-CondoCode

"CondoCode": ["B"]

FirstName

DG-FirstName

"FirstName": ["Joe"]

Street

DG-AgeOfHouseholdCode

"Street": ["Main St"]

FIPSCode

DG-AgeOfHouseholdCode

"FIPSCode": ["12345"]

PurchasePrice

DG-AgeOfHouseholdCode

"PurchasePrice": { "minimum": 0, "maximum": 400 }

PublishedDate

DG-DateRange

"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#

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

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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/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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

Pagination (optional)

DG-Pagination

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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/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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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 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#

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

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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/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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

Pagination (optional)

DG-Pagination

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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/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#

  • POST JSON
 curl -X POST http://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

DG-CustomerID

Includes

DG-Includes

Excludes (optional)

DG-Excludes

Columns

DG-Columns

  • POST JSON (Includes)

Code

Description

JSON

Zips (required)

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities (required)

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

Radius (required)

DG-Radius

"radius": {
        "latitude": 33.637654,
        "longitude": -117.607075,
        "distance": 500
     }

Shapes (required)

DG-Shapes

"shapes": [
       {"shape": [[-64.8, 32.3], [-65.5, 18.3], [-80.3, 25.2], [-64.8, 32.3]]}
        ]

RBDI

DG-RBDI

"rbdis": "B"
  • POST JSON (Excludes)

Code

Description

JSON

Zips

DG-Zips

"zips": [
       {"zip": "78727"},
       {"zip": "12345", "plus4": "6789"}
      ]

Cities

DG-Cities

"cities": [
      {"city": "Austin", "state": "TX"}
      ]

RBDI

DG-RBDI

"rbdis": "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 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.

Code

Short Description

Long Description

Transmission Service Error

SE01

SE01

SE01-D

General Transmission Error

GE04

GE04

Empty License Key

GE05

GE05

Invalid License Key

GE06

GE06

Disabled License Key

Record Level Result Codes#

Code

Short Description

Long Description

LS - DataGen Cloud API Status

LS01

LS01

Successfully returned response

LS02

LS02

Successfully returned, results is 0 or empty

LE - DataGen Cloud API Error

LE01

LE01

General Error - Unable to doCount

LE02

LE02

General 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.