GeocodeUSAddress

Resource URL

JSON endpoint:

http://server:port/rest/GeocodeUSAddress/results.json

https://OnDemandServer/rest/GeocodeUSAddress/results.json

XML endpoint:

http://server:port/rest/GeocodeUSAddress/results.xml

https://OnDemandServer/rest/GeocodeUSAddress/results.xml

For a list of Spectrum OnDemand servers, see Connecting to Spectrum OnDemand Servers.

Example with JSON Response

The following example requests a JSON response:

http://myserver:8080/rest/GeocodeUSAddress/results.json?Data.AddressLine1=3001+Summer+St&Data.City=Stamford&Data.StateProvince=CT

https://spectrum.precisely.com/rest/GeocodeUSAddress/results.json?Data.AddressLine1=3001+Summer+St&Data.City=Stamford&Data.StateProvince=CT

The JSON returned by this request would be:

{"output_port": [{
   "BlockSuffix": "",
   "CBSADivisionCode": "",
   "CBSAMetro": "Y",
   "CBSACode": "14860",
   "CensusBlockID": "090010212002010",
   "USFIPSCountyNumber": "001",
   "CSACode": "408",
   "CensusTract": "021200",
   "USFIPSStateCode": "09",
   "USFIPSStateCountyCode": "09001",
   "Latitude": "41.071067",
   "Longitude": "-73.549161",
   "StreetSide": "R",
   "BlockLine1": "",
   "BlockLine2": "",
   "BlockLine3": "",
   "BlockLine4": "",
   "BlockLine5": "",
   "BlockLine6": "",
   "FirmName": "Stamford Square",
   "AddressLine1": "3001 Summer St",
   "AddressLine2": "",
   "LastLine": "Stamford, CT  06905-4317",
   "StreetName": "Summer",
   "CrossStreetName": "",
   "LeadingDirectional": "",
   "CrossStreetLeadingDirectional": "",
   "HouseNumber": "3001",
   "HouseNumber2": "",
   "TrailingDirectional": "",
   "CrossStreetTrailingDirectional": "",
   "StreetSuffix": "St",
   "CrossStreetSuffix": "",
   "ApartmentLabel": "",
   "ApartmentLabel2": "",
   "ApartmentNumber": "",
   "ApartmentNumber2": "",
   "AdditionalInputData": "",
   "City": "Stamford",
   "StateProvince": "CT",
   "PostalCode.Base": "06905",
   "PostalCode.AddOn": "4317",
   "PostalCode": "06905-4317",
   "PrivateMailbox.Designator": "",
   "PrivateMailbox": "",
   "USUrbanName": "",
   "Country": "United States of America",
   "RRHC": "",
   "USCarrierRouteCode": "C006",
   "USBCCheckDigit": "7",
   "PostalBarCode": "431799",
   "DeliveryPointCode": "99",
   "GovernmentBuilding": "",
   "USLOTCode": "0012A",
   "USCarrierRouteSort": "B",
   "USCityDelivery": "Y",
   "PostalCodeClass": "",
   "PostalFacility": "P",
   "PostalCodeUnique": "",
   "CityStateRecordName": "Stamford",
   "CityPreferredName": "Stamford",
   "CityShortName": "Stamford",
   "DPV": "D",
   "DPVFootnote": "AAN1",
   "CMRA": "N",
   "Alternate": "B",
   "HouseNumberHigh": "3001",
   "HouseNumberLow": "3001",
   "HouseNumberParity": "O",
   "UnitNumberHigh": "",
   "UnitNumberLow": "",
   "UnitNumberParity": "",
   "PostalCodeExtensionHigh": "4317",
   "PostalCodeExtensionLow": "4317",
   "AddressLineResolved": "",
   "EWSMatch": "",
   "RecordType.Default": "Y",
   "Intersection": "F",
   "IsAlias": "N01",
   "LACSAddress": "",
   "LocationCode": "AS0",
   "MatchCode": "S90",
   "RecordType": "HighRise",
   "GeoStanMatchScore": "0.0000000",
   "CountryLevel": "A",
   "StreetDataType": "TOMTOM",
   "StreetDataCode": "2",
   "DatabaseVersion": "July 2015",
   "ExpirationDate": "11/27/2015",
   "BlockLeft": "090010213001010",
   "BlockRight": "090010212002010",
   "BlockSuffixLeft": "",
   "BlockSuffixRight": "",
   "RoadClass": "00",
   "SegmentDirection": "F",
   "SegmentHouseNumberHigh": "3001",
   "SegmentHouseNumberLow": "2988",
   "SegmentCode": "72822",
   "SegmentLength": "",
   "SegmentParity": "R",
   "PointCode": "",
   "Confidence": "89",
   "ProcessedBy": "KGL",
   "Geocoder.MatchCode": "S5HPNTSCZA",
   "IsCloseMatch": "Y",
   "GeoConfidenceCode": "ADDRESS",
   "GeoConfidenceCentroidLatitude": "41.071067",
   "GeoConfidenceCentroidLongitude": "-73.549161",
   "PBKey": "",
   "Status": "",
   "Status.Code": "",
   "Status.Description": "",
   "StreetSegmentPoints": [{"SegmentPoints":    [
            {
         "Latitude": "41.071051",
         "Longitude": "-73.549348"
      },
            {
         "Latitude": "41.071117",
         "Longitude": "-73.549338"
      }
   ]}],
   "user_fields": []
}]}

Example with XML Response

The following example requests an XML response:

http://myserver:8080/rest/GeocodeUSAddress/results.xml?Data.AddressLine1=3001+Summer+St&Data.City=Stamford&Data.StateProvince=CT

https://spectrum.precisely.com/rest/GeocodeUSAddress/results.xml?Data.AddressLine1=3001+Summer+St&Data.City=Stamford&Data.StateProvince=CT

The XML returned by this request would be:

<xml.GeocodeUSAddressResponse xmlns="http://www.pb.com/spectrum/services/GeocodeUSAddress">
   <output_port>
      <Address>
         <BlockSuffix/>
         <CBSADivisionCode/>
         <CBSAMetro>Y</CBSAMetro>
         <CBSACode>14860</CBSACode>
         <CensusBlockID>090010212002010</CensusBlockID>
         <USFIPSCountyNumber>001</USFIPSCountyNumber>
         <CSACode>408</CSACode>
         <CensusTract>021200</CensusTract>
         <USFIPSStateCode>09</USFIPSStateCode>
         <USFIPSStateCountyCode>09001</USFIPSStateCountyCode>
         <Latitude>41.071067</Latitude>
         <Longitude>-73.549161</Longitude>
         <StreetSide>R</StreetSide>
         <BlockLine1/>
         <BlockLine2/>
         <BlockLine3/>
         <BlockLine4/>
         <BlockLine5/>
         <BlockLine6/>
         <FirmName>Stamford Square</FirmName>
         <AddressLine1>3001 Summer St</AddressLine1>
         <AddressLine2/>
         <LastLine>Stamford, CT  06905-4317</LastLine>
         <StreetName>Summer</StreetName>
         <CrossStreetName/>
         <LeadingDirectional/>
         <CrossStreetLeadingDirectional/>
         <HouseNumber>3001</HouseNumber>
         <HouseNumber2/>
         <TrailingDirectional/>
         <CrossStreetTrailingDirectional/>
         <StreetSuffix>St</StreetSuffix>
         <CrossStreetSuffix/>
         <ApartmentLabel/>
         <ApartmentLabel2/>
         <ApartmentNumber/>
         <ApartmentNumber2/>
         <AdditionalInputData/>
         <City>Stamford</City>
         <StateProvince>CT</StateProvince>
         <PostalCode.Base>06905</PostalCode.Base>
         <PostalCode.AddOn>4317</PostalCode.AddOn>
         <PostalCode>06905-4317</PostalCode>
         <PrivateMailbox.Designator/>
         <PrivateMailbox/>
         <USUrbanName/>
         <Country>United States of America</Country>
         <RRHC/>
         <USCarrierRouteCode>C006</USCarrierRouteCode>
         <USBCCheckDigit>7</USBCCheckDigit>
         <PostalBarCode>431799</PostalBarCode>
         <DeliveryPointCode>99</DeliveryPointCode>
         <GovernmentBuilding/>
         <USLOTCode>0012A</USLOTCode>
         <USCarrierRouteSort>B</USCarrierRouteSort>
         <USCityDelivery>Y</USCityDelivery>
         <PostalCodeClass/>
         <PostalFacility>P</PostalFacility>
         <PostalCodeUnique/>
         <CityStateRecordName>Stamford</CityStateRecordName>
         <CityPreferredName>Stamford</CityPreferredName>
         <CityShortName>Stamford</CityShortName>
         <DPV>D</DPV>
         <DPVFootnote>AAN1</DPVFootnote>
         <CMRA>N</CMRA>
         <Alternate>B</Alternate>
         <HouseNumberHigh>3001</HouseNumberHigh>
         <HouseNumberLow>3001</HouseNumberLow>
         <HouseNumberParity>O</HouseNumberParity>
         <UnitNumberHigh/>
         <UnitNumberLow/>
         <UnitNumberParity/>
         <PostalCodeExtensionHigh>4317</PostalCodeExtensionHigh>
         <PostalCodeExtensionLow>4317</PostalCodeExtensionLow>
         <AddressLineResolved/>
         <EWSMatch/>
         <RecordType.Default>Y</RecordType.Default>
         <Intersection>F</Intersection>
         <IsAlias>N01</IsAlias>
         <LACSAddress/>
         <LocationCode>AS0</LocationCode>
         <MatchCode>S90</MatchCode>
         <RecordType>HighRise</RecordType>
         <GeoStanMatchScore>0.0000000</GeoStanMatchScore>
         <CountryLevel>A</CountryLevel>
         <StreetDataType>TOMTOM</StreetDataType>
         <StreetDataCode>2</StreetDataCode>
         <DatabaseVersion>July 2015</DatabaseVersion>
         <ExpirationDate>11/27/2015</ExpirationDate>
         <BlockLeft>090010213001010</BlockLeft>
         <BlockRight>090010212002010</BlockRight>
         <BlockSuffixLeft/>
         <BlockSuffixRight/>
         <RoadClass>00</RoadClass>
         <SegmentDirection>F</SegmentDirection>
         <SegmentHouseNumberHigh>3001</SegmentHouseNumberHigh>
         <SegmentHouseNumberLow>2988</SegmentHouseNumberLow>
         <SegmentCode>72822</SegmentCode>
         <SegmentLength/>
         <SegmentParity>R</SegmentParity>
         <PointCode/>
         <Confidence>89</Confidence>
         <ProcessedBy>KGL</ProcessedBy>
         <Geocoder.MatchCode>S5HPNTSCZA</Geocoder.MatchCode>
         <IsCloseMatch>Y</IsCloseMatch>
         <GeoConfidenceCode>ADDRESS</GeoConfidenceCode>
         <GeoConfidenceCentroidLatitude>41.071067</GeoConfidenceCentroidLatitude>
         <GeoConfidenceCentroidLongitude>-73.549161</GeoConfidenceCentroidLongitude>
         <StreetSegmentPoints>
            <StreetSegments>
               <SegmentPoints>
                  <SegmentPoint>
                     <Latitude>41.071051</Latitude>
                     <Longitude>-73.549348</Longitude>
                  </SegmentPoint>
                  <SegmentPoint>
                     <Latitude>41.071117</Latitude>
                     <Longitude>-73.549338</Longitude>
                  </SegmentPoint>
               </SegmentPoints>
            </StreetSegments>
         </StreetSegmentPoints>
         <PBKey/>
         <Status/>
         <Status.Code/>
         <Status.Description/>
         <user_fields/>
      </Address>
   </output_port>
</xml.GeocodeUSAddressResponse>