Reference Guide#

Introduction#

Welcome to the GeoLib Service by Melissa.

The GeoLib Service is a powerful tool that helps businesses improve the accuracy and completeness of their address data. For users of Address Object, after you have verified and corrected your addresses, it can be used to append geocoding coordinates, census information, school information, and more.

As a self-hosted container, you deploy and manage GeoLib on-premises. This gives you complete control over your data, security, and performance. Storing your data in a specific location can be important for data sovereignty and comliance reasons, like for GDPR. This also allows you greater security over your data, if needed. Self-hosting can also offer better performance, especially if you require a low latency or high throughput.

Geodetic System
The GeoCoder Object uses WGS 84 standard, an Earth-centered, Earth-fixed terrestrial reference system and geodetic datum.
Census Data Year
Census data changes and updates are made on a regular basis. It is important to know the year of the Census data Melissa is returning so that it can be accurately matched up to your own data or other census values.

Data Path#

This is set during the containerization service setup. It is whatever data path you set.

See {{data_path}} in the Example Docker Setup

Service Port Number#

This is set during the containerization service setup. It defaults to 6245, but can be any port you set.

See {{port_number}} in the Example Docker Setup

Machine Name#

This is your local machine name. You’ll use this in every request you send to your local containerization service. You can view your machine name by using the hostname command in the command prompt.

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 the service will not function.

Endpoints#

/v4/WEB/Geo/GetVersion#

Introduction#

Use this endpoint to check the version of the GeoLib Service.

Try It Now#

  • GET JSON
curl -X GET \
"http://{{machine_name}}:{{port_number}}/v4/WEB/Geo/GetVersion" \
-H "accept: application/json"

Headers#

  • GET JSON
cache-control: no-cache,no-store,must-revalidate,private
content-type: application/json; charset=utf-8
pragma: no-cache

Response#

  • GET JSON
{
  "Version_0": "8.4.1.17401",
  "ServiceName_0": "geoLibService",
  "InitializationErrorCode_0": "0",
  "InitializationErrorMessage_0": "No error",
  "BuildNumber_0": "17401",
  "DatabaseDate_0": "2024-04-15",
  "ExpirationDate_0": "2024-07-02",
  "LicenseExpirationDate_0": "2024-07-02",
  "Version_1": "8.4.1.17401",
  "ServiceName_1": "geoLibService",
  "InitializationErrorCode_1": "0",
  "InitializationErrorMessage_1": "No error",
  "BuildNumber_1": "17401",
  "DatabaseDate_1": "2024-04-15",
  "ExpirationDate_1": "2024-07-02",
  "LicenseExpirationDate_1": "2024-07-02",
  "Version_2": "8.4.1.17401",
  "ServiceName_2": "geoLibService",
  "InitializationErrorCode_2": "0",
  "InitializationErrorMessage_2": "No error",
  "BuildNumber_2": "17401",
  "DatabaseDate_2": "2024-04-15",
  "ExpirationDate_2": "2024-07-02",
  "LicenseExpirationDate_2": "2024-07-02"
}

/V4/WEB/Geo/DoGeoCode (by MAK)#

Introduction#

Use this endpoint to use all geocode capabilities of Geocoder Object.

Try It Now#

  • GET JSON
  • POST JSON
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V4/WEB/Geo/DoGeoCode?\
t=test\
&id={{license_key}}\
&mak=8008006245" \
-H "accept: application/json"

curl -X POST \
 "http://{{machine_name}}:{{port_number}}/V4/WEB/Geo/DoGeoCode" \
 -H "accept: application/json" \
 -H "Content-Type: application/json" \
 -d '{
 "customerId"={{license_key}},
 "transmissionReference": "test",
 "records": [
    {
     "mak": "8008006245"
    }
  ]
}'

Headers#

  • GET JSON
  • POST JSON
cache-control: no-cache,no-store,must-revalidate,private
content-type: application/json; charset=utf-8
pragma: no-cache

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

Response#

  • GET JSON
  • POST JSON
{
  "TransmissionResults": "",
  "TransmissionReference": "test",
  "Version": "8.4.1.17401",
  "TotalRecords": 1,
  "Records": [
    {
      "RecordID": "",
      "Latitude": "33.637562",
      "Longitude": "-117.606887",
      "CensusTract": "032053",
      "CensusBlock": "1002",
      "CountyFIPS": "06059",
      "CountyName": "Orange",
      "PlaceCode": "0659587",
      "PlaceName": "Rancho Santa Margarita",
      "TimeZoneCode": "08",
      "TimeZone": "Pacific Time",
      "CBSACode": "31080",
      "CBSATitle": "Los Angeles-Long Beach-Anaheim, CA",
      "CBSALevel": "Metropolitan Statistical Area",
      "CBSADivisionCode": "11244",
      "CBSADivisionTitle": "Anaheim-Santa Ana-Irvine, CA",
      "CBSADivisionLevel": "Metropolitan Statistical Area",
      "CensusKey": "060590320531002",
      "CensusKeyDecennial": "060590320531005",
      "CountySubdivisionCode": "91977",
      "CountySubdivisionName": "Mission Viejo CCD",
      "ElementarySchoolDistrictCode": "",
      "ElementarySchoolDistrictName": "",
      "SecondarySchoolDistrictCode": "",
      "SecondarySchoolDistrictName": "",
      "StateDistrictLower": "071",
      "StateDistrictUpper": "038",
      "UnifiedSchoolDistrictCode": "07440",
      "UnifiedSchoolDistrictName": "Capistrano Unified School District",
      "BlockSuffix": "",
      "Results": "GS05",
      "StatusCode": "B",
      "SourceLevel": "BC"
    }
  ]
}

{
  "TransmissionResults": "",
  "TransmissionReference": "test",
  "Version": "8.4.1.17401",
  "TotalRecords": 1,
  "Records": [
    {
      "RecordID": "",
      "Latitude": "33.637562",
      "Longitude": "-117.606887",
      "CensusTract": "032053",
      "CensusBlock": "1002",
      "CountyFIPS": "06059",
      "CountyName": "Orange",
      "PlaceCode": "0659587",
      "PlaceName": "Rancho Santa Margarita",
      "TimeZoneCode": "08",
      "TimeZone": "Pacific Time",
      "CBSACode": "31080",
      "CBSATitle": "Los Angeles-Long Beach-Anaheim, CA",
      "CBSALevel": "Metropolitan Statistical Area",
      "CBSADivisionCode": "11244",
      "CBSADivisionTitle": "Anaheim-Santa Ana-Irvine, CA",
      "CBSADivisionLevel": "Metropolitan Statistical Area",
      "CensusKey": "060590320531002",
      "CensusKeyDecennial": "060590320531005",
      "CountySubdivisionCode": "91977",
      "CountySubdivisionName": "Mission Viejo CCD",
      "ElementarySchoolDistrictCode": "",
      "ElementarySchoolDistrictName": "",
      "SecondarySchoolDistrictCode": "",
      "SecondarySchoolDistrictName": "",
      "StateDistrictLower": "071",
      "StateDistrictUpper": "038",
      "UnifiedSchoolDistrictCode": "07440",
      "UnifiedSchoolDistrictName": "Capistrano Unified School District",
      "BlockSuffix": "",
      "Results": "GS05",
      "StatusCode": "B",
      "SourceLevel": "BC"
    }
  ]
}

/V4/WEB/Geo/DoGeoCode (by Addresskey)#

Introduction#

Use this endpoint to use all geocode capabilities of Geocoder Object.

Try It Now#

  • GET JSON
  • POST JSON
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V4/WEB/Geo/DoGeoCode?\
t=test\
&id={{license_key}}\
&zip=92688\
&dp=82" \
-H "accept: application/json"

curl -X POST \
 "http://{{machine_name}}:{{port_number}}/V4/WEB/Geo/DoGeoCode" \
 -H "accept: application/json" \
 -H "Content-Type: application/json" \
 -d '{
 "customerId"={{license_key}},
 "transmissionReference": "test",
 "records": [
    {
     "zip": "92688",
     "plus4": "2112",
     "deliverypointcode": "82"
    }
  ]
}'

Headers#

  • GET JSON
  • POST JSON
cache-control: no-cache,no-store,must-revalidate,private
content-type: application/json; charset=utf-8
pragma: no-cache

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

Response#

  • GET JSON
  • POST JSON
{
  "TransmissionResults": "",
  "TransmissionReference": "test",
  "Version": "8.4.1.17401",
  "TotalRecords": 1,
  "Records": [
    {
      "RecordID": "",
       "Latitude": "33.636900",
       "Longitude": "-117.604300",
       "CensusTract": "032053",
       "CensusBlock": "1001",
       "CountyFIPS": "06059",
       "CountyName": "Orange",
       "PlaceCode": "0659587",
       "PlaceName": "Rancho Santa Margarita",
       "TimeZoneCode": "08",
       "TimeZone": "Pacific Time",
       "CBSACode": "31080",
       "CBSATitle": "Los Angeles-Long Beach-Anaheim, CA",
       "CBSALevel": "Metropolitan Statistical Area",
       "CBSADivisionCode": "11244",
       "CBSADivisionTitle": "Anaheim-Santa Ana-Irvine, CA",
       "CBSADivisionLevel": "Metropolitan Statistical Area",
       "CensusKey": "060590320531001",
       "CensusKeyDecennial": "",
       "CountySubdivisionCode": "91977",
       "CountySubdivisionName": "Mission Viejo CCD",
       "ElementarySchoolDistrictCode": "",
       "ElementarySchoolDistrictName": "",
       "SecondarySchoolDistrictCode": "",
       "SecondarySchoolDistrictName": "",
       "StateDistrictLower": "071",
       "StateDistrictUpper": "038",
       "UnifiedSchoolDistrictCode": "07440",
       "UnifiedSchoolDistrictName": "Capistrano Unified School District",
       "BlockSuffix": "",
       "Results": "GS03",
       "StatusCode": "5",
       "SourceLevel": "MD"
    }
  ]
}

{
  "TransmissionResults": "",
  "TransmissionReference": "test",
  "Version": "8.4.1.17401",
  "TotalRecords": 1,
  "Records": [
    {
      "RecordID":"",
       "Latitude":"33.637562",
       "Longitude":"-117.606887",
       "CensusTract":"032053",
       "CensusBlock":"1002",
       "CountyFIPS":"06059",
       "CountyName":"Orange",
       "PlaceCode":"0659587",
       "PlaceName":"Rancho Santa Margarita",
       "TimeZoneCode":"08",
       "TimeZone":"Pacific Time",
       "CBSACode":"31080",
       "CBSATitle":"Los Angeles-Long Beach-Anaheim, CA",
       "CBSALevel":"Metropolitan Statistical Area",
       "CBSADivisionCode":"11244",
       "CBSADivisionTitle":"Anaheim-Santa Ana-Irvine, CA",
       "CBSADivisionLevel":"Metropolitan Statistical Area",
       "CensusKey":"060590320531002",
       "CensusKeyDecennial":"060590320531005",
       "CountySubdivisionCode":"91977",
       "CountySubdivisionName":"Mission Viejo CCD",
       "ElementarySchoolDistrictCode":"",
       "ElementarySchoolDistrictName":"",
       "SecondarySchoolDistrictCode":"",
       "SecondarySchoolDistrictName":"",
       "StateDistrictLower":"071",
       "StateDistrictUpper":"038",
       "UnifiedSchoolDistrictCode":"07440",
       "UnifiedSchoolDistrictName":"Capistrano Unified School District",
       "BlockSuffix":"",
       "Results":"GS05",
       "StatusCode":"B",
       "SourceLevel":"BC"
    }
  ]
}
Request Parameters#
  • GET JSON

Code

Description

t

This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

id

The License Key issued by Melissa.

opt

Set Options

UseUSPSPreferredCityNames

CASSEnable

DiacriticsMode

StandardizeType

InRangeOnly

OfficialCityNameOnly

mak

Melissa Address Key.

zip

The ZIP Code.

p4

The Plus 4 extension for US ZIP codes, specifying a delivery route in the ZIP code area.

dp

Delivery point.

format

The format of the response.