Geoclient

Geosupport Documentation

Geoclient Version

REST API v1.0.14.1
Library v1.0.17.1
Parser v1.0.1
Native v1.0.10

Geosupport Version

Release 23A
Version 23.10

Geoclient API v1

The Geoclient application is a cloud based web service which exposes select function calls to the New York City Department of City Planning's Geosupport application. At the current time, there are six types of location requests that the Geoclient service provides:

Type Description Geosupport Function
Address Given a valid address, provides blockface-level, property-level, and political information. 1B
BBL Given a valid borough, block, and lot provides property-level information. BL
BIN Given a valid building identification number provides property-level information. BN
Blockface Given a valid borough, "on street" and cross streets provides blockface-level information. 3
Intersection Given a valid borough and cross streets returns information for the point defined by the two streets. 2
Place Same as 'Address' above using well-known NYC place name for input. 1B

Starting with Geoclient service version 1.10, any of these request types can be called using the new single-field search endpoint. Service calls can now be made passing in a single-line location instead of requiring values be separated into distinct query parameters. See Section 1.3 for details.

Roadmap

  1. Section 1.0 titled "Calling the Geoclient API" documents how application clients call the Geoclient service. It also provides example responses.
  2. Section 2.0 titled "Understanding Geoclient Return Codes" provides reference information for the HTTP and application-level return codes which are provided for all requests.
  3. Section 3.0 titled "Geoclient Function Reference" details what data elements are returned from each request type.
  4. Section 4.0 titled "Geoclient Data Dictionary" provides more detailed reference information on available data items.
  5. Section 5.0 titled "Version Information" provides information about the versions of Geoclient and Geosupport used by this service.
  6. Section 6.0 titled "Contact Us" provides contact information for the Citywide GIS group.

1.0 - Calling the Geoclient API

All requests are made as simple HTTP GET's with input arguments specified as URL query parameters. The service returns the JSON (application/json) or XML (application/xml) media types, depending on the requested file extension.

Note that although the XML and JSON example responses are "pretty-printed" in this document, calling applications should not depend on any particular formatting of responses. Furthermore, the ordering of returned data elements is unspecified. Client code which parses responses from Geoclient should not rely upon significant whitespace or element/attribute ordering.

Also, even within the same service call types (Address, Intersection, etc...) the set of returned data elements will vary since those elements with NULL values are not returned.

1.1 - Common Request Parameters

The following request parameters are required for all operations (except where noted):

1Not applicable to BIN calls
2Not required for ADDRESS or PLACE calls if zip is given 3Some caveats apply for single-field search requests

1.2 - Request Parameters by Type

The following sections describe how to call the Geoclient API. Required and optional query parameters are listed for each type of supported call. Although the actual Geosupport API can be called with a vast number of optional parameters, at this time this service only supports what's listed below.

Note: Example GET requests are shown unencoded (for example, with space characters instead of '%20'). When making these requests programmatically, you may need to URL-encode the URL if your tool or platform does not do so automatically. See this article for more details.

1.2.1 - Address

Path: /v1/address.{format}

Parameters:

Parameter Name Required/Optional Comments
houseNumber required House number of the address.
street required Street name or 7-digit street code.
borough required if 'zip' not given Valid values defined in section 1.1.
zip required if 'borough' not given Standard USPS 5-digit zip code or zip+4 (see this article). Must be a valid zip code for an area within New York City limits.

Example Requests:

/v1/address.json?houseNumber=314&street=west 100 st&borough=manhattan&app_id=abc123&app_key=def456
/v1/address.xml?houseNumber=109-20&street=71st rd&borough=queens&app_id=abc123&app_key=def456

Example JSON response

{
  "address": {
    "assemblyDistrict": "69",
    "bbl": "1018887502",
    "bblBoroughCode": "1",
    "bblTaxBlock": "01888",
    "bblTaxLot": "7502",
    "boeLgcPointer": "1",
    "boePreferredStreetName": "WEST  100 STREET",
    "boePreferredstreetCode": "13577001",
    "boroughCode1In": "1",
    "buildingIdentificationNumber": "1057093",
    "censusBlock2000": "6000",
    "censusBlock2010": "2000",
    "censusTract1990": "187",
    "censusTract2000": "187",
    "censusTract2010": "187",
    "cityCouncilDistrict": "09",
    "civilCourtDistrict": "05",
    "coincidenceSegmentCount": "1",
    "communityDistrict": "107",
    "communityDistrictBoroughCode": "1",
    "communityDistrictNumber": "07",
    "communitySchoolDistrict": "03",
    "condominiumBillingBbl": "1018887502",
    "condominiumFlag": "C",
    "congressionalDistrict": "10",
    "cooperativeIdNumber": "0000",
    "crossStreetNamesFlagIn": "E",
    "dcpPreferredLgc": "01",
    "dofCondominiumIdentificationNumber": "1981",
    "dotStreetLightContractorArea": "1",
    "dynamicBlock": "601",
    "electionDistrict": "049",
    "fireBattalion": "11",
    "fireCompanyNumber": "022",
    "fireCompanyType": "L",
    "fireDivision": "03",
    "firstBoroughName": "MANHATTAN",
    "firstStreetCode": "13577001010",
    "firstStreetNameNormalized": "WEST  100 STREET",
    "fromLionNodeId": "0023422",
    "fromPreferredLgcsFirstSetOf5": "01",
    "genericId": "0060351",
    "geosupportFunctionCode": "1B",
    "geosupportReturnCode": "00",
    "geosupportReturnCode2": "00",
    "gi5DigitStreetCode1": "35770",
    "giBoroughCode1": "1",
    "giBuildingIdentificationNumber1": "1057093",
    "giDcpPreferredLgc1": "01",
    "giHighHouseNumber1": "316",
    "giLowHouseNumber1": "314",
    "giSideOfStreetIndicator1": "L",
    "giStreetCode1": "13577001",
    "giStreetName1": "WEST  100 STREET",
    "healthArea": "3110",
    "healthCenterDistrict": "16",
    "highBblOfThisBuildingsCondominiumUnits": "1018881233",
    "highCrossStreetB5SC1": "129690",
    "highCrossStreetCode1": "12969001",
    "highCrossStreetName1": "RIVERSIDE DRIVE",
    "highHouseNumberOfBlockfaceSortFormat": "000398000AA",
    "houseNumber": "314",
    "houseNumberIn": "314",
    "houseNumberSortFormat": "000314000AA",
    "interimAssistanceEligibilityIndicator": "I",
    "internalLabelXCoordinate": "0991892",
    "internalLabelYCoordinate": "0230017",
    "legacySegmentId": "0037349",
    "lionKeyBoroughCode": "1",
    "lionKeyFaceCode": "5345",
    "lionKeyForVanityAddressBoroughCode": "1",
    "lionKeyForVanityAddressFaceCode": "5345",
    "lionKeyForVanityAddressSequenceNumber": "00060",
    "lionKeySequenceNumber": "00060",
    "listOf4Lgcs": "01",
    "lowBblOfThisBuildingsCondominiumUnits": "1018881201",
    "lowCrossStreetB5SC1": "144990",
    "lowCrossStreetCode1": "14499001",
    "lowCrossStreetName1": "WEST END AVENUE",
    "lowHouseNumberOfBlockfaceSortFormat": "000300000AA",
    "lowHouseNumberOfDefiningAddressRange": "000314000AA",
    "nta": "MN12",
    "ntaName": "Upper West Side",
    "numberOfCrossStreetB5SCsHighAddressEnd": "1",
    "numberOfCrossStreetB5SCsLowAddressEnd": "1",
    "numberOfCrossStreetsHighAddressEnd": "1",
    "numberOfCrossStreetsLowAddressEnd": "1",
    "numberOfEntriesInListOfGeographicIdentifiers": "0001",
    "numberOfExistingStructuresOnLot": "0001",
    "numberOfStreetFrontagesOfLot": "01",
    "physicalId": "0069454",
    "policePatrolBoroughCommand": "2",
    "policePrecinct": "024",
    "returnCode1a": "00",
    "returnCode1e": "00",
    "roadwayType": "1",
    "rpadBuildingClassificationCode": "R4",
    "rpadSelfCheckCodeForBbl": "5",
    "sanbornBoroughCode": "1",
    "sanbornPageNumber": "034",
    "sanbornVolumeNumber": "07",
    "sanbornVolumeNumberSuffix": "S",
    "sanitationCollectionSchedulingSectionAndSubsection": "5B",
    "sanitationDistrict": "107",
    "sanitationRecyclingCollectionSchedule": "ET",
    "sanitationRegularCollectionSchedule": "TTHS",
    "sanitationSnowPriorityCode": "P",
    "segmentAzimuth": "151",
    "segmentIdentifier": "0037349",
    "segmentLengthInFeet": "00574",
    "segmentOrientation": "W",
    "segmentTypeCode": "U",
    "selfCheckCodeOfBillingBbl": "5",
    "sideOfStreetIndicator": "L",
    "sideOfStreetOfVanityAddress": "L",
    "splitLowHouseNumber": "000300000AA",
    "stateSenatorialDistrict": "31",
    "streetName1In": "west 100 st",
    "streetStatus": "2",
    "taxMapNumberSectionAndVolume": "10703",
    "toLionNodeId": "0023852",
    "toPreferredLgcsFirstSetOf5": "01",
    "trafficDirection": "A",
    "underlyingstreetCode": "13577001",
    "workAreaFormatIndicatorIn": "C",
    "xCoordinate": "0992059",
    "xCoordinateHighAddressEnd": "0991683",
    "xCoordinateLowAddressEnd": "0992186",
    "xCoordinateOfCenterofCurvature": "0000000",
    "yCoordinate": "0230011",
    "yCoordinateHighAddressEnd": "0230221",
    "yCoordinateLowAddressEnd": "0229944",
    "yCoordinateOfCenterofCurvature": "0000000",
    "zipCode": "10025"
  }
}

Example XML response

<geosupportResponse>
  <address>
    <assemblyDistrict>28</assemblyDistrict>
    <attributeBytes>H</attributeBytes>
    <bbl>4022250006</bbl>
    <bblBoroughCode>4</bblBoroughCode>
    <bblTaxBlock>02225</bblTaxBlock>
    <bblTaxLot>0006</bblTaxLot>
    <boeLgcPointer>1</boeLgcPointer>
    <boePreferredStreetName>71 ROAD</boePreferredStreetName>
    <boePreferredstreetCode>41504001</boePreferredstreetCode>
    <boroughCode1In>4</boroughCode1In>
    <buildingIdentificationNumber>4052426</buildingIdentificationNumber>
    <censusBlock2000>4005</censusBlock2000>
    <censusBlock2010>5001</censusBlock2010>
    <censusTract1990>739</censusTract1990>
    <censusTract2000>739</censusTract2000>
    <censusTract2010>739</censusTract2010>
    <cityCouncilDistrict>29</cityCouncilDistrict>
    <civilCourtDistrict>04</civilCourtDistrict>
    <coincidenceSegmentCount>1</coincidenceSegmentCount>
    <communityDistrict>406</communityDistrict>
    <communityDistrictBoroughCode>4</communityDistrictBoroughCode>
    <communityDistrictNumber>06</communityDistrictNumber>
    <communitySchoolDistrict>28</communitySchoolDistrict>
    <condominiumBillingBbl>0000000000</condominiumBillingBbl>
    <congressionalDistrict>06</congressionalDistrict>
    <cooperativeIdNumber>0000</cooperativeIdNumber>
    <cornerCode>SE</cornerCode>
    <crossStreetNamesFlagIn>E</crossStreetNamesFlagIn>
    <dcpPreferredLgc>01</dcpPreferredLgc>
    <dotStreetLightContractorArea>4</dotStreetLightContractorArea>
    <dynamicBlock>410</dynamicBlock>
    <electionDistrict>029</electionDistrict>
    <fireBattalion>50</fireBattalion>
    <fireCompanyNumber>151</fireCompanyNumber>
    <fireCompanyType>L</fireCompanyType>
    <fireDivision>13</fireDivision>
    <firstBoroughName>QUEENS</firstBoroughName>
    <firstStreetCode>41504001010</firstStreetCode>
    <firstStreetNameNormalized>71 ROAD</firstStreetNameNormalized>
    <fromLionNodeId>0067082</fromLionNodeId>
    <genericId>0070010</genericId>
    <geosupportFunctionCode>1B</geosupportFunctionCode>
    <geosupportReturnCode>00</geosupportReturnCode>
    <geosupportReturnCode2>00</geosupportReturnCode2>
    <gi5DigitStreetCode1>15040</gi5DigitStreetCode1>
    <gi5DigitStreetCode2>59990</gi5DigitStreetCode2>
    <giBoroughCode1>4</giBoroughCode1>
    <giBoroughCode2>4</giBoroughCode2>
    <giBuildingIdentificationNumber1>4052426</giBuildingIdentificationNumber1>
    <giBuildingIdentificationNumber2>4052426</giBuildingIdentificationNumber2>
    <giDcpPreferredLgc1>01</giDcpPreferredLgc1>
    <giDcpPreferredLgc2>01</giDcpPreferredLgc2>
    <giHighHouseNumber1>109-20</giHighHouseNumber1>
    <giHighHouseNumber2>109-05</giHighHouseNumber2>
    <giLowHouseNumber1>109-06</giLowHouseNumber1>
    <giLowHouseNumber2>109-05</giLowHouseNumber2>
    <giSideOfStreetIndicator1>R</giSideOfStreetIndicator1>
    <giSideOfStreetIndicator2>L</giSideOfStreetIndicator2>
    <giStreetCode1>41504001</giStreetCode1>
    <giStreetCode2>45999001</giStreetCode2>
    <giStreetName1>71 ROAD</giStreetName1>
    <giStreetName2>QUEENS BOULEVARD</giStreetName2>
    <healthArea>1920</healthArea>
    <healthCenterDistrict>46</healthCenterDistrict>
    <highBblOfThisBuildingsCondominiumUnits>4022250006</highBblOfThisBuildingsCondominiumUnits>
    <highCrossStreetB5SC1>420390</highCrossStreetB5SC1>
    <highCrossStreetCode1>42039001</highCrossStreetCode1>
    <highCrossStreetName1>110 STREET</highCrossStreetName1>
    <highHouseNumberOfBlockfaceSortFormat>100109098AA</highHouseNumberOfBlockfaceSortFormat>
    <houseNumber>109-20</houseNumber>
    <houseNumberIn>109-20</houseNumberIn>
    <houseNumberSortFormat>100109020AA</houseNumberSortFormat>
    <interimAssistanceEligibilityIndicator>I</interimAssistanceEligibilityIndicator>
    <internalLabelXCoordinate>1028016</internalLabelXCoordinate>
    <internalLabelYCoordinate>0202046</internalLabelYCoordinate>
    <legacySegmentId>0113813</legacySegmentId>
    <lionKeyBoroughCode>4</lionKeyBoroughCode>
    <lionKeyFaceCode>5820</lionKeyFaceCode>
    <lionKeyForVanityAddressBoroughCode>4</lionKeyForVanityAddressBoroughCode>
    <lionKeyForVanityAddressFaceCode>5820</lionKeyForVanityAddressFaceCode>
    <lionKeyForVanityAddressSequenceNumber>02020</lionKeyForVanityAddressSequenceNumber>
    <lionKeySequenceNumber>02020</lionKeySequenceNumber>
    <listOf4Lgcs>01</listOf4Lgcs>
    <lowBblOfThisBuildingsCondominiumUnits>4022250006</lowBblOfThisBuildingsCondominiumUnits>
    <lowCrossStreetB5SC1>435780</lowCrossStreetB5SC1>
    <lowCrossStreetCode1>435780</lowCrossStreetCode1>
    <lowCrossStreetName1>BEND</lowCrossStreetName1>
    <lowHouseNumberOfBlockfaceSortFormat>100109000AA</lowHouseNumberOfBlockfaceSortFormat>
    <lowHouseNumberOfDefiningAddressRange>100109006AA</lowHouseNumberOfDefiningAddressRange>
    <nta>QN17</nta>
    <ntaName>Forest Hills</ntaName>
    <numberOfCrossStreetB5SCsHighAddressEnd>1</numberOfCrossStreetB5SCsHighAddressEnd>
    <numberOfCrossStreetB5SCsLowAddressEnd>1</numberOfCrossStreetB5SCsLowAddressEnd>
    <numberOfCrossStreetsHighAddressEnd>1</numberOfCrossStreetsHighAddressEnd>
    <numberOfCrossStreetsLowAddressEnd>1</numberOfCrossStreetsLowAddressEnd>
    <numberOfEntriesInListOfGeographicIdentifiers>0002</numberOfEntriesInListOfGeographicIdentifiers>
    <numberOfExistingStructuresOnLot>0001</numberOfExistingStructuresOnLot>
    <numberOfStreetFrontagesOfLot>02</numberOfStreetFrontagesOfLot>
    <physicalId>0080824</physicalId>
    <policePatrolBoroughCommand>6</policePatrolBoroughCommand>
    <policePrecinct>112</policePrecinct>
    <returnCode1a>00</returnCode1a>
    <returnCode1e>00</returnCode1e>
    <roadwayType>1</roadwayType>
    <rpadBuildingClassificationCode>D1</rpadBuildingClassificationCode>
    <rpadSelfCheckCodeForBbl>8</rpadSelfCheckCodeForBbl>
    <sanbornBoroughCode>4</sanbornBoroughCode>
    <sanbornPageNumber>066</sanbornPageNumber>
    <sanbornVolumeNumber>19</sanbornVolumeNumber>
    <sanitationCollectionSchedulingSectionAndSubsection>1E</sanitationCollectionSchedulingSectionAndSubsection>
    <sanitationDistrict>406</sanitationDistrict>
    <sanitationRecyclingCollectionSchedule>EW</sanitationRecyclingCollectionSchedule>
    <sanitationRegularCollectionSchedule>WS</sanitationRegularCollectionSchedule>
    <sanitationSnowPriorityCode>P</sanitationSnowPriorityCode>
    <segmentAzimuth>021</segmentAzimuth>
    <segmentIdentifier>0113813</segmentIdentifier>
    <segmentLengthInFeet>00455</segmentLengthInFeet>
    <segmentOrientation>1</segmentOrientation>
    <segmentTypeCode>U</segmentTypeCode>
    <sideOfStreetIndicator>R</sideOfStreetIndicator>
    <sideOfStreetOfVanityAddress>R</sideOfStreetOfVanityAddress>
    <splitLowHouseNumber>100109000AA</splitLowHouseNumber>
    <stateSenatorialDistrict>16</stateSenatorialDistrict>
    <streetAttributeIndicator>H</streetAttributeIndicator>
    <streetName1In>71st rd</streetName1In>
    <streetStatus>2</streetStatus>
    <taxMapNumberSectionAndVolume>41204</taxMapNumberSectionAndVolume>
    <toLionNodeId>0050496</toLionNodeId>
    <toPreferredLgcsFirstSetOf5>01</toPreferredLgcsFirstSetOf5>
    <trafficDirection>A</trafficDirection>
    <underlyingstreetCode>41504001</underlyingstreetCode>
    <workAreaFormatIndicatorIn>C</workAreaFormatIndicatorIn>
    <xCoordinate>1027969</xCoordinate>
    <xCoordinateHighAddressEnd>1028268</xCoordinateHighAddressEnd>
    <xCoordinateLowAddressEnd>1027844</xCoordinateLowAddressEnd>
    <xCoordinateOfCenterofCurvature>0000000</xCoordinateOfCenterofCurvature>
    <yCoordinate>0202112</yCoordinate>
    <yCoordinateHighAddressEnd>0202233</yCoordinateHighAddressEnd>
    <yCoordinateLowAddressEnd>0202066</yCoordinateLowAddressEnd>
    <yCoordinateOfCenterofCurvature>0000000</yCoordinateOfCenterofCurvature>
    <zipCode>11375</zipCode>
  </address>
</geosupportResponse>

1.2.2 - BBL

Path: /v1/bbl.{format}

Parameters:

Parameter Name Required/Optional Comments
borough required Valid values section 1.1.
block required Tax block.
lot required Tax lot.

Example Requests:

/v1/bbl.json?borough=manhattan&block=1889&lot=1&app_id=abc123&app_key=def456
/v1/bbl.xml?borough=manhattan&block=67&lot=1&app_id=abc123&app_key=def456

Example JSON response

{
   "bbl":
   {
       "bbl": "1018890001",
       "bblBoroughCode": "1",
       "bblBoroughCodeIn": "1",
       "bblTaxBlock": "01889",
       "bblTaxBlockIn": "1889",
       "bblTaxLot": "0001",
       "bblTaxLotIn": "1",
       "buildingIdentificationNumber": "1057127",
       "condominiumBillingBbl": "0000000000",
       "cooperativeIdNumber": "0000",
       "cornerCode": "NE",
       "crossStreetNamesFlagIn": "E",
       "firstBoroughName": "MANHATTAN",
       "geosupportFunctionCode": "BL",
       "geosupportReturnCode": "00",
       "gi5DigitStreetCode1": "29690",
       "gi5DigitStreetCode2": "35770",
       "giBoroughCode1": "1",
       "giBoroughCode2": "1",
       "giBuildingIdentificationNumber1": "1057127",
       "giBuildingIdentificationNumber2": "1057127",
       "giDcpPreferredLgc1": "01",
       "giDcpPreferredLgc2": "01",
       "giGeographicIdentifier1": "V",
       "giHighHouseNumber1": "280",
       "giHighHouseNumber2": "337",
       "giLowHouseNumber1": "280",
       "giLowHouseNumber2": "327",
       "giSideOfStreetIndicator1": "R",
       "giSideOfStreetIndicator2": "R",
       "giStreetCode1": "12969001",
       "giStreetCode2": "13577001",
       "highBblOfThisBuildingsCondominiumUnits": "1018890001",
       "internalLabelXCoordinate": "0991817",
       "internalLabelYCoordinate": "0230239",
       "lowBblOfThisBuildingsCondominiumUnits": "1018890001",
       "lowHouseNumberOfDefiningAddressRange": "000280000AA",
       "numberOfEntriesInListOfGeographicIdentifiers": "0002",
       "numberOfExistingStructuresOnLot": "0001",
       "numberOfStreetFrontagesOfLot": "02",
       "rpadBuildingClassificationCode": "D3",
       "rpadSelfCheckCodeForBbl": "3",
       "sanbornBoroughCode": "1",
       "sanbornPageNumber": "034",
       "sanbornVolumeNumber": "07",
       "sanbornVolumeNumberSuffix": "S",
       "taxMapNumberSectionAndVolume": "10703",
       "workAreaFormatIndicatorIn": "C"
   }
}

Example XML response

<geosupportResponse>
  <bbl>
    <bbl>1000670001</bbl>
    <bblBoroughCode>1</bblBoroughCode>
    <bblBoroughCodeIn>1</bblBoroughCodeIn>
    <bblTaxBlock>00067</bblTaxBlock>
    <bblTaxBlockIn>67</bblTaxBlockIn>
    <bblTaxLot>0001</bblTaxLot>
    <bblTaxLotIn>1</bblTaxLotIn>
    <buildingIdentificationNumber>1079043</buildingIdentificationNumber>
    <condominiumBillingBbl>0000000000</condominiumBillingBbl>
    <cooperativeIdNumber>0000</cooperativeIdNumber>
    <cornerCode>CR</cornerCode>
    <crossStreetNamesFlagIn>E</crossStreetNamesFlagIn>
    <dcpCommercialStudyArea>11004</dcpCommercialStudyArea>
    <firstBoroughName>MANHATTAN</firstBoroughName>
    <geosupportFunctionCode>BL</geosupportFunctionCode>
    <geosupportReturnCode>00</geosupportReturnCode>
    <gi5DigitStreetCode1>24050</gi5DigitStreetCode1>
    <gi5DigitStreetCode2>25630</gi5DigitStreetCode2>
    <gi5DigitStreetCode3>45440</gi5DigitStreetCode3>
    <gi5DigitStreetCode4>45440</gi5DigitStreetCode4>
    <giBoroughCode1>1</giBoroughCode1>
    <giBoroughCode2>1</giBoroughCode2>
    <giBoroughCode3>1</giBoroughCode3>
    <giBoroughCode4>1</giBoroughCode4>
    <giBuildingIdentificationNumber1>1079043</giBuildingIdentificationNumber1>
    <giBuildingIdentificationNumber2>1079043</giBuildingIdentificationNumber2>
    <giBuildingIdentificationNumber3>1079043</giBuildingIdentificationNumber3>
    <giBuildingIdentificationNumber4>1079043</giBuildingIdentificationNumber4>
    <giDcpPreferredLgc1>01</giDcpPreferredLgc1>
    <giDcpPreferredLgc2>01</giDcpPreferredLgc2>
    <giDcpPreferredLgc3>01</giDcpPreferredLgc3>
    <giDcpPreferredLgc4>01</giDcpPreferredLgc4>
    <giHighHouseNumber1>68</giHighHouseNumber1>
    <giHighHouseNumber2>65</giHighHouseNumber2>
    <giHighHouseNumber3>99</giHighHouseNumber3>
    <giHighHouseNumber4>105</giHighHouseNumber4>
    <giLowHouseNumber1>50</giLowHouseNumber1>
    <giLowHouseNumber2>41</giLowHouseNumber2>
    <giLowHouseNumber3>85</giLowHouseNumber3>
    <giLowHouseNumber4>101</giLowHouseNumber4>
    <giSideOfStreetIndicator1>R</giSideOfStreetIndicator1>
    <giSideOfStreetIndicator2>L</giSideOfStreetIndicator2>
    <giSideOfStreetIndicator3>L</giSideOfStreetIndicator3>
    <giSideOfStreetIndicator4>L</giSideOfStreetIndicator4>
    <giStreetCode1>12405001</giStreetCode1>
    <giStreetCode2>12563001</giStreetCode2>
    <giStreetCode3>14544001</giStreetCode3>
    <giStreetCode4>14544001</giStreetCode4>
    <highBblOfThisBuildingsCondominiumUnits>1000670001</highBblOfThisBuildingsCondominiumUnits>
    <internalLabelXCoordinate>0982039</internalLabelXCoordinate>
    <internalLabelYCoordinate>0197441</internalLabelYCoordinate>
    <lowBblOfThisBuildingsCondominiumUnits>1000670001</lowBblOfThisBuildingsCondominiumUnits>
    <lowHouseNumberOfDefiningAddressRange>000050000AA</lowHouseNumberOfDefiningAddressRange>
    <numberOfEntriesInListOfGeographicIdentifiers>0004</numberOfEntriesInListOfGeographicIdentifiers>
    <numberOfExistingStructuresOnLot>0001</numberOfExistingStructuresOnLot>
    <numberOfStreetFrontagesOfLot>03</numberOfStreetFrontagesOfLot>
    <rpadBuildingClassificationCode>O3</rpadBuildingClassificationCode>
    <rpadSelfCheckCodeForBbl>7</rpadSelfCheckCodeForBbl>
    <sanbornBoroughCode>1</sanbornBoroughCode>
    <sanbornPageNumber>011</sanbornPageNumber>
    <sanbornVolumeNumber>01</sanbornVolumeNumber>
    <sanbornVolumeNumberSuffix>S</sanbornVolumeNumberSuffix>
    <taxMapNumberSectionAndVolume>10102</taxMapNumberSectionAndVolume>
    <workAreaFormatIndicatorIn>C</workAreaFormatIndicatorIn>
  </bbl>
</geosupportResponse>

1.2.3 - BIN

Path: /v1/bin.{format}

Parameters:

Parameter Name Required/Optional Comments
bin required Building identification number.

Example Requests:

/v1/bin.json?bin=1079043&app_id=abc123&app_key=def456
/v1/bin.xml?bin=1057127&app_id=abc123&app_key=def456

Example JSON response

{
   "bin":
   {
       "bbl": "1000670001",
       "bblBoroughCode": "1",
       "bblTaxBlock": "00067",
       "bblTaxLot": "0001",
       "buildingIdentificationNumber": "1079043",
       "buildingIdentificationNumberIn": "1079043",
       "condominiumBillingBbl": "0000000000",
       "cooperativeIdNumber": "0000",
       "cornerCode": "CR",
       "crossStreetNamesFlagIn": "E",
       "dcpCommercialStudyArea": "11004",
       "firstBoroughName": "MANHATTAN",
       "geosupportFunctionCode": "BN",
       "geosupportReturnCode": "00",
       "gi5DigitStreetCode1": "24050",
       "gi5DigitStreetCode2": "25630",
       "gi5DigitStreetCode3": "45440",
       "gi5DigitStreetCode4": "45440",
       "giBoroughCode1": "1",
       "giBoroughCode2": "1",
       "giBoroughCode3": "1",
       "giBoroughCode4": "1",
       "giBuildingIdentificationNumber1": "1079043",
       "giBuildingIdentificationNumber2": "1079043",
       "giBuildingIdentificationNumber3": "1079043",
       "giBuildingIdentificationNumber4": "1079043",
       "giDcpPreferredLgc1": "01",
       "giDcpPreferredLgc2": "01",
       "giDcpPreferredLgc3": "01",
       "giDcpPreferredLgc4": "01",
       "giHighHouseNumber1": "68",
       "giHighHouseNumber2": "65",
       "giHighHouseNumber3": "99",
       "giHighHouseNumber4": "105",
       "giLowHouseNumber1": "50",
       "giLowHouseNumber2": "41",
       "giLowHouseNumber3": "85",
       "giLowHouseNumber4": "101",
       "giSideOfStreetIndicator1": "R",
       "giSideOfStreetIndicator2": "L",
       "giSideOfStreetIndicator3": "L",
       "giSideOfStreetIndicator4": "L",
       "giStreetCode1": "12405001",
       "giStreetCode2": "12563001",
       "giStreetCode3": "14544001",
       "giStreetCode4": "14544001",
       "highBblOfThisBuildingsCondominiumUnits": "1000670001",
       "internalLabelXCoordinate": "0982039",
       "internalLabelYCoordinate": "0197441",
       "lowBblOfThisBuildingsCondominiumUnits": "1000670001",
       "lowHouseNumberOfDefiningAddressRange": "000050000AA",
       "numberOfEntriesInListOfGeographicIdentifiers": "0004",
       "numberOfExistingStructuresOnLot": "0001",
       "numberOfStreetFrontagesOfLot": "03",
       "rpadBuildingClassificationCode": "O3",
       "rpadSelfCheckCodeForBbl": "7",
       "sanbornBoroughCode": "1",
       "sanbornPageNumber": "011",
       "sanbornVolumeNumber": "01",
       "sanbornVolumeNumberSuffix": "S",
       "taxMapNumberSectionAndVolume": "10102",
       "workAreaFormatIndicatorIn": "C"
   }
}

Example XML response

<geosupportResponse>
  <bin>
    <bbl>1018890001</bbl>
    <bblBoroughCode>1</bblBoroughCode>
    <bblTaxBlock>01889</bblTaxBlock>
    <bblTaxLot>0001</bblTaxLot>
    <buildingIdentificationNumber>1057127</buildingIdentificationNumber>
    <buildingIdentificationNumberIn>1057127</buildingIdentificationNumberIn>
    <condominiumBillingBbl>0000000000</condominiumBillingBbl>
    <cooperativeIdNumber>0000</cooperativeIdNumber>
    <cornerCode>NE</cornerCode>
    <crossStreetNamesFlagIn>E</crossStreetNamesFlagIn>
    <firstBoroughName>MANHATTAN</firstBoroughName>
    <geosupportFunctionCode>BN</geosupportFunctionCode>
    <geosupportReturnCode>00</geosupportReturnCode>
    <gi5DigitStreetCode1>29690</gi5DigitStreetCode1>
    <gi5DigitStreetCode2>35770</gi5DigitStreetCode2>
    <giBoroughCode1>1</giBoroughCode1>
    <giBoroughCode2>1</giBoroughCode2>
    <giBuildingIdentificationNumber1>1057127</giBuildingIdentificationNumber1>
    <giBuildingIdentificationNumber2>1057127</giBuildingIdentificationNumber2>
    <giDcpPreferredLgc1>01</giDcpPreferredLgc1>
    <giDcpPreferredLgc2>01</giDcpPreferredLgc2>
    <giGeographicIdentifier1>V</giGeographicIdentifier1>
    <giHighHouseNumber1>280</giHighHouseNumber1>
    <giHighHouseNumber2>337</giHighHouseNumber2>
    <giLowHouseNumber1>280</giLowHouseNumber1>
    <giLowHouseNumber2>327</giLowHouseNumber2>
    <giSideOfStreetIndicator1>R</giSideOfStreetIndicator1>
    <giSideOfStreetIndicator2>R</giSideOfStreetIndicator2>
    <giStreetCode1>12969001</giStreetCode1>
    <giStreetCode2>13577001</giStreetCode2>
    <highBblOfThisBuildingsCondominiumUnits>1018890001</highBblOfThisBuildingsCondominiumUnits>
    <internalLabelXCoordinate>0991817</internalLabelXCoordinate>
    <internalLabelYCoordinate>0230239</internalLabelYCoordinate>
    <lowBblOfThisBuildingsCondominiumUnits>1018890001</lowBblOfThisBuildingsCondominiumUnits>
    <lowHouseNumberOfDefiningAddressRange>000280000AA</lowHouseNumberOfDefiningAddressRange>
    <numberOfEntriesInListOfGeographicIdentifiers>0002</numberOfEntriesInListOfGeographicIdentifiers>
    <numberOfExistingStructuresOnLot>0001</numberOfExistingStructuresOnLot>
    <numberOfStreetFrontagesOfLot>02</numberOfStreetFrontagesOfLot>
    <rpadBuildingClassificationCode>D3</rpadBuildingClassificationCode>
    <rpadSelfCheckCodeForBbl>3</rpadSelfCheckCodeForBbl>
    <sanbornBoroughCode>1</sanbornBoroughCode>
    <sanbornPageNumber>034</sanbornPageNumber>
    <sanbornVolumeNumber>07</sanbornVolumeNumber>
    <sanbornVolumeNumberSuffix>S</sanbornVolumeNumberSuffix>
    <taxMapNumberSectionAndVolume>10703</taxMapNumberSectionAndVolume>
    <workAreaFormatIndicatorIn>C</workAreaFormatIndicatorIn>
  </bin>
</geosupportResponse>

1.2.4 - Blockface

Path: /v1/blockface.{format}

Parameters:

Parameter Name Required/Optional Comments
onStreet required "On street" (street name of target blockface).
crossStreetOne required First cross street of blockface.
crossStreetTwo required Second cross street of blockface.
borough required Borough of onStreet. Valid values section 1.1.
boroughCrossStreetOne optional Borough of first cross street. Defaults to value of borough parameter if not supplied.
boroughCrossStreetTwo optional Borough of second cross street. Defaults to value of borough parameter if not supplied.
compassDirection optional Used to request information about only one side of the street. Valid values are: N, S, E or W.

Example Requests:

/v1/blockface.json?onStreet=amsterdam ave&crossStreetOne=w 110 st&crossStreetTwo=w 111 st&borough=manhattan&app_id=abc123&app_key=def456
/v1/blockface.xml?onStreet=amsterdam ave&crossStreetOne=w 110 st&crossStreetTwo=w 111 st&borough=manhattan&compassDirection=e&app_id=abc123&app_key=def456
/v1/blockface.xml?onStreet=eldert ln&crossStreetOne=etna street&crossStreetTwo=ridgewood ave&borough=queens&boroughCrossStreetOne=brooklyn&boughCrossStreetTwo=brooklyn&compassDirection=e&app_id=abc123&app_key=def456

Example JSON response

{
   "blockface":
   {
       "boroughCode1In": "1",
       "coincidentSegmentCount": "1",
       "crossStreetNamesFlagIn": "E",
       "dcpPreferredLgcForStreet1": "01",
       "dcpPreferredLgcForStreet2": "01",
       "dcpPreferredLgcForStreet3": "01",
       "dotStreetLightContractorArea": "1",
       "firstBoroughName": "MANHATTAN",
       "firstStreetCode": "11171001010",
       "firstStreetNameNormalized": "AMSTERDAM AVENUE",
       "fromNode": "0023924",
       "generatedRecordFlag": "L",
       "geosupportFunctionCode": "3",
       "geosupportReturnCode": "00",
       "highAddressEndCrossStreet1": "135990",
       "leftSegment1990CensusTract": "199",
       "leftSegment2000CensusBlock": "2001",
       "leftSegment2000CensusTract": "199",
       "leftSegment2010CensusBlock": "6000",
       "leftSegment2010CensusTract": "199",
       "leftSegmentAssemblyDistrict": "69",
       "leftSegmentCommunityDistrict": "109",
       "leftSegmentCommunityDistrictBoroughCode": "1",
       "leftSegmentCommunityDistrictNumber": "09",
       "leftSegmentCommunitySchoolDistrict": "03",
       "leftSegmentDynamicBlock": "202",
       "leftSegmentElectionDistrict": "088",
       "leftSegmentFireBattalion": "11",
       "leftSegmentFireCompanyNumber": "047",
       "leftSegmentFireCompanyType": "E",
       "leftSegmentFireDivision": "03",
       "leftSegmentHealthArea": "2310",
       "leftSegmentHighHouseNumber": "0001034",
       "leftSegmentInterimAssistanceEligibilityIndicator": "I",
       "leftSegmentLowHouseNumber": "0001020",
       "leftSegmentNta": "MN09",
       "leftSegmentPolicePatrolBoroughCommand": "2",
       "leftSegmentPolicePrecinct": "026",
       "leftSegmentZipCode": "10025",
       "lengthOfSegmentInFeet": "00273",
       "lionBoroughCode": "1",
       "lionFaceCode": "0535",
       "lionSequenceNumber": "02360",
       "locationalStatusOfSegment": "X",
       "lowAddressEndCrossStreet1": "114210",
       "numberOfCrossStreetsHighAddressEnd": "1",
       "numberOfCrossStreetsLowAddressEnd": "1",
       "numberOfStreetCodesAndNamesInList": "02",
       "rightSegment1990CensusTract": "19701",
       "rightSegment2000CensusBlock": "1003",
       "rightSegment2000CensusTract": "19701",
       "rightSegment2010CensusBlock": "1002",
       "rightSegment2010CensusTract": "19701",
       "rightSegmentAssemblyDistrict": "69",
       "rightSegmentCommunityDistrict": "109",
       "rightSegmentCommunityDistrictBoroughCode": "1",
       "rightSegmentCommunityDistrictNumber": "09",
       "rightSegmentCommunitySchoolDistrict": "03",
       "rightSegmentDynamicBlock": "104",
       "rightSegmentElectionDistrict": "089",
       "rightSegmentFireBattalion": "11",
       "rightSegmentFireCompanyNumber": "047",
       "rightSegmentFireCompanyType": "E",
       "rightSegmentFireDivision": "03",
       "rightSegmentHealthArea": "2320",
       "rightSegmentHighHouseNumber": "0001035",
       "rightSegmentInterimAssistanceEligibilityIndicator": "I",
       "rightSegmentLowHouseNumber": "0001021",
       "rightSegmentNta": "MN09",
       "rightSegmentPolicePatrolBoroughCommand": "2",
       "rightSegmentPolicePrecinct": "026",
       "rightSegmentZipCode": "10025",
       "sanitationSnowPriorityCode": "P",
       "secondStreetCode": "11421003010",
       "secondStreetNameNormalized": "WEST 110 STREET",
       "segmentAzimuth": "061",
       "segmentIdentifier": "0223271",
       "segmentOrientation": "N",
       "segmentTypeCode": "U",
       "streetCode1": "11421003",
       "streetCode6": "13599001",
       "streetName1": "WEST 110 STREET",
       "streetName1In": "amsterdam ave",
       "streetName2In": "w 110 st",
       "streetName3In": "w 111 st",
       "streetName6": "WEST 111 STREET",
       "thirdStreetCode": "13599001010",
       "thirdStreetNameNormalized": "WEST 111 STREET",
       "toNode": "0023926",
       "workAreaFormatIndicatorIn": "C"
   }
}

Example XML response

<geosupportResponse>
  <blockface>
    <boroughCode1In>1</boroughCode1In>
    <coincidentSegmentCount>1</coincidentSegmentCount>
    <compassDirectionIn>e</compassDirectionIn>
    <crossStreetNamesFlagIn>E</crossStreetNamesFlagIn>
    <dcpPreferredLgcForStreet1>01</dcpPreferredLgcForStreet1>
    <dcpPreferredLgcForStreet2>01</dcpPreferredLgcForStreet2>
    <dcpPreferredLgcForStreet3>01</dcpPreferredLgcForStreet3>
    <dotStreetLightContractorArea>1</dotStreetLightContractorArea>
    <firstBoroughName>MANHATTAN</firstBoroughName>
    <firstStreetCode>11171001010</firstStreetCode>
    <firstStreetNameNormalized>AMSTERDAM AVENUE</firstStreetNameNormalized>
    <fromNode>0023924</fromNode>
    <generatedRecordFlag>L</generatedRecordFlag>
    <geosupportFunctionCode>3</geosupportFunctionCode>
    <geosupportReturnCode>01</geosupportReturnCode>
    <highAddressEndCrossStreet1>135990</highAddressEndCrossStreet1>
    <leftSegment1990CensusTract>199</leftSegment1990CensusTract>
    <leftSegment2000CensusBlock>2001</leftSegment2000CensusBlock>
    <leftSegment2000CensusTract>199</leftSegment2000CensusTract>
    <leftSegment2010CensusBlock>6000</leftSegment2010CensusBlock>
    <leftSegment2010CensusTract>199</leftSegment2010CensusTract>
    <leftSegmentAssemblyDistrict>69</leftSegmentAssemblyDistrict>
    <leftSegmentCommunityDistrict>109</leftSegmentCommunityDistrict>
    <leftSegmentCommunityDistrictBoroughCode>1</leftSegmentCommunityDistrictBoroughCode>
    <leftSegmentCommunityDistrictNumber>09</leftSegmentCommunityDistrictNumber>
    <leftSegmentCommunitySchoolDistrict>03</leftSegmentCommunitySchoolDistrict>
    <leftSegmentDynamicBlock>202</leftSegmentDynamicBlock>
    <leftSegmentElectionDistrict>088</leftSegmentElectionDistrict>
    <leftSegmentFireBattalion>11</leftSegmentFireBattalion>
    <leftSegmentFireCompanyNumber>047</leftSegmentFireCompanyNumber>
    <leftSegmentFireCompanyType>E</leftSegmentFireCompanyType>
    <leftSegmentFireDivision>03</leftSegmentFireDivision>
    <leftSegmentHealthArea>2310</leftSegmentHealthArea>
    <leftSegmentHighHouseNumber>0001034</leftSegmentHighHouseNumber>
    <leftSegmentInterimAssistanceEligibilityIndicator>I</leftSegmentInterimAssistanceEligibilityIndicator>
    <leftSegmentLowHouseNumber>0001020</leftSegmentLowHouseNumber>
    <leftSegmentNta>MN09</leftSegmentNta>
    <leftSegmentPolicePatrolBoroughCommand>2</leftSegmentPolicePatrolBoroughCommand>
    <leftSegmentPolicePrecinct>026</leftSegmentPolicePrecinct>
    <leftSegmentZipCode>10025</leftSegmentZipCode>
    <lengthOfSegmentInFeet>00273</lengthOfSegmentInFeet>
    <lionBoroughCode>1</lionBoroughCode>
    <lionFaceCode>0535</lionFaceCode>
    <lionSequenceNumber>02360</lionSequenceNumber>
    <locationalStatusOfSegment>X</locationalStatusOfSegment>
    <lowAddressEndCrossStreet1>114210</lowAddressEndCrossStreet1>
    <message>THESE STREETS INTERSECT ONCE-COMPASS DIRECTION IGNORED</message>
    <numberOfCrossStreetsHighAddressEnd>1</numberOfCrossStreetsHighAddressEnd>
    <numberOfCrossStreetsLowAddressEnd>1</numberOfCrossStreetsLowAddressEnd>
    <numberOfStreetCodesAndNamesInList>02</numberOfStreetCodesAndNamesInList>
    <reasonCode>H</reasonCode>
    <rightSegment1990CensusTract>19701</rightSegment1990CensusTract>
    <rightSegment2000CensusBlock>1003</rightSegment2000CensusBlock>
    <rightSegment2000CensusTract>19701</rightSegment2000CensusTract>
    <rightSegment2010CensusBlock>1002</rightSegment2010CensusBlock>
    <rightSegment2010CensusTract>19701</rightSegment2010CensusTract>
    <rightSegmentAssemblyDistrict>69</rightSegmentAssemblyDistrict>
    <rightSegmentCommunityDistrict>109</rightSegmentCommunityDistrict>
    <rightSegmentCommunityDistrictBoroughCode>1</rightSegmentCommunityDistrictBoroughCode>
    <rightSegmentCommunityDistrictNumber>09</rightSegmentCommunityDistrictNumber>
    <rightSegmentCommunitySchoolDistrict>03</rightSegmentCommunitySchoolDistrict>
    <rightSegmentDynamicBlock>104</rightSegmentDynamicBlock>
    <rightSegmentElectionDistrict>089</rightSegmentElectionDistrict>
    <rightSegmentFireBattalion>11</rightSegmentFireBattalion>
    <rightSegmentFireCompanyNumber>047</rightSegmentFireCompanyNumber>
    <rightSegmentFireCompanyType>E</rightSegmentFireCompanyType>
    <rightSegmentFireDivision>03</rightSegmentFireDivision>
    <rightSegmentHealthArea>2320</rightSegmentHealthArea>
    <rightSegmentHighHouseNumber>0001035</rightSegmentHighHouseNumber>
    <rightSegmentInterimAssistanceEligibilityIndicator>I</rightSegmentInterimAssistanceEligibilityIndicator>
    <rightSegmentLowHouseNumber>0001021</rightSegmentLowHouseNumber>
    <rightSegmentNta>MN09</rightSegmentNta>
    <rightSegmentPolicePatrolBoroughCommand>2</rightSegmentPolicePatrolBoroughCommand>
    <rightSegmentPolicePrecinct>026</rightSegmentPolicePrecinct>
    <rightSegmentZipCode>10025</rightSegmentZipCode>
    <sanitationSnowPriorityCode>P</sanitationSnowPriorityCode>
    <secondStreetCode>11421003010</secondStreetCode>
    <secondStreetNameNormalized>WEST 110 STREET</secondStreetNameNormalized>
    <segmentAzimuth>061</segmentAzimuth>
    <segmentIdentifier>0223271</segmentIdentifier>
    <segmentOrientation>N</segmentOrientation>
    <segmentTypeCode>U</segmentTypeCode>
    <streetCode1>11421003</streetCode1>
    <streetCode6>13599001</streetCode6>
    <streetName1>WEST 110 STREET</streetName1>
    <streetName1In>amsterdam ave</streetName1In>
    <streetName2In>w 110 st</streetName2In>
    <streetName3In>w 111 st</streetName3In>
    <streetName6>WEST 111 STREET</streetName6>
    <thirdStreetCode>13599001010</thirdStreetCode>
    <thirdStreetNameNormalized>WEST 111 STREET</thirdStreetNameNormalized>
    <toNode>0023926</toNode>
    <workAreaFormatIndicatorIn>C</workAreaFormatIndicatorIn>
  </blockface>
</geosupportResponse>

1.2.5 - Intersection

Path: /v1/intersection.{format}

Parameters:

Parameter Name Required/Optional Comments
crossStreetOne required First cross street
crossStreetTwo required Second cross street
borough required Borough of first cross street or of all cross streets if no other borough parameter is supplied.
boroughCrossStreetTwo optional Borough of second cross street. If not supplied, assumed to be same as borough parameter.
compassDirection optional for most requests Required for streets that intersect more than once. Valid values are: N, S, E or W.

Example Requests:

/v1/intersection.json?crossStreetOne=broadway&crossStreetTwo=w 99 st&borough=manhattan&app_id=abc123&app_key=def456
/v1/intersection.xml?crossStreetOne=rsd&crossStreetTwo=w 97 st&borough=manhattan&compassDirection=e&app_id=abc123&app_key=def456
/v1/intersection.json?crossStreetOne=jamaica ave&crossStreetTwo=eldert ln&borough=brooklyn&boroughCrossStreetTwo=queens&app_id=abc123&app_key=def456

Example JSON response

{
   "intersection":
   {
       "assemblyDistrict": "69",
       "boroughCode1In": "1",
       "censusTract1990": "187",
       "censusTract2000": "187",
       "censusTract2010": "187",
       "cityCouncilDistrict": "08",
       "civilCourtDistrict": "05",
       "communityDistrict": "107",
       "communityDistrictBoroughCode": "1",
       "communityDistrictNumber": "07",
       "communitySchoolDistrict": "03",
       "congressionalDistrict": "10",
       "crossStreetNamesFlagIn": "E",
       "dcpPreferredLgcForStreet1": "01",
       "dcpPreferredLgcForStreet2": "01",
       "dotStreetLightContractorArea": "1",
       "fireBattalion": "11",
       "fireCompanyNumber": "022",
       "fireCompanyType": "L",
       "fireDivision": "03",
       "firstBoroughName": "MANHATTAN",
       "firstStreetCode": "11361001010",
       "firstStreetNameNormalized": "BROADWAY",
       "geosupportFunctionCode": "2",
       "geosupportReturnCode": "00",
       "healthArea": "3110",
       "healthCenterDistrict": "16",
       "interimAssistanceEligibilityIndicator": "I",
       "intersectingStreet1": "113610",
       "intersectingStreet2": "135750",
       "lionNodeNumber": "0023424",
       "listOfPairsOfLevelCodes": "**MM",
       "numberOfIntersectingStreets": "2",
       "numberOfStreetCodesAndNamesInList": "02",
       "policePatrolBoroughCommand": "2",
       "policePrecinct": "024",
       "sanbornBoroughCode1": "1",
       "sanbornBoroughCode2": "1",
       "sanbornPageNumber1": "035",
       "sanbornPageNumber2": "036",
       "sanbornVolumeNumber1": "07",
       "sanbornVolumeNumber2": "07",
       "sanbornVolumeNumberSuffix1": "S",
       "sanbornVolumeNumberSuffix2": "S",
       "sanitationCollectionSchedulingSectionAndSubsection": "4B",
       "sanitationDistrict": "107",
       "secondStreetCode": "13575001010",
       "secondStreetNameNormalized": "WEST 99 STREET",
       "stateSenatorialDistrict": "30",
       "streetCode1": "11361001",
       "streetCode2": "13575001",
       "streetName1": "BROADWAY",
       "streetName1In": "broadway",
       "streetName2": "WEST 99 STREET",
       "streetName2In": "w 99 st",
       "workAreaFormatIndicatorIn": "C",
       "xCoordinate": "0992454",
       "yCoordinate": "0229500",
       "zipCode": "10025"
   }
}

Example XML response

<geosupportResponse>
  <intersection>
    <assemblyDistrict>69</assemblyDistrict>
    <attributeBytes>M</attributeBytes>
    <boroughCode1In>1</boroughCode1In>
    <censusTract1990>183</censusTract1990>
    <censusTract2000>183</censusTract2000>
    <censusTract2010>183</censusTract2010>
    <cityCouncilDistrict>09</cityCouncilDistrict>
    <civilCourtDistrict>05</civilCourtDistrict>
    <communityDistrict>107</communityDistrict>
    <communityDistrictBoroughCode>1</communityDistrictBoroughCode>
    <communityDistrictNumber>07</communityDistrictNumber>
    <communitySchoolDistrict>03</communitySchoolDistrict>
    <compassDirection>E</compassDirection>
    <compassDirectionIn>e</compassDirectionIn>
    <congressionalDistrict>10</congressionalDistrict>
    <crossStreetNamesFlagIn>E</crossStreetNamesFlagIn>
    <dcpPreferredLgcForStreet1>01</dcpPreferredLgcForStreet1>
    <dcpPreferredLgcForStreet2>01</dcpPreferredLgcForStreet2>
    <dotStreetLightContractorArea>1</dotStreetLightContractorArea>
    <fireBattalion>11</fireBattalion>
    <fireCompanyNumber>022</fireCompanyNumber>
    <fireCompanyType>L</fireCompanyType>
    <fireDivision>03</fireDivision>
    <firstBoroughName>MANHATTAN</firstBoroughName>
    <firstStreetCode>12969001020</firstStreetCode>
    <firstStreetNameNormalized>RSD</firstStreetNameNormalized>
    <geosupportFunctionCode>2</geosupportFunctionCode>
    <geosupportReturnCode>00</geosupportReturnCode>
    <healthArea>3110</healthArea>
    <healthCenterDistrict>16</healthCenterDistrict>
    <interimAssistanceEligibilityIndicator>I</interimAssistanceEligibilityIndicator>
    <intersectingStreet1>129690</intersectingStreet1>
    <intersectingStreet2>135710</intersectingStreet2>
    <intersectionReplicationCounter>2</intersectionReplicationCounter>
    <lionNodeNumber>0066281</lionNodeNumber>
    <listOfPairsOfLevelCodes>MMMM</listOfPairsOfLevelCodes>
    <numberOfIntersectingStreets>2</numberOfIntersectingStreets>
    <numberOfStreetCodesAndNamesInList>02</numberOfStreetCodesAndNamesInList>
    <policePatrolBoroughCommand>2</policePatrolBoroughCommand>
    <policePrecinct>024</policePrecinct>
    <sanbornBoroughCode1>1</sanbornBoroughCode1>
    <sanbornBoroughCode2>1</sanbornBoroughCode2>
    <sanbornPageNumber1>033</sanbornPageNumber1>
    <sanbornPageNumber2>104</sanbornPageNumber2>
    <sanbornVolumeNumber1>07</sanbornVolumeNumber1>
    <sanbornVolumeNumber2>07</sanbornVolumeNumber2>
    <sanbornVolumeNumberSuffix1>S</sanbornVolumeNumberSuffix1>
    <sanbornVolumeNumberSuffix2>N</sanbornVolumeNumberSuffix2>
    <sanitationCollectionSchedulingSectionAndSubsection>4B</sanitationCollectionSchedulingSectionAndSubsection>
    <sanitationDistrict>107</sanitationDistrict>
    <secondStreetCode>13571001010</secondStreetCode>
    <secondStreetNameNormalized>WEST 97 STREET</secondStreetNameNormalized>
    <stateSenatorialDistrict>31</stateSenatorialDistrict>
    <streetAttributeIndicator>M</streetAttributeIndicator>
    <streetCode1>12969001</streetCode1>
    <streetCode2>13571001</streetCode2>
    <streetName1>RSD</streetName1>
    <streetName1In>rsd</streetName1In>
    <streetName2>WEST 97 STREET</streetName2>
    <streetName2In>w 97 st</streetName2In>
    <workAreaFormatIndicatorIn>C</workAreaFormatIndicatorIn>
    <xCoordinate>0991418</xCoordinate>
    <yCoordinate>0229475</yCoordinate>
    <zipCode>10025</zipCode>
  </intersection>
</geosupportResponse>

1.2.6 - Place

Path: /v1/place.{format}

Parameters:

Parameter Name Required/Optional Comments
name required Place name of well-known NYC location.
borough required if 'zip' not given Valid values defined in section 1.1.
zip required if 'borough' not given Standard USPS 5-digit zip code or zip+4 (see this article). Must be a valid zip code for an area within New York City limits.

Example Requests:

/v1/place.json?name=empire state building&borough=manhattan&app_id=abc123&app_key=def456
/v1/place.xml?name=rfk bridge&borough=queens&app_id=abc123&app_key=def456

Example JSON response

{
   "place":
   {
       "assemblyDistrict": "75",
       "attributeBytes": "N",
       "bbl": "1008350041",
       "bblBoroughCode": "1",
       "bblTaxBlock": "00835",
       "bblTaxLot": "0041",
       "boeLgcPointer": "1",
       "boePreferredStreetName": "EMPIRE STATE BUILDING",
       "boePreferredstreetCode": "12032001",
       "boroughCode1In": "1",
       "buildingIdentificationNumber": "1015862",
       "businessImprovementDistrict": "113090",
       "censusBlock2000": "1001",
       "censusBlock2010": "1001",
       "censusTract1990": "76",
       "censusTract2000": "76",
       "censusTract2010": "76",
       "cityCouncilDistrict": "03",
       "civilCourtDistrict": "09",
       "coincidenceSegmentCount": "1",
       "communityDistrict": "105",
       "communityDistrictBoroughCode": "1",
       "communityDistrictNumber": "05",
       "communitySchoolDistrict": "02",
       "condominiumBillingBbl": "0000000000",
       "congressionalDistrict": "12",
       "cooperativeIdNumber": "0000",
       "cornerCode": "CR",
       "crossStreetNamesFlagIn": "E",
       "dcpCommercialStudyArea": "11021",
       "dcpPreferredLgc": "01",
       "dotStreetLightContractorArea": "1",
       "dynamicBlock": "110",
       "electionDistrict": "050",
       "fireBattalion": "07",
       "fireCompanyNumber": "024",
       "fireCompanyType": "L",
       "fireDivision": "01",
       "firstBoroughName": "MANHATTAN",
       "firstStreetCode": "12032001020",
       "firstStreetNameNormalized": "EMPIRE STATE BUILDING",
       "fromLionNodeId": "0021443",
       "fromPreferredLgcsFirstSetOf5": "0101",
       "genericId": "0001703",
       "geosupportFunctionCode": "1B",
       "geosupportReturnCode": "01",
       "geosupportReturnCode2": "00",
       "gi5DigitStreetCode1": "20320",
       "gi5DigitStreetCode2": "10410",
       "gi5DigitStreetCode3": "34430",
       "gi5DigitStreetCode4": "34450",
       "giBoroughCode1": "1",
       "giBoroughCode2": "1",
       "giBoroughCode3": "1",
       "giBoroughCode4": "1",
       "giBuildingIdentificationNumber1": "1015862",
       "giBuildingIdentificationNumber2": "1015862",
       "giBuildingIdentificationNumber3": "1015862",
       "giBuildingIdentificationNumber4": "1015862",
       "giDcpPreferredLgc1": "01",
       "giDcpPreferredLgc2": "01",
       "giDcpPreferredLgc3": "01",
       "giDcpPreferredLgc4": "01",
       "giGeographicIdentifier1": "N",
       "giHighHouseNumber2": "350",
       "giHighHouseNumber3": "31",
       "giHighHouseNumber4": "20",
       "giLowHouseNumber2": "338",
       "giLowHouseNumber3": "1",
       "giLowHouseNumber4": "2",
       "giSideOfStreetIndicator1": "L",
       "giSideOfStreetIndicator2": "L",
       "giSideOfStreetIndicator3": "R",
       "giSideOfStreetIndicator4": "L",
       "giStreetCode1": "12032001",
       "giStreetCode2": "11041001",
       "giStreetCode3": "13443001",
       "giStreetCode4": "13445001",
       "giStreetName1": "EMPIRE STATE BUILDING",
       "giStreetName2": "5 AVENUE",
       "giStreetName3": "WEST 33 STREET",
       "giStreetName4": "WEST 34 STREET",
       "healthArea": "5200",
       "healthCenterDistrict": "15",
       "highBblOfThisBuildingsCondominiumUnits": "1008350041",
       "highCrossStreetB5SC1": "117670",
       "highCrossStreetB5SC2": "134450",
       "highCrossStreetCode1": "11767001",
       "highCrossStreetCode2": "134450",
       "highCrossStreetName1": "EAST 34 STREET",
       "highCrossStreetName2": "WEST 34 STREET",
       "highHouseNumberOfBlockfaceSortFormat": "000000000AA",
       "interimAssistanceEligibilityIndicator": "I",
       "internalLabelXCoordinate": "0988196",
       "internalLabelYCoordinate": "0211970",
       "legacySegmentId": "0034023",
       "lionKeyBoroughCode": "1",
       "lionKeyFaceCode": "2470",
       "lionKeyForVanityAddressBoroughCode": "1",
       "lionKeyForVanityAddressFaceCode": "2470",
       "lionKeyForVanityAddressSequenceNumber": "01150",
       "lionKeySequenceNumber": "01150",
       "listOf4Lgcs": "01",
       "lowBblOfThisBuildingsCondominiumUnits": "1008350041",
       "lowCrossStreetB5SC1": "117650",
       "lowCrossStreetB5SC2": "134430",
       "lowCrossStreetCode1": "11765001",
       "lowCrossStreetCode2": "13443001",
       "lowCrossStreetName1": "EAST 33 STREET",
       "lowCrossStreetName2": "WEST 33 STREET",
       "lowHouseNumberOfBlockfaceSortFormat": "000000000AA",
       "lowHouseNumberOfDefiningAddressRange": "000001000AA",
       "message": "350 5 AVENUE IS THE UNDERLYING ADDRESS OF EMPIRE STATE BUILDING",
       "nta": "MN17",
       "ntaName": "Midtown-Midtown South",
       "numberOfCrossStreetB5SCsHighAddressEnd": "3",
       "numberOfCrossStreetB5SCsLowAddressEnd": "2",
       "numberOfCrossStreetsHighAddressEnd": "2",
       "numberOfCrossStreetsLowAddressEnd": "2",
       "numberOfEntriesInListOfGeographicIdentifiers": "0004",
       "numberOfExistingStructuresOnLot": "0001",
       "numberOfStreetFrontagesOfLot": "03",
       "physicalId": "0001934",
       "policePatrolBoroughCommand": "1",
       "policePrecinct": "014",
       "reasonCode": "V",
       "reasonCode1e": "V",
       "returnCode1a": "00",
       "returnCode1e": "01",
       "roadwayType": "1",
       "rpadBuildingClassificationCode": "O4",
       "rpadSelfCheckCodeForBbl": "3",
       "sanbornBoroughCode": "1",
       "sanbornPageNumber": "016",
       "sanbornVolumeNumber": "04",
       "sanitationCollectionSchedulingSectionAndSubsection": "1A",
       "sanitationDistrict": "105",
       "sanitationRecyclingCollectionSchedule": "EF",
       "sanitationRegularCollectionSchedule": "MWF",
       "sanitationSnowPriorityCode": "P",
       "segmentAzimuth": "061",
       "segmentIdentifier": "0034023",
       "segmentLengthInFeet": "00277",
       "segmentOrientation": "N",
       "segmentTypeCode": "U",
       "sideOfStreetIndicator": "L",
       "sideOfStreetOfVanityAddress": "L",
       "specialAddressGeneratedRecordFlag": "N",
       "splitLowHouseNumber": "000001000AA",
       "stateSenatorialDistrict": "27",
       "streetAttributeIndicator": "N",
       "streetName1In": "empire state building",
       "streetStatus": "2",
       "taxMapNumberSectionAndVolume": "10306",
       "toLionNodeId": "0021445",
       "toPreferredLgcsFirstSetOf5": "01",
       "trafficDirection": "A",
       "underlyingHnsOnTrueStreet": "000350000AA",
       "underlyingstreetCode": "11041001",
       "workAreaFormatIndicatorIn": "C",
       "xCoordinate": "0988205",
       "xCoordinateHighAddressEnd": "0988528",
       "xCoordinateLowAddressEnd": "0988394",
       "xCoordinateOfCenterofCurvature": "0000000",
       "yCoordinate": "0211959",
       "yCoordinateHighAddressEnd": "0211953",
       "yCoordinateLowAddressEnd": "0211711",
       "yCoordinateOfCenterofCurvature": "0000000",
       "zipCode": "10018"
   }
}

Example XML response

<geosupportResponse>
  <place>
    <assemblyDistrict>36</assemblyDistrict>
    <attributeBytes>B</attributeBytes>
    <boeLgcPointer>1</boeLgcPointer>
    <boePreferredStreetName>ROBERT F KENNEDY BRIDGE</boePreferredStreetName>
    <boePreferredstreetCode>49730001</boePreferredstreetCode>
    <boroughCode1In>4</boroughCode1In>
    <censusBlock2000>1004</censusBlock2000>
    <censusBlock2010>1004</censusBlock2010>
    <censusTract1990>99</censusTract1990>
    <censusTract2000>99</censusTract2000>
    <censusTract2010>99</censusTract2010>
    <cityCouncilDistrict>22</cityCouncilDistrict>
    <civilCourtDistrict>01</civilCourtDistrict>
    <coincidenceSegmentCount>1</coincidenceSegmentCount>
    <communityDistrict>401</communityDistrict>
    <communityDistrictBoroughCode>4</communityDistrictBoroughCode>
    <communityDistrictNumber>01</communityDistrictNumber>
    <communitySchoolDistrict>30</communitySchoolDistrict>
    <congressionalDistrict>12</congressionalDistrict>
    <crossStreetNamesFlagIn>E</crossStreetNamesFlagIn>
    <dcpPreferredLgc>01</dcpPreferredLgc>
    <dotStreetLightContractorArea>N</dotStreetLightContractorArea>
    <dynamicBlock>111</dynamicBlock>
    <electionDistrict>014</electionDistrict>
    <fireBattalion>49</fireBattalion>
    <fireCompanyNumber>312</fireCompanyNumber>
    <fireCompanyType>E</fireCompanyType>
    <fireDivision>14</fireDivision>
    <firstBoroughName>QUEENS</firstBoroughName>
    <firstStreetCode>49730001090</firstStreetCode>
    <firstStreetNameNormalized>RFK BRIDGE</firstStreetNameNormalized>
    <fromLionNodeId>0042193</fromLionNodeId>
    <fromPreferredLgcsFirstSetOf5>0176</fromPreferredLgcsFirstSetOf5>
    <genericId>0019558</genericId>
    <geosupportFunctionCode>1B</geosupportFunctionCode>
    <geosupportReturnCode>00</geosupportReturnCode>
    <geosupportReturnCode2>58</geosupportReturnCode2>
    <healthArea>0110</healthArea>
    <healthCenterDistrict>41</healthCenterDistrict>
    <highCrossStreetB5SC1>462090</highCrossStreetB5SC1>
    <highCrossStreetCode1>46209001</highCrossStreetCode1>
    <highCrossStreetName1>SHORE BOULEVARD</highCrossStreetName1>
    <highHouseNumberOfBlockfaceSortFormat>000000000AA</highHouseNumberOfBlockfaceSortFormat>
    <interimAssistanceEligibilityIndicator>I</interimAssistanceEligibilityIndicator>
    <legacySegmentId>0068651</legacySegmentId>
    <lionKeyBoroughCode>4</lionKeyBoroughCode>
    <lionKeyFaceCode>4647</lionKeyFaceCode>
    <lionKeyForVanityAddressBoroughCode>4</lionKeyForVanityAddressBoroughCode>
    <lionKeyForVanityAddressFaceCode>4647</lionKeyForVanityAddressFaceCode>
    <lionKeyForVanityAddressSequenceNumber>04040</lionKeyForVanityAddressSequenceNumber>
    <lionKeySequenceNumber>04040</lionKeySequenceNumber>
    <listOf4Lgcs>01</listOf4Lgcs>
    <lowCrossStreetB5SC1>197720</lowCrossStreetB5SC1>
    <lowCrossStreetB5SC2>462250</lowCrossStreetB5SC2>
    <lowCrossStreetCode1>19772001</lowCrossStreetCode1>
    <lowCrossStreetCode2>46225076</lowCrossStreetCode2>
    <lowCrossStreetName1>ROBERT F KENNEDY BRIDGE</lowCrossStreetName1>
    <lowCrossStreetName2>QN-NY CNTY SHORELINE</lowCrossStreetName2>
    <lowHouseNumberOfBlockfaceSortFormat>000000000AA</lowHouseNumberOfBlockfaceSortFormat>
    <message2>NON-ADDRESSABLE PLACE NAME, BRIDGE, TUNNEL OR MISC STRUCTURE NOT FOUND</message2>
    <nta>QN99</nta>
    <ntaName>park-cemetery-etc-Queens</ntaName>
    <numberOfCrossStreetB5SCsHighAddressEnd>1</numberOfCrossStreetB5SCsHighAddressEnd>
    <numberOfCrossStreetB5SCsLowAddressEnd>2</numberOfCrossStreetB5SCsLowAddressEnd>
    <numberOfCrossStreetsHighAddressEnd>1</numberOfCrossStreetsHighAddressEnd>
    <numberOfCrossStreetsLowAddressEnd>2</numberOfCrossStreetsLowAddressEnd>
    <numberOfStreetCodesAndNamesInList>03</numberOfStreetCodesAndNamesInList>
    <policePatrolBoroughCommand>6</policePatrolBoroughCommand>
    <policePrecinct>114</policePrecinct>
    <returnCode1a>58</returnCode1a>
    <returnCode1e>00</returnCode1e>
    <roadwayType>3</roadwayType>
    <sanitationCollectionSchedulingSectionAndSubsection>1D</sanitationCollectionSchedulingSectionAndSubsection>
    <sanitationDistrict>401</sanitationDistrict>
    <sanitationRecyclingCollectionSchedule>EF</sanitationRecyclingCollectionSchedule>
    <sanitationRegularCollectionSchedule>TF</sanitationRegularCollectionSchedule>
    <sanitationSnowPriorityCode>P</sanitationSnowPriorityCode>
    <segmentAzimuth>299</segmentAzimuth>
    <segmentIdentifier>0068651</segmentIdentifier>
    <segmentLengthInFeet>00047</segmentLengthInFeet>
    <segmentOrientation>4</segmentOrientation>
    <segmentTypeCode>G</segmentTypeCode>
    <sideOfStreetIndicator>R</sideOfStreetIndicator>
    <sideOfStreetOfVanityAddress>R</sideOfStreetOfVanityAddress>
    <specialAddressGeneratedRecordFlag>N</specialAddressGeneratedRecordFlag>
    <splitLowHouseNumber>000001000AA</splitLowHouseNumber>
    <stateSenatorialDistrict>12</stateSenatorialDistrict>
    <streetAttributeIndicator>B</streetAttributeIndicator>
    <streetCode1>19772001</streetCode1>
    <streetCode2>46225001</streetCode2>
    <streetCode6>46209001</streetCode6>
    <streetName1>ROBERT F KENNEDY BRIDGE</streetName1>
    <streetName1In>rfk bridge</streetName1In>
    <streetName2>BODY OF WATER</streetName2>
    <streetName6>SHORE BOULEVARD</streetName6>
    <streetStatus>2</streetStatus>
    <toLionNodeId>0042192</toLionNodeId>
    <toPreferredLgcsFirstSetOf5>01</toPreferredLgcsFirstSetOf5>
    <trafficDirection>T</trafficDirection>
    <underlyingHnsOnTrueStreet>000000000AA</underlyingHnsOnTrueStreet>
    <underlyingstreetCode>49730001</underlyingstreetCode>
    <workAreaFormatIndicatorIn>C</workAreaFormatIndicatorIn>
    <xCoordinate>1004824</xCoordinate>
    <xCoordinateHighAddressEnd>1004838</xCoordinateHighAddressEnd>
    <xCoordinateLowAddressEnd>1004815</xCoordinateLowAddressEnd>
    <xCoordinateOfCenterofCurvature>0000000</xCoordinateOfCenterofCurvature>
    <yCoordinate>0222858</yCoordinate>
    <yCoordinateHighAddressEnd>0222839</yCoordinateHighAddressEnd>
    <yCoordinateLowAddressEnd>0222880</yCoordinateLowAddressEnd>
    <yCoordinateOfCenterofCurvature>0000000</yCoordinateOfCenterofCurvature>
    <zipCode>11102</zipCode>
  </place>
</geosupportResponse>

1.3 - Single-field Search

Begining with version 1.10, any of the six request types documented in section 1.2 can be accessed using a single unparsed location string. Assuming that the Geoclient parser can guess the location type requested and the given single-field input parameter contains contains enough information to generate a successful Geosupport call, the service will return one or more sets of geocodes corresponding to the type of request that was made.

The single-field search will attempt to recognize the type of request being made using the following (simplified) parsing strategies listed in the order in which they are executed :

  1. A ten-digit number where the first digit is 1, 2, 3, 4 or 5 is recognized as a BBL request:
    1000670001
  2. A seven-digit number where the first digit is 1, 2, 3, 4 or 5 is recognized as a BIN request:
    1079043
  3. If the input string ends with a United States-related country identifier it is recognized and removed:
    314 W 100 ST, NY, NY 10025 [USA]
  4. If the input string ends with a five or seven-digit zipcode it is removed and kept as a <ZIP> token:
    314 W 100 ST, NY, NY [10025]
  5. If the input string ends with a valid two-character U.S. state abreviation it is recognized and removed1:
    314 W 100 ST, NY, [NY]
  6. If the input string ends with a known N.Y.C. city name it is removed and kept as a <CITY_NAME> token:
    93-02 69th Ave, [Forest Hills]
  7. If the input string ends with a known borough name or abreviation it is removed and kept as a <BOROUGH_NAME> token:
    80 Monroe Ave [SI]
  8. A BLOCKFACE request is identified using the pattern <ON_STREET> "between" <CROSS_STREET_ONE> "and" <CROSS_STREET_TWO>:
    [Broadway] between [W 100 St] and [W 101 St]
  9. A INTERSECTION request is identified using the pattern <CROSS_STREET_ONE> "and" <CROSS_STREET_TWO>:
    [Broadway] and [W 100 St]
  10. If the input string starts with a known house number format, it is recognized and kept as <BASIC_HOUSE_NUMBER> and (optionally) <HOUSE_NUMBER_SUFFIX> token(s):
    [93-02] 69th Ave
  11. Any remaining input is treated as an input street. If a <BASIC_HOUSE_NUMBER> token has been parsed, the input is recognized as an ADDRESS request, otherwise it is defaulted to a PLACE request
1Input ending in only a single instance of "NY" or "New York" (case-insensitive) is treated as a city name alias for Manhattan and not the state of New York. All matching is case-insensitive. Leading/trailing whitespace and any punctuation characters are ignored.

After the input has been parsed into tokens and the request type has been determined, the service resolves the BOROUGH_NAME and/or CITY_NAME token(s) into a New York City borough code (1=Manhattan, 2=Bronx, 3=Brooklyn, 4=Queens, 5=Staten Island).

The Geoclient service uses the concept of search levels to classify the degree to which any user input has been modified by the program before making the request to Geosupport. Roughly speaking, each additional level indicates a round of sub-searches undertaken when the service does not find an exact match.

1.3.1 - SFS (Single-field search)

Path: /v1/search.{format}

Parameters:

Parameter Name Required/Optional Comments
input required Unparsed location input.
exactMatchForSingleSuccess optional Whether a search returning only one possible successfully geocoded location is considered an exact match. Defaults to false.
exactMatchMaxLevel optional The maximum number of sub-search levels to perform if Geosupport rejects the input but suggests alternative street names, etc. Defaults to 3. Maximum is allowable value is 6.
returnPolicy optional Whether to return information on the search policy used to perform the search. Defaults to false.
returnPossiblesWithExact optional Whether to also return successfully geocoded possible matches when available in addition to the exact match. Defaults to false.
returnRejections optional Whether to return rejected response data from Geosupport. Defaults to false.
returnTokens optional Whether to return the parsed input tokens recognized by the parser. Defaults to false.
similarNamesDistance optional Maximum allowable Levenshtein distance between user input and a similar name suggestion from Geosupport. Defaults to 8. A higher number will allow more "guesses" to be made about an unrecognized street name.

Example Requests:

/v1/search.json?input=314 west 100 st manhattan&app_id=abc123&app_key=def456
/v1/search.xml?input=broadway and w 100 st&app_id=abc123&app_key=def456

2.0 - Understanding Geoclient Return Codes

There are two ways in which the Geoclient service communicates call status information: HTTP status codes and Geosupport API return codes. The former will always be provided; the only time in which latter will not be available is when the service itself is down or system error prevents the application from returning data to the client.

2.1 - HTTP Status Codes

The HTTP protocol implementation used by clients to call the Geoclient service will always provide status codes for all requests made to a valid Geoclient service URL. Full documentation of possible HTTP status codes are beyond the scope of this document, but section 10 of RFC 2616 provides detailed information.

In brief, here are the most commonly returned HTTP status codes:

HTTP Status Code Meaning
200 The call successfully reached the Geoclient application. Application-level return codes contain information on success or failure of the call (see section 2.2
400 A required query parameter is missing. See section 1.2 for information on call parameters.
404 An incorrect URL has been used. There is no service mapped to it.
500 The Geoclient service could not process the request due to an internal server error.

2.2 - Geosupport Return Codes

The following table decribes the various Geosupport return codes that are returned by the Geoclient service. Note that these codes come directly from the Geosupport application and they are documented in the UPG Section II.2.

GEOSUPPORT SYSTEM RETURN CODES, REASON CODES AND MESSAGES
GRC REASON CODE FUNCTION (* = wildcard) MESSAGE (LITERAL TEXT IN UPPERCASE, <Variable values in angled brackets>, [Comments in Square Brackets & Mixed Case])
00 All [Processing was unconditionally successful-no message issued]
[GRC 01s are warnings]
01 1 1, 1A, 1B, 1E ADDR NUMBER ALTERED: RANGE ASSUMED.USING DIGITS BEFORE DASH ONLY
2 1, 1A, 1B, 1E ADDR NUMBER ALTERED: HYPHEN INSERTED
3 1, 1A, 1B, 1E ADDR NUMBER ALTERED: HYPHEN DELETED
4 BB, BF YOU HAVE REACHED THE <FIRST or LAST> STREET NAME IN THE BOROUGH OF <boro. name>
5 1, 1A, 1B, 1E INPUT IS A COMPLEX. OUTPUT DATA MAY PERTAIN TO ONLY PART OF THE COMPLEX
6 1, 1A, 1B, 1E OUTPUT STREET NAME/CODE DIFFER FROM INPUT
7 1, 1A, 1B, 1E OUTPUT STREET NAME/CODE DIFFER FROM INPUT. ADDR NUMBER ALTERED: RANGE ASSUMED
OUTPUT STREET NAME/CODE DIFFER FROM INPUT. ADDR NUMBER ALTERED: HYPHEN INSERTED
OUTPUT STREET NAME/CODE DIFFER FROM INPUT. ADDR NUMBER ALTERED: HYPHEN DELETED
8 1A, 1B INPUT ADDRESS IS A PSEUDO-ADDRESS
9 1A, 1B INPUT ADDRESS IS A PSEUDO-ADDRESS. ADDR NUMBER ALTERED: RANGE ASSUMED
INPUT ADDRESS IS A PSEUDO-ADDRESS. ADDR NUMBER ALTERED: HYPHEN INSERTED
INPUT ADDRESS IS A PSEUDO-ADDRESS. ADDR NUMBER ALTERED: HYPHEN DELETED
A 1A, 1B, BL LOT HAS MORE ITEMS THAN LISTED
B 1A, 1B LOT HAS MORE ITEMS THAN LISTED.ADDR NUMBER ALTERED: RANGE ASSUMED
LOT HAS MORE ITEMS THAN LISTED.ADDR NUMBER ALTERED: HYPHEN INSERTED
LOT HAS MORE ITEMS THAN LISTED.ADDR NUMBER ALTERED: HYPHEN DELETED
C 1, 1A, 1B, 1E IN MARBLE HILL B LEGAL BORO IS MANHATTAN
IN MARBLE HILL - LEGAL BORO IS MANHATTAN. ADDR NUMBER ALTERED: RANGE ASSUMED
IN MARBLE HILL - LEGAL BORO IS MANHATTAN. ADDR NUMBER ALTERED: HYPHEN INSERTED
IN MARBLE HILL - LEGAL BORO IS MANHATTAN. ADDR NUMBER ALTERED: HYPHEN DELETED
ON RIKERS ISL - LEGAL BORO IS THE BRONX
ON RIKERS ISL - LEGAL BORO IS THE BRONX. ADDR NUMBER ALTERED: RANGE ASSUMED
ON RIKERS ISL - LEGAL BORO IS THE BRONX. ADDR NUMBER ALTERED: HYPHEN INSERTED
ON RIKERS ISL - LEGAL BORO IS THE BRONX. ADDR NUMBER ALTERED: HYPHEN DELETED
D 1*, 2, 3* PARTIAL STREET NAME USED TO MEET SNL REQUIREMENT
E 1, 1B, 1E OUTPUT ADDRESS RANGE IS SPLIT BY SCHOOL DISTRICT BOUNDARY
1B, 1E OUTPUT ADDRESS RANGE IS SPLIT BY ELECTION DISTRICT BOUNDARY
OUTPUT ADDRESS RANGE IS SPLIT BY SCHOOL & ELECTION DISTRICT BOUNDARIES
F BN THIS BIN IS TEMPORARY AND WILL BE REPLACED IN THE FUTURE
G 1, 1A, 1B, 1E ADDR NUMBER ALTERED: RANGE ASSUMED. NOTE: INCONSISTENT ODD/EVEN ADDR RANGE
H 2, 3S THESE STREETS INTERSECT ONCE-COMPASS DIRECTION IGNORED
I 1, 1A, 1B, 1E INPUT IS NON-ADDRESSABLE PLACE NAME - ADDRESS NUMBER IGNORED
J [not impl.] 1, 1A, 1B, 1E, 2, 3* <Full street name including EAST or WEST as first word> ASSUMED
[An input Bronx or Manhattan street name is missing EAST or WEST as its first word, and the intended full street name is unambiguous]
2, 3* <Full street name> AND <other full street name> ASSUMED
[Two input Bronx or Manhattan street names are missing EAST or WEST as their first words, and the intended names are unambiguous]
3* <Full street name>, <second full street name> AND <third full street name> ASSUMED
[Three input Bronx or Manhattan street names are missing EAST or WEST as their first words, and the intended names are unambiguous]
K 1, 1A, 1B, 1E EMBEDDED BLANK IN ADDRESS NUMBER HAS BEEN REPLACED WITH A HYPHEN
L or R 3, 3C <LEFT or RIGHT> SIDE OF SEGMENT IS IN <BROOKLYN or QUEENS>
or
<LEFT or RIGHT> SIDE OF SEGMENT IS IN <NASSAU or WESTCHESTER> - NO INFO RETURNED FOR THAT SIDE
M 1, 1A, 1B, 1E INPUT ADDRESS NUMBER IS ZERO
N 1, 1A, 1B, 1E, 2, 3*, D* STREET NAME(S) AND STREET CODE(S) BOTH SPECIFIED AS INPUT - <CODE(S) or NAMES> IGNORED
O 1, 1A, 1B, 1E CAUTION: <BLOCK FACE or ADDR RANGE> CONTAINS OUT-OF-SEQUENCE AND/OR OPPOSITE PARITY ADDRESSES
P 1, 1B, 1E IRREGULARLY CURVED STREET SEGMENT - SPATIAL COORDINATES RETURNED AS BLANKS
Q 3 THESE STREETS INVOLVE A `DOGLEG' - SHORTEST STRETCH PROVIDED
S 1, 1A, 1B, 1E <HNI or HNS> DISPLAY ADDRESS NUMBER BOTH SPECIFIED AS INPUT-<HNI or HNS> IGNORED
T 2 NON-INTERSECTION NAME IGNORED
U 3S STRETCH HAS MORE ITEMS THAN LISTED
V 1, 1B, 1E <Normalized input address number> <Norm'd input street name> IS ON <LEFT or RIGHT> SIDE OF <True street name>
[This warning is issued for vanity addresses, NAPs other than complexes (for which an underlying address is not available), and certain alternative addresses known as type `B' addresses.]
or
<Address number> <Street name> IS THE UNDERLYING ADDRESS OF <Normalized input NAP>
[This warning is issued for NAPs other than complexes, for which an underlying address is available.]
[GRCs greater than 01 are rejects or errors]
02 2 THESE STREETS INTERSECT TWICE-COMPASS DIRECTION REQUIRED
03 3 thru 9 2 THESE STREETS INTERSECT MORE THAN TWICE-CANNOT BE PROCESSED
[Reason Code value indicates number of times the streets intersect. The value `9' signifies 9 or more.]
04 1A, 1B, BL 1A/BL VERSION SWITCH INVALID - MUST BE S. ONLY STANDARD IS SUPPORTED
05 3S FOR FUNCTION 3S, ONLY FIRST BOROUGH CODE IS PERMITTED
07 1, 1A, 1B, 1E FOR A NAME OF A COMPLEX, 5-DIGIT STREET CODE INPUT IS NOT PERMITTED
08 All but B* INVALID STREET NAME NORMALIZATION FORMAT FLAG - MUST BE BLANK, C OR S
09 3C <Compass direction> SIDE OF STREET SEGMENT IS NOT IN <borough name>
10 All but B* INVALID SNL VALUE - MUST BE BETWEEN 4 AND 32 INCLUSIVE
11 1*, 2, 3* <Street name> NOT RECOGNIZED. THERE ARE NO SIMILAR NAMES
As of Version 10.0 this message is used for batch in addition to CICS
12 2 INTERSECTION NAME NOT FOUND
13 1 1, 1A, 1B, 1E ADDRESS NBR <value> CONTAINS AN INVALID CHARACTER <character> IN POSITION <position number>
2 1, 1A, 1B, 1E ADDRESS NBR <value> HAS MORE THAN 3 DIGITS AFTER DASH
3 1, 1A, 1B, 1E ADDRESS NBR <value> HAS TOO MANY DASHES
4 1, 1A, 1B, 1E ADDRESS NBR <value> HAS NO DIGITS AFTER THE DASH
6 1, 1A, 1B, 1E ADDRESS NBR <value> HAS TOO MANY DIGITS (MORE THAN 5)
7 1, 1A, 1B, 1E ADDRESS NBR <value> IS NOT COMPLETE AS ENTERED
8 1, 1A, 1B, 1E ADDRESS NBR <value> - PORTION AFTER HYPHEN EXCEEDS ALLOWABLE MAXIMUM
9 1, 1A, 1B, 1E, D* ADDRESS NBR <hse nr value> INVALID INTERNAL FORMAT
A 1, 1A, 1B, 1E, D* ADDRESS NBR <value> HAS AN UNKNOWN OR INVALID SUFFIX/ENDING
B 1, 1A, 1B, 1E INPUT CONTAINS NO ADDRESS NUMBER
C 1, 1A, 1B, 1E ADDRESS NBR <value> HAS AN EMBEDDED BLANK
D 1, 1A, 1B, 1E ADDRESS NBR HAS INVALID FORMAT FOR EDGEWATER PARK
E 1, 1A, 1B, 1E THIS STREET HAS HYPHENATED ADDRESS NBRS ONLY. TRY <address nbr with hyphen inserted to left of penultimate digit> OR <address nbr with hyphen inserted to left of plusquepenultimate digit>
F 1, 1A, 1B, 1E THIS STREET HAS UNHYPHENATED ADDRESS NBRS ONLY. TRY <digits of address number to left of dash only> OR <digits to left and right of dash concatenated without the dash>
G 1, 1A, 1B, 1E ADDRESS NUMBER HAS INVALID HYPHENATION FOR THIS STREET
[Input address number is an unhyphenated 2-digit number, but the input street has hyphenated address numbers only.]
14 3S INPUT DOES NOT DEFINE A STREET STRETCH, SINCE INPUT INTERSECTIONS ARE IDENTICAL
15 All but B* STREET NAME CANNOT BE NORMALIZED
16 1* STREET NAME IS MISSING
17 All BOROUGH CODE IS MISSING
18 BL TAX BLOCK NOT NUMERIC
19 BL TAX LOT NOT NUMERIC
20 BN BUILDING IDENTIFICATION NUMBER (BIN) IS MISSING
21 BN BUILDING IDENTIFICATION NUMBER (BIN) NOT FOUND
22 BN INVALID BIN FORMAT: NON-NUMERIC, FIRST DIGIT NOT 1-5 OR REST OF DIGITS ALL ZERO
23 BN TEMPORARY DEPARTMENT OF BUILDINGS BIN: EXISTS ONLY IN D.O.B FILES
24 3* ON STREET IS MISSING
25 2, 3* CROSS STREET 1 IS MISSING
26 2, 3* CROSS STREET 2 IS MISSING
27 All INVALID WORK AREA FORMAT INDICATOR - MUST BE C OR BLANK
28 1,1A, 1B, 1E A PARTIAL STREET NAME MAY NOT BE USED IN A FREE-FORM ADDRESS
29 1,1A, 1B, 1E, 3* INTERSECTION <INTERSECTION NAME> MAY NOT SERVE AS ON-STREET
30 2 <STREET NAME> IS NOT PART OF <INTERSECTION NAME>
31-37 As of Version 10.0 GRC 31 through GRC 37 are replaced by GRC 11 and GRC EE. See descriptions of GRC 11 and GRC EE.
38 3S <Compass direction value> IS AN INVALID COMPASS DIRECTION VALUE FOR <FIRST or SECOND> INPUT INTERSECTION
39 2, 3C INVALID COMPASS DIRECTION VALUE - MUST BE N, S, E OR W
40 2, 3C COMPASS DIRECTION VALUE IS INVALID FOR THIS INPUT LOCATION
41 1, 1A, 1B, 1E THIS STREET HAS NO ADDRESSES
42 blank 1, 1A, 1B, 1E ADDRESS NUMBER OUT OF RANGE
1 1, 1A, 1B, 1E ADDRESS NUMBER OUT OF RANGE. CORRECT DIGITS OR INSERT HYPHEN AS <AB-CD> OR <A-BCD>
[where input was of the form ABCD]
2 1, 1A, 1B, 1E ADDRESS NUMBER OUT OF RANGE. CORRECT DIGITS OR TRY <AB> OR <ABCD>
[where input was of the form AB-CD]
44 3C INPUT DOES NOT DEFINE A BLOCK FACE
45 3 INPUT DOES NOT DEFINE A STREET SEGMENT
46 3, 3C STREET COMBINATION NOT UNIQUE
[The input is ambiguous, i.e., it describes more than one valid street segment.]
47 1, 1A, 1B, 1E INVALID HNL VALUE - MUST BE BETWEEN 12 AND 16 INCLUSIVE
48 1, 1A, 1B, 1E INVALID HOUSE NUMBER JUSTIFICATION VALUE - MUST BE L, R OR BLANK
49 1, 1A, 1B, 1E ADDRESS NUMBER CANNOT BE NORMALIZED WITHIN REQUESTED HNL
50 1 thru 4 1, 1A, 1B, 1E, 2, 3* <Input street name> IS AN INVALID STREET NAME FOR THIS LOCATION
[The Reason Code indicates the number of valid street names returned in the Similar Names list.]
51 1, 1B, 1E, 2, 3, 3C CROSS STREET NAMES FLAG MUST BE E OR BLANK
52 All but 1, 1E, 2, 3, 3C CROSS STREET NAMES OPTION IS INVALID FOR THIS FUNCTION
55 2,3* NON-ADDRESSABLE PLACE NAME PROCESSING IS NOT AVAILABLE FOR THIS FUNCTION
56 1B, 1E ADDRESS IS SPLIT AMONG MULTIPLE ELECTION DISTRICTS. ADDRESS NBR SUFFIX REQUIRED
[The input address is associated with more than one Election District (ED). Function 1E requires an address number suffix to be included with this address to identify a portion of the building specific to one ED.]
57 As of Version 10.0 GRC 57 is replaced by GRC 67. See description of GRC 67.
58 1, 1A, 1B, 1E NON-ADDRESSABLE PLACE NAME NOT FOUND
59 1*,2,3* STREET NAME CANNOT BE NORMALIZED WITHIN REQUESTED SNL
61 3S STREET STRETCH NOT FOUND
62 2, 3S <Street name> & <other street name> DO NOT INTERSECT
64 1, 1A, 1B, 1E, 2, 3*, D* STREET CODE NOT FOUND
65 1,1E INVALID ROADBED REQUEST SWITCH. MUST BE R OR BLANK
66 3S <Street name> & <other street name> INTERSECT MORE THAN TWICE-CANNOT BE PROCESSED
67 E, G, P, R, S, T All batch only ERROR ACCESSING GEOSUPPORT FILE: <file name> NOTIFY SYSTEM SUPPORT
[This can be an installation error or a system error Notify System Support.]
As of Version 10.0 this message is used for batch in addition to CICS
68 3S <Street name> & <other street name> INTERSECT TWICE-COMPASS DIRECTION REQ'D
73 1A, 1B, BL LEGACY VERSION OF FUNCTIONS 1A AND BL IS DISCONTINUED. SEE TECH BULLETIN 05-1
75 1, 1A, 1B, 1E DUPLICATE ADDRESS-USE <pseudo-streetname1> OR <pseudo-streetname2>
76 All but 1, 1E ROADBED REQUEST SWITCH NOT IMPLEMENTED FOR THIS FUNCTION
77 BL TAX LOT NOT FOUND
88 blank All GEOSUPPORT SYSTEM ERROR. NOTIFY DCP/GSS USER SUPPORT
[An internal Geosupport problem, not a user error.]
1-8, C-H All GEOSUPPORT SYSTEM ERROR. NOTIFY DCP/GSS USER SUPPORT & REPORT REASON CODE = <value>
[An internal Geosupport problem, not a user error.]
9 All, CICS only CICS ERROR. NOTIFY DATA CENTER TECHNICAL SUPPORT
[A system error, not a user error.]
A All MODULE HAS NOT LOADED. NOTIFY TECHNICAL SUPPORT
[A system error, not a user error.]
B All SYSTEM ERROR. NOTIFY TECHNICAL SUPPORT & REPORT REASON CODE = B
[An internal Geosupport problem or a system error, not user error.]
89 1, 1B, 1E, 2, 3, 3C, 3S, BN LONG WORK-AREA-2 OPTION IS INVALID FOR THIS FUNCTION
90 1, 1A, 1B, 1E, 3, BL LONG WORK-AREA-2 FLAG MUST BE L OR BLANK
96 All, CICS only AN I/O ERROR HAS OCCURRED. TRY AGAIN
97 BB, BF INPUT IS BEYOND THE LAST STREET NAME IN THE BOROUGH OF <borough name>
98 All NO INPUT DATA RECEIVED
99 All INVALID BOROUGH CODE. MUST BE 1, 2, 3, 4 OR 5
EE 1 1*, 2, 3* <Street name> NOT RECOGNIZED. IS IT <similar street name>?
[Issued when there is precisely one similar name.]
As of Version 10.0 this message is used for batch in addition to CICS
2 thru 9, A 1*, 2, 3* <Street name> NOT RECOGNIZED. THERE ARE <number> SIMILAR NAMES
[Issued when there is more than one similar name. Reason Code indicates number of similar names. Reason Code 'A' signifies 10 similar names. The similar names are returned in WA1.]
As of Version 10.0 this message is used for batch in addition to CICS
?? N/A INVALID FUNCTION CODE

3.0 - Geoclient Function Reference

This section describes the data returned by each function.

3.1 - Address (Function 1B)

Function 1B returns blockface-level information and political geography, followed by property level information for a given input. Work Area 2 consists of the output of a Function 1E call with Mode Switch = 'X' followed by the output of a Function 1A call with Mode Switch = 'X'. The input requires borough or zip code, address number if needed, and street name or street code. Function 1B retrieves the tax lot and building information from the PAD file based on the input. The block face and political data are then retrieved from the GRID and the Election files for the address set by the building level information.

NameDescription
alleyCrossStreetsFlag Indicates if the segment has been split by alleys, or if the cross streets named in the segment have... Details.
alternativeBoroughFlag This flag indicates either that the input address is in Marble Hill or Rikers Island and the alterna... Details.
assemblyDistrict A district of the lower house of the New York State legislature. Consists of an aggregation of Elect... Details.
bbl The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax... Details.
bblBoroughCode The borough code for the borough on which this lot is located. See UPG Section VI.2. Details.
bblTaxBlock The tax block on which this property is located. See UPG Section VI.2. Details.
bblTaxLot The tax lot on which this property is located. See UPG Section VI.2. Details.
bikeLane
bikeLane2
bikeTrafficDirection
blockfaceId
boardOfElectionsPreferredLgc This item is the LGC (the sixth and seventh digits of the 10-digit street code) that corresponds to ... Details.
boePreferredStreetName
boePreferredstreetCode
buildingIdentificationNumber Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each... Details.
businessImprovementDistrict
censusBlock2000 Smallest geographic area defined by the U.S. Census Bureau for tabulating the 2000 census. Generally... Details.
censusBlock2010
censusBlockSuffix2000
censusBlockSuffix2010
censusTract1990 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
censusTract2000 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
censusTract2010 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
cityCouncilDistrict A district represented by a member of the New York City Council. Consists of an aggregation of Elect... Details.
civilCourtDistrict A district from which a Civil Court judge is elected. Consists of an aggregation of Election Distric... Details.
coincidentSegmentCount
communityDistrict The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communityDistrictBoroughCode The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communityDistrictNumber The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communitySchoolDistrict If the block face or the side of the street segment is split between two or more school districts, t... Details.
condominiumBillingBbl
condominiumFlag Details.
condominiumUnitIdNumber
congressionalDistrict A district of the U.S. House of Representatives. Consists of an aggregation of Election Districts. Details.
continuousParityIndicator1a An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low... Details.
continuousParityIndicator1e An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low... Details.
cooperativeIdNumber
cornerCode Details.
curveFlag This flag indicates whether the given geographic feature segment is in reality curved. If so, the cu... Details.
dcpCommercialStudyArea
dcpPreferredLgc Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
dcpZoningMap
dofCondominiumIdentificationNumber
dotStreetLightContractorArea Details.
dynamicBlock A dynamic block is an un-subdivided polygon formed by LION segments. Dynamic blocks are numbered uni... Details.
electionDistrict A set of districts defined by the NYC Board of Elections to conduct elections. There are approximate... Details.
fdnyId
featureTypeCode Identifies the type of geographic feature represented by the work area Details.
federalClassificationCode
fireBattalion An administrative fire district composed of Fire Companies. Details.
fireCompanyNumber The smallest kind of administrative fire district defined by the NYC Fire Department. There are two ... Details.
fireCompanyType Fire companies are characterized by the type of apparatus they use to fight fires. Details.
fireDivision An administrative fire district composed of Fire Battalions. Details.
firstBoroughName Normalized borough name Details.
fromActualSegmentNodeId
fromLionNodeId
fromPreferredLgcsFirstSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
fromPreferredLgcsSecondSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
genericId
geosupportReturnCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
geosupportReturnCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
healthArea Districts defined by the NYC Department of Health and used to report statistics on births, deaths, c... Details.
healthCenterDistrict Districts defined by the NYC Department of Health for administrative purposes. Health Center Distric... Details.
highBblOfThisBuildingsCondominiumUnits
highHouseNumberOfBlockfaceSortFormat
houseNumber If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
houseNumberSortFormat If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
hurricaneEvacuationZone Hurricane evacuation zones are the areas of the city that may need to be evacuated due to life safet... Details.
individualSegmentLength
instructionalRegion The Department of Education has divided the city into Instructional Regions which group together two... Details.
interimAssistanceEligibilityIndicator Indicates whether the input location is in a census tract that is Community Development eligible. Details.
interiorLotFlag Details.
internalLabelXCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
internalLabelYCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
irregularlyShapedLotFlag Details.
latitude Value of Y coordinate converted to decimal degrees. Details.
latitudeInternalLabel Value of internal label Y coordinate converted to decimal degrees. Details.
legacySegmentId
lionBoroughCode Details.
lionBoroughCodeForVanityAddress Details.
lionFaceCode A LION Face Code is assigned to each linear geographic feature represented in the LION file. These c... Details.
lionFaceCodeForVanityAddress Details.
lionKey Details.
lionKeyForVanityAddress Details.
lionSequenceNumber Details.
lionSequenceNumberForVanityAddress Details.
listOf4Lgcs Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
listOfGeographicIdentifiersOverflowFlag
listOfSecondSetOf5Lgcs Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
longitude Value of X coordinate converted to decimal degrees. Details.
longitudeInternalLabel Value of internal label X coordinate converted to decimal degrees. Details.
lowBblOfThisBuildingsCondominiumUnits
lowHouseNumberOfBlockfaceSortFormat
lowHouseNumberOfDefiningAddressRange Low house number of the defining address range in sort format. Details.
message Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
message2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
noCrossStreetCalculationFlag
nodeNumberOut
nta
ntaName
numberOfExistingStructuresOnLot
numberOfParkingLanesOnTheStreet
numberOfStreetFrontagesOfLot Indicates the number of streets on which the given lot has at least one frontage. Details.
numberOfTotalLanesOnTheStreet
numberOfTravelLanesOnTheStreet
nypdId
physicalId
policePatrolBoroughCommand These are sub-borough geographic areas defined by the Police Department. They are composed of Police... Details.
policePrecinct Police Patrol Borough Commands are sub-divided into Police Precincts which are defined by the Police... Details.
policeSector
policeServiceArea
pumaCode
radiusOfCircle
reasonCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1e Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1eQualifier
reasonCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCodeQualifier1a
returnCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
returnCode1e Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
roadwayType
rowType
rpadBuildingClassificationCode This is a set of land use/building classification codes defined by the Real Property Assessment Divi... Details.
rpadSelfCheckCodeForBbl For each BBL value, the Department of Finance has computed a Self-Check Code (SCC). This is a one-di... Details.
sanbornBoroughCode
sanbornPageNumber
sanbornPageNumberSuffix
sanbornVolumeNumber
sanbornVolumeNumberSuffix
sanitationBulkPickupSchedule
sanitationCollectionSchedulingSectionAndSubsection Districts defined by the Department of Sanitation for waste collection. Details.
sanitationDistrict Sanitation district is defined by the Department of Sanitation for waste collection. Details.
sanitationOrganicsCollectionSchedule Indicates which days of the week the Department of Sanitation will pick up organic waste at the give... Details.
sanitationRecyclingCollectionSchedule Indicates which days of the week the Department of Sanitation will pick up recycling at the given ad... Details.
sanitationRegularCollectionSchedule Indicates which days of the week the Department of Sanitation will pick up non-recycling waste at th... Details.
sanitationSection
sanitationSnowPriorityCode
secantLocationRelatedToCurve
segmentAzimuth This item represents the direction in which the segment lies on the earth's surface, expressed as an... Details.
segmentIdentifier
segmentLengthInFeet Except for curved segments (see Curve Flag), the Segment Length is computed from the Spatial Coordin... Details.
segmentOrientation This item is a set of codes grouping the possible azimuth values of a segment into eight categories.... Details.
segmentTypeCode Indicates type of segment. Details.
selfCheckCodeOfBillingBbl
sideOfStreetIndicator This field indicates on which side of the street, left or right, the block face containing the input... Details.
sideOfStreetOfVanityAddress This field indicates on which side of the street, left or right, the block face containing the input... Details.
specialAddressGeneratedRecordFlag A non-blank value in this flag indicates one of a variety of special addressing situations. Details.
speedLimit
splitElectionDistrictFlag Details.
splitLowHouseNumber
stateSenatorialDistrict A district of the upper house of the New York State legislature. Consists of an aggregation of Elect... Details.
streetStatus
streetWidth
streetWidthIrregular
streetWidthMaximum
strollingKey
strollingKeyBoroughCode
strollingKeyHighHouseNumber
strollingKeyOnStreetCode
strollingKeySideOfStreetIndicator
taxLogVersionNumberOfHighBbl
taxMapNumberSectionAndVolume
toActualSegmentNodeId
toLionNodeId
toPreferredLgcsFirstSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
toPreferredLgcsSecondSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
tpadBinStatus
tpadConflictFlag
tpadNewBin
tpadNewBinStatus
trafficDirection
turnRestrictions
underlyingHnsOnTrueStreet
underlyingStreetCode
uspsPreferredCityName U.S. Postal Service preferred city name. For Queens, the USPS Preferred City Name is based on the ZI... Details.
vacantLotFlag Details.
warningCode1a
warningCode1e
xCoordActualSegmentHighAddressEnd
xCoordActualSegmentLowAddressEnd
xCoordinate X coordinate (longitude) in the State Plane Coordinate system. Details.
xCoordinateHighAddressEnd X coordinate (longitude) in the State Plane Coordinate system. Details.
xCoordinateLowAddressEnd X coordinate (longitude) in the State Plane Coordinate system. Details.
xCoordinateOfCenterofCurvature X coordinate (longitude) in the State Plane Coordinate system. Details.
yCoordActualSegmentHighAddressEnd
yCoordActualSegmentLowAddressEnd
yCoordinate Y coordinate (latitude) in the State Plane Coordinate system. Details.
yCoordinateHighAddressEnd Y coordinate (latitude) in the State Plane Coordinate system. Details.
yCoordinateLowAddressEnd Y coordinate (latitude) in the State Plane Coordinate system. Details.
yCoordinateOfCenterofCurvature Y coordinate (latitude) in the State Plane Coordinate system. Details.
zCoordActualSegmentHighAddressEnd
zCoordActualSegmentLowAddressEnd
zCoordinate Z coordinate is currently not implemented. Details.
zCoordinateHighAddressEnd Z coordinate is currently not implemented. Details.
zCoordinateLowAddressEnd Z coordinate is currently not implemented. Details.
zCoordinateOfCenterofCurvature Z coordinate is currently not implemented. Details.
zipCode U.S. Postal Service's 5-digit zip code. Details.
List of up to 10 groups of street code/name pairs. Details.
numberOfStreetCodesAndNamesInList Indicates the actual number of streets returned for this location.
streetCode1 to 10 Details.
streetName1 to 10 Details.
List of up to 5 groups of high-address-end cross street code/name pairs. Details.
numberOfCrossStreetsHighAddressEnd Indicates the actual number of high-address-end cross streets returned for this location.
highCrossStreetCode1 to 5 8-digit B7SC street code. Details.
highCrossStreetName1 to 5 Street name. Details.
List of up to 5 groups of low-address-end cross street code/name pairs. Details.
numberOfCrossStreetsLowAddressEnd Indicates the actual number of low-address-end cross streets returned for this location.
lowCrossStreetCode1 to 5 8-digit B7SC street code. Details.
lowCrossStreetName1 to 5 Street name. Details.
List of up to 5 groups of high-address-end cross street B5SC codes. Details.
numberOfCrossStreetB5SCsHighAddressEnd Indicates the actual number of high-address-end cross street B5SCs returned for this location.
highCrossStreetB5SC1 to 5 6-digit B5SC street code. Details.
List of up to 5 groups of low-address-end cross street B5SC codes. Details.
numberOfCrossStreetB5SCsLowAddressEnd Indicates the actual number of low-address-end cross street B5SCs returned for this location.
lowCrossStreetB5SC1 to 5 6-digit B5SC street code. Details.
List of up to 21 groups of the following fields. Details.
numberOfEntriesInListOfGeographicIdentifiers Indicates the actual number of groups for this location.
giLowHouseNumber1 to 21 Low house number of segment.
giHighHouseNumber1 to 21 High house number of segment.
giStreetCode1 to 21 6-digit B5SC (1 digit borough + 5-digit street code) Details.
giBoroughCode1 to 21 Details.
gi5DigitStreetCode1 to 21 5-digit street code. Details.
giDcpPreferredLgc1 to 21 Details.
giBuildingIdentificationNumber1 to 21 Details.
giSideOfStreetIndicator1 to 21 Details.
giGeographicIdentifier1 to 21 Details.
giTpadBinStatus1 to 21 Details.
giStreetName1 to 21 Details.

3.2 - BBL (Function BL)

Function BL returns property level information for the given BBL (borough, block and tax lot).

NameDescription
alternativeBoroughFlag This flag indicates either that the input address is in Marble Hill or Rikers Island and the alterna... Details.
bbl The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax... Details.
bblBoroughCode The borough code for the borough on which this lot is located. See UPG Section VI.2. Details.
bblTaxBlock The tax block on which this property is located. See UPG Section VI.2. Details.
bblTaxLot The tax lot on which this property is located. See UPG Section VI.2. Details.
buildingIdentificationNumber Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each... Details.
businessImprovementDistrict
condominiumBillingBbl
condominiumFlag Details.
condominiumUnitIdNumber
continuousParityIndicator An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low... Details.
cooperativeIdNumber
cornerCode Details.
dcpCommercialStudyArea
dofCondominiumIdentificationNumber
firstBoroughName Normalized borough name Details.
geosupportReturnCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
geosupportReturnCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
highBblOfThisBuildingsCondominiumUnits
houseNumber If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
houseNumberSortFormat If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
interiorLotFlag Details.
internalLabelXCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
internalLabelYCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
irregularlyShapedLotFlag Details.
latitudeInternalLabel Value of internal label Y coordinate converted to decimal degrees. Details.
listOfGeographicIdentifiersOverflowFlag
longitudeInternalLabel Value of internal label X coordinate converted to decimal degrees. Details.
lowBblOfThisBuildingsCondominiumUnits
lowHouseNumberOfDefiningAddressRange Low house number of the defining address range in sort format. Details.
message Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
message2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
nodeNumberOut
numberOfExistingStructuresOnLot
numberOfStreetFrontagesOfLot Indicates the number of streets on which the given lot has at least one frontage. Details.
reasonCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
returnCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
rpadBuildingClassificationCode This is a set of land use/building classification codes defined by the Real Property Assessment Divi... Details.
rpadSelfCheckCodeForBbl For each BBL value, the Department of Finance has computed a Self-Check Code (SCC). This is a one-di... Details.
sanbornBoroughCode
sanbornPageNumber
sanbornPageNumberSuffix
sanbornVolumeNumber
sanbornVolumeNumberSuffix
selfCheckCodeOfBillingBbl
taxLogVersionNumberOfHighBbl
taxMapNumberSectionAndVolume
tpadBinStatus
tpadConflictFlag
tpadNewBin
tpadNewBinStatus
vacantLotFlag Details.
warningCode1a
List of up to 10 groups of street code/name pairs. Details.
numberOfStreetCodesAndNamesInList Indicates the actual number of streets returned for this location.
streetCode1 to 10 Details.
streetName1 to 10 Details.
List of up to 21 groups of the following fields. Details.
numberOfEntriesInListOfGeographicIdentifiers Indicates the actual number of groups for this location.
giLowHouseNumber1 to 21 Low house number of segment.
giHighHouseNumber1 to 21 High house number of segment.
giStreetCode1 to 21 6-digit B5SC (1 digit borough + 5-digit street code) Details.
giBoroughCode1 to 21 Details.
gi5DigitStreetCode1 to 21 5-digit street code. Details.
giDcpPreferredLgc1 to 21 Details.
giBuildingIdentificationNumber1 to 21 Details.
giSideOfStreetIndicator1 to 21 Details.
giGeographicIdentifier1 to 21 Details.
giTpadBinStatus1 to 21 Details.
giStreetName1 to 21 Details.

3.3 - BIN (Function BN)

Function BN returns property level information for the given BIN (building identification code).

NameDescription
alternativeBoroughFlag This flag indicates either that the input address is in Marble Hill or Rikers Island and the alterna... Details.
bbl The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax... Details.
bblBoroughCode The borough code for the borough on which this lot is located. See UPG Section VI.2. Details.
bblTaxBlock The tax block on which this property is located. See UPG Section VI.2. Details.
bblTaxLot The tax lot on which this property is located. See UPG Section VI.2. Details.
buildingIdentificationNumber Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each... Details.
businessImprovementDistrict
condominiumBillingBbl
condominiumFlag Details.
condominiumUnitIdNumber
continuousParityIndicator An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low... Details.
cooperativeIdNumber
cornerCode Details.
dcpCommercialStudyArea
dofCondominiumIdentificationNumber
firstBoroughName Normalized borough name Details.
geosupportReturnCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
geosupportReturnCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
highBblOfThisBuildingsCondominiumUnits
houseNumber If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
houseNumberSortFormat If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
interiorLotFlag Details.
internalLabelXCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
internalLabelYCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
irregularlyShapedLotFlag Details.
latitudeInternalLabel Value of internal label Y coordinate converted to decimal degrees. Details.
listOfGeographicIdentifiersOverflowFlag
longitudeInternalLabel Value of internal label X coordinate converted to decimal degrees. Details.
lowBblOfThisBuildingsCondominiumUnits
lowHouseNumberOfDefiningAddressRange Low house number of the defining address range in sort format. Details.
message Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
message2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
nodeNumberOut
numberOfExistingStructuresOnLot
numberOfStreetFrontagesOfLot Indicates the number of streets on which the given lot has at least one frontage. Details.
reasonCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
returnCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
rpadBuildingClassificationCode This is a set of land use/building classification codes defined by the Real Property Assessment Divi... Details.
rpadSelfCheckCodeForBbl For each BBL value, the Department of Finance has computed a Self-Check Code (SCC). This is a one-di... Details.
sanbornBoroughCode
sanbornPageNumber
sanbornPageNumberSuffix
sanbornVolumeNumber
sanbornVolumeNumberSuffix
selfCheckCodeOfBillingBbl
taxLogVersionNumberOfHighBbl
taxMapNumberSectionAndVolume
tpadBinStatus
tpadConflictFlag
tpadNewBin
tpadNewBinStatus
vacantLotFlag Details.
warningCode1a
List of up to 10 groups of street code/name pairs. Details.
numberOfStreetCodesAndNamesInList Indicates the actual number of streets returned for this location.
streetCode1 to 10 Details.
streetName1 to 10 Details.
List of up to 21 groups of the following fields. Details.
numberOfEntriesInListOfGeographicIdentifiers Indicates the actual number of groups for this location.
giLowHouseNumber1 to 21 Low house number of segment.
giHighHouseNumber1 to 21 High house number of segment.
giStreetCode1 to 21 6-digit B5SC (1 digit borough + 5-digit street code) Details.
giBoroughCode1 to 21 Details.
gi5DigitStreetCode1 to 21 5-digit street code. Details.
giDcpPreferredLgc1 to 21 Details.
giBuildingIdentificationNumber1 to 21 Details.
giSideOfStreetIndicator1 to 21 Details.
giGeographicIdentifier1 to 21 Details.
giTpadBinStatus1 to 21 Details.
giStreetName1 to 21 Details.

3.4 - Blockface (Function 3)

Function 3 returns information about a street segment defined by an 'on-street' and two cross streets. This implmentation supports calling function 3 in extended mode which provides some attributes not returned by a regular function 3.

NameDescription
alternativeBoroughFlag This flag indicates either that the input address is in Marble Hill or Rikers Island and the alterna... Details.
bbl The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax... Details.
bblBoroughCode The borough code for the borough on which this lot is located. See UPG Section VI.2. Details.
bblTaxBlock The tax block on which this property is located. See UPG Section VI.2. Details.
bblTaxLot The tax lot on which this property is located. See UPG Section VI.2. Details.
bikeLane
bikeLane2
bikeTrafficDirection
buildingIdentificationNumber Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each... Details.
coincidentSegmentCount
countyBoundaryIndicator This field is non-blank when the street segment lies along a borough boundary. The value of this fie... Details.
crossStreetReversalFlag This flag indicates the relationship between the order in which the user specified the input cross s... Details.
csclLgc1 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
csclLgc2 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
csclLgc3 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
csclLgc4 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
csclLgc5 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
curveFlag This flag indicates whether the given geographic feature segment is in reality curved. If so, the cu... Details.
dcpPreferredLgcForStreet1 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
dcpPreferredLgcForStreet2 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
dcpPreferredLgcForStreet3 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
dogLegFlag
dotStreetLightContractorArea Details.
duplicateKeyFlagOrContinuousParity
fdnyId
featureTypeCode Identifies the type of geographic feature represented by the work area Details.
federalClassificationCode
firstBoroughName Normalized borough name Details.
fromLgc1 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
fromLgc2 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
fromLgc3 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
fromLgc4 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
fromNode
fromXCoordinate "fromNode" and "toNode" XY coordinates. Internal Label Points have also been known as Annotation Poi... Details.
fromYCoordinate "fromNode" and "toNode" XY coordinates. Internal Label Points have also been known as Annotation Poi... Details.
generatedRecordFlag This flag indicates that the geography defined by the input 'on' street and two cross streets is not... Details.
genericId
geosupportReturnCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
geosupportReturnCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
houseNumber If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
houseNumberSortFormat If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
latitudeOfFromIntersection
latitudeOfToIntersection
leftSegment1990CensusTract
leftSegment2000CensusBlock
leftSegment2000CensusBlockSuffix
leftSegment2000CensusTract
leftSegment2010CensusBlock
leftSegment2010CensusBlockSuffix
leftSegment2010CensusTract
leftSegmentAssemblyDistrict
leftSegmentBlockfaceId
leftSegmentBoroughCode
leftSegmentCommunityDistrict
leftSegmentCommunityDistrictBoroughCode
leftSegmentCommunityDistrictNumber
leftSegmentCommunitySchoolDistrict
leftSegmentDynamicBlock
leftSegmentElectionDistrict
leftSegmentFireBattalion
leftSegmentFireCompanyNumber
leftSegmentFireCompanyType
leftSegmentFireDivision
leftSegmentHealthArea
leftSegmentHealthCenterDistrict
leftSegmentHighHouseNumber
leftSegmentInterimAssistanceEligibilityIndicator
leftSegmentLowHouseNumber
leftSegmentNta
leftSegmentNtaName
leftSegmentPolicePatrolBorough
leftSegmentPolicePatrolBoroughCommand
leftSegmentPolicePrecinct
leftSegmentPoliceSector
leftSegmentPumaCode
leftSegmentReservedForGeosupportUse
leftSegmentZipCode
legacyId
lengthOfSegmentInFeet
lgc1 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
lgc2 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
lgc3 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
lgc4 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
lionBoroughCode Details.
lionFaceCode A LION Face Code is assigned to each linear geographic feature represented in the LION file. These c... Details.
lionKey Details.
lionSequenceNumber Details.
locationalStatusOfSegment Indicates locational status of segment per codes below. Details.
longitudeOfFromIntersection
longitudeOfToIntersection
message Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
message2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
nodeNumberOut
numberOfParkingLanesOnStreet
numberOfTotalLanesOnStreet
numberOfTravelLanesOnStreet
nypdId
physicalId
reasonCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
rightOfWayType
rightSegment1990CensusTract
rightSegment2000CensusBlock
rightSegment2000CensusBlockSuffix
rightSegment2000CensusTract
rightSegment2010CensusBlock
rightSegment2010CensusBlockSuffix
rightSegment2010CensusTract
rightSegmentAssemblyDistrict
rightSegmentBlockfaceId
rightSegmentBoroughCode
rightSegmentCommunityDistrict
rightSegmentCommunityDistrictBoroughCode
rightSegmentCommunityDistrictNumber
rightSegmentCommunitySchoolDistrict
rightSegmentDynamicBlock
rightSegmentElectionDistrict
rightSegmentFireBattalion
rightSegmentFireCompanyNumber
rightSegmentFireCompanyType
rightSegmentFireDivision
rightSegmentHealthArea
rightSegmentHealthCenterDistrict
rightSegmentHighHouseNumber
rightSegmentInterimAssistanceEligibilityIndicator
rightSegmentLowHouseNumber
rightSegmentNta
rightSegmentNtaName
rightSegmentPolicePatrolBorough
rightSegmentPolicePatrolBoroughCommand
rightSegmentPolicePrecinct
rightSegmentPoliceSector
rightSegmentPumaCode
rightSegmentReservedForGeosupportUse
rightSegmentZipCode
roadwayType
sanitationSnowPriorityCode
segmentAzimuth This item represents the direction in which the segment lies on the earth's surface, expressed as an... Details.
segmentIdentifier
segmentOrientation This item is a set of codes grouping the possible azimuth values of a segment into eight categories.... Details.
segmentTypeCode Indicates type of segment. Details.
speedLimit
streetStatus
streetWidth
streetWidthIrregular
streetWidthMaximum
toLgc1 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
toLgc2 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
toLgc3 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
toLgc4 Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
toNode
toXCoordinate "fromNode" and "toNode" XY coordinates. Internal Label Points have also been known as Annotation Poi... Details.
toYCoordinate "fromNode" and "toNode" XY coordinates. Internal Label Points have also been known as Annotation Poi... Details.
trafficDirection
List of up to 10 groups of street code/name pairs. Details.
numberOfStreetCodesAndNamesInList Indicates the actual number of streets returned for this location.
streetCode1 to 10 Details.
streetName1 to 10 Details.
List of up to 5 groups of high-address-end cross street B5SC codes. Details.
numberOfCrossStreetB5SCsHighAddressEnd Indicates the actual number of high-address-end cross street B5SCs returned for this location.
highCrossStreetB5SC1 to 5 6-digit B5SC street code. Details.
List of up to 5 groups of low-address-end cross street B5SC codes. Details.
numberOfCrossStreetB5SCsLowAddressEnd Indicates the actual number of low-address-end cross street B5SCs returned for this location.
lowCrossStreetB5SC1 to 5 6-digit B5SC street code. Details.

3.5 - Intersection (Function 2)

Function 2 returns information about an intersection defined by two intersecting streets.

NameDescription
alternativeBoroughFlag This flag indicates either that the input address is in Marble Hill or Rikers Island and the alterna... Details.
assemblyDistrict A district of the lower house of the New York State legislature. Consists of an aggregation of Elect... Details.
atomicPolygon
bbl The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax... Details.
bblBoroughCode The borough code for the borough on which this lot is located. See UPG Section VI.2. Details.
bblTaxBlock The tax block on which this property is located. See UPG Section VI.2. Details.
bblTaxLot The tax lot on which this property is located. See UPG Section VI.2. Details.
buildingIdentificationNumber Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each... Details.
censusTract1990 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
censusTract2000 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
censusTract2010 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
cityCouncilDistrict A district represented by a member of the New York City Council. Consists of an aggregation of Elect... Details.
civilCourtDistrict A district from which a Civil Court judge is elected. Consists of an aggregation of Election Distric... Details.
communityDistrict The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communityDistrictBoroughCode The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communityDistrictNumber The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communitySchoolDistrict If the block face or the side of the street segment is split between two or more school districts, t... Details.
compassDirection In the case of Function 2, the compass direction identifies, for a pair of input streets that inters... Details.
congressionalDistrict A district of the U.S. House of Representatives. Consists of an aggregation of Election Districts. Details.
dcpPreferredLgcForStreet1 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
dcpPreferredLgcForStreet2 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
distanceBetweenDuplicateIntersections
dotStreetLightContractorArea Details.
fireBattalion An administrative fire district composed of Fire Companies. Details.
fireCompanyNumber The smallest kind of administrative fire district defined by the NYC Fire Department. There are two ... Details.
fireCompanyType Fire companies are characterized by the type of apparatus they use to fight fires. Details.
fireDivision An administrative fire district composed of Fire Battalions. Details.
firstBoroughName Normalized borough name Details.
geosupportReturnCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
geosupportReturnCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
healthArea Districts defined by the NYC Department of Health and used to report statistics on births, deaths, c... Details.
healthCenterDistrict Districts defined by the NYC Department of Health for administrative purposes. Health Center Distric... Details.
houseNumber If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
houseNumberSortFormat If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
instructionalRegion The Department of Education has divided the city into Instructional Regions which group together two... Details.
interimAssistanceEligibilityIndicator Indicates whether the input location is in a census tract that is Community Development eligible. Details.
intersectingStreet1
intersectingStreet2
intersectingStreet3
intersectingStreet4
intersectingStreet5
intersectionReplicationCounter The Intersection Replication Counter is non-blank only if the two streets intersect more than once, ... Details.
latitude Value of Y coordinate converted to decimal degrees. Details.
lgcListForStreet1
lgcListForStreet2
lionNodeNumber A LION node is an endpoint of a geographic feature segment represented in LION. Most nodes in LION a... Details.
listOfPairsOfLevelCodes
longitude Value of X coordinate converted to decimal degrees. Details.
message Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
message2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
node1
node10
node11
node12
node13
node14
node15
node16
node17
node18
node19
node2
node20
node3
node4
node5
node6
node7
node8
node9
nodeNumberOut
nodesStreetsAndLgcs
numberOfIntersectingStreets Indicates the number of non-empty entries in the LIST OF INTERSECTING STREETS. Details.
policePatrolBoroughCommand These are sub-borough geographic areas defined by the Police Department. They are composed of Police... Details.
policePrecinct Police Patrol Borough Commands are sub-divided into Police Precincts which are defined by the Police... Details.
policeSector
preferredLgcsForIntersectingStreets
reasonCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode2w
reasonCodeQualifier2w
returnCode2w
sanbornBoroughCode1
sanbornBoroughCode2
sanbornPageNumber1
sanbornPageNumber2
sanbornPageNumberSuffix1
sanbornPageNumberSuffix2
sanbornVolumeNumber1
sanbornVolumeNumber2
sanbornVolumeNumberSuffix1
sanbornVolumeNumberSuffix2
sanitationCollectionSchedulingSectionAndSubsection Districts defined by the Department of Sanitation for waste collection. Details.
sanitationDistrict Sanitation district is defined by the Department of Sanitation for waste collection. Details.
sanitationSection
stateSenatorialDistrict A district of the upper house of the New York State legislature. Consists of an aggregation of Elect... Details.
trueReplicationCounter
turnRestrictions
warningCode2w
xCoordinate X coordinate (longitude) in the State Plane Coordinate system. Details.
yCoordinate Y coordinate (latitude) in the State Plane Coordinate system. Details.
zCoordinate Z coordinate is currently not implemented. Details.
zipCode U.S. Postal Service's 5-digit zip code. Details.
List of up to 10 groups of street code/name pairs. Details.
numberOfStreetCodesAndNamesInList Indicates the actual number of streets returned for this location.
streetCode1 to 10 Details.
streetName1 to 10 Details.

3.6 - Place (Function 1B)

Function 1B returns blockface-level information and political geography, followed by property level information for a given input. Work Area 2 consists of the output of a Function 1E call with Mode Switch = 'X' followed by the output of a Function 1A call with Mode Switch = 'X'. The input requires borough or zip code, address number if needed, and street name or street code. Function 1B retrieves the tax lot and building information from the PAD file based on the input. The block face and political data are then retrieved from the GRID and the Election files for the address set by the building level information.

NameDescription
alleyCrossStreetsFlag Indicates if the segment has been split by alleys, or if the cross streets named in the segment have... Details.
alternativeBoroughFlag This flag indicates either that the input address is in Marble Hill or Rikers Island and the alterna... Details.
assemblyDistrict A district of the lower house of the New York State legislature. Consists of an aggregation of Elect... Details.
bbl The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax... Details.
bblBoroughCode The borough code for the borough on which this lot is located. See UPG Section VI.2. Details.
bblTaxBlock The tax block on which this property is located. See UPG Section VI.2. Details.
bblTaxLot The tax lot on which this property is located. See UPG Section VI.2. Details.
bikeLane
bikeLane2
bikeTrafficDirection
blockfaceId
boardOfElectionsPreferredLgc This item is the LGC (the sixth and seventh digits of the 10-digit street code) that corresponds to ... Details.
boePreferredStreetName
boePreferredstreetCode
buildingIdentificationNumber Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each... Details.
businessImprovementDistrict
censusBlock2000 Smallest geographic area defined by the U.S. Census Bureau for tabulating the 2000 census. Generally... Details.
censusBlock2010
censusBlockSuffix2000
censusBlockSuffix2010
censusTract1990 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
censusTract2000 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
censusTract2010 Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts ... Details.
cityCouncilDistrict A district represented by a member of the New York City Council. Consists of an aggregation of Elect... Details.
civilCourtDistrict A district from which a Civil Court judge is elected. Consists of an aggregation of Election Distric... Details.
coincidentSegmentCount
communityDistrict The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communityDistrictBoroughCode The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communityDistrictNumber The first byte is the Community District Borough Code, and the second and third bytes are the Commun... Details.
communitySchoolDistrict If the block face or the side of the street segment is split between two or more school districts, t... Details.
condominiumBillingBbl
condominiumFlag Details.
condominiumUnitIdNumber
congressionalDistrict A district of the U.S. House of Representatives. Consists of an aggregation of Election Districts. Details.
continuousParityIndicator1a An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low... Details.
continuousParityIndicator1e An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low... Details.
cooperativeIdNumber
cornerCode Details.
curveFlag This flag indicates whether the given geographic feature segment is in reality curved. If so, the cu... Details.
dcpCommercialStudyArea
dcpPreferredLgc Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
dcpZoningMap
dofCondominiumIdentificationNumber
dotStreetLightContractorArea Details.
dynamicBlock A dynamic block is an un-subdivided polygon formed by LION segments. Dynamic blocks are numbered uni... Details.
electionDistrict A set of districts defined by the NYC Board of Elections to conduct elections. There are approximate... Details.
fdnyId
featureTypeCode Identifies the type of geographic feature represented by the work area Details.
federalClassificationCode
fireBattalion An administrative fire district composed of Fire Companies. Details.
fireCompanyNumber The smallest kind of administrative fire district defined by the NYC Fire Department. There are two ... Details.
fireCompanyType Fire companies are characterized by the type of apparatus they use to fight fires. Details.
fireDivision An administrative fire district composed of Fire Battalions. Details.
firstBoroughName Normalized borough name Details.
fromActualSegmentNodeId
fromLionNodeId
fromPreferredLgcsFirstSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
fromPreferredLgcsSecondSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
genericId
geosupportReturnCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
geosupportReturnCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
healthArea Districts defined by the NYC Department of Health and used to report statistics on births, deaths, c... Details.
healthCenterDistrict Districts defined by the NYC Department of Health for administrative purposes. Health Center Distric... Details.
highBblOfThisBuildingsCondominiumUnits
highHouseNumberOfBlockfaceSortFormat
houseNumber If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
houseNumberSortFormat If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in... Details.
hurricaneEvacuationZone Hurricane evacuation zones are the areas of the city that may need to be evacuated due to life safet... Details.
individualSegmentLength
instructionalRegion The Department of Education has divided the city into Instructional Regions which group together two... Details.
interimAssistanceEligibilityIndicator Indicates whether the input location is in a census tract that is Community Development eligible. Details.
interiorLotFlag Details.
internalLabelXCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
internalLabelYCoordinate The Internal Label Point is a location within a tax lot selected by the Department of City Planning ... Details.
irregularlyShapedLotFlag Details.
latitude Value of Y coordinate converted to decimal degrees. Details.
latitudeInternalLabel Value of internal label Y coordinate converted to decimal degrees. Details.
legacySegmentId
lionBoroughCode Details.
lionBoroughCodeForVanityAddress Details.
lionFaceCode A LION Face Code is assigned to each linear geographic feature represented in the LION file. These c... Details.
lionFaceCodeForVanityAddress Details.
lionKey Details.
lionKeyForVanityAddress Details.
lionSequenceNumber Details.
lionSequenceNumberForVanityAddress Details.
listOf4Lgcs Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
listOfGeographicIdentifiersOverflowFlag
listOfSecondSetOf5Lgcs Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitut... Details.
longitude Value of X coordinate converted to decimal degrees. Details.
longitudeInternalLabel Value of internal label X coordinate converted to decimal degrees. Details.
lowBblOfThisBuildingsCondominiumUnits
lowHouseNumberOfBlockfaceSortFormat
lowHouseNumberOfDefiningAddressRange Low house number of the defining address range in sort format. Details.
message Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
message2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
noCrossStreetCalculationFlag
nodeNumberOut
nta
ntaName
numberOfExistingStructuresOnLot
numberOfParkingLanesOnTheStreet
numberOfStreetFrontagesOfLot Indicates the number of streets on which the given lot has at least one frontage. Details.
numberOfTotalLanesOnTheStreet
numberOfTravelLanesOnTheStreet
nypdId
physicalId
policePatrolBoroughCommand These are sub-borough geographic areas defined by the Police Department. They are composed of Police... Details.
policePrecinct Police Patrol Borough Commands are sub-divided into Police Precincts which are defined by the Police... Details.
policeSector
policeServiceArea
pumaCode
radiusOfCircle
reasonCode Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1e Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCode1eQualifier
reasonCode2 Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
reasonCodeQualifier1a
returnCode1a Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
returnCode1e Indicates success or failure of all function calls. Also indicates warnings and provides warning mes... Details.
roadwayType
rowType
rpadBuildingClassificationCode This is a set of land use/building classification codes defined by the Real Property Assessment Divi... Details.
rpadSelfCheckCodeForBbl For each BBL value, the Department of Finance has computed a Self-Check Code (SCC). This is a one-di... Details.
sanbornBoroughCode
sanbornPageNumber
sanbornPageNumberSuffix
sanbornVolumeNumber
sanbornVolumeNumberSuffix
sanitationBulkPickupSchedule
sanitationCollectionSchedulingSectionAndSubsection Districts defined by the Department of Sanitation for waste collection. Details.
sanitationDistrict Sanitation district is defined by the Department of Sanitation for waste collection. Details.
sanitationOrganicsCollectionSchedule Indicates which days of the week the Department of Sanitation will pick up organic waste at the give... Details.
sanitationRecyclingCollectionSchedule Indicates which days of the week the Department of Sanitation will pick up recycling at the given ad... Details.
sanitationRegularCollectionSchedule Indicates which days of the week the Department of Sanitation will pick up non-recycling waste at th... Details.
sanitationSection
sanitationSnowPriorityCode
secantLocationRelatedToCurve
segmentAzimuth This item represents the direction in which the segment lies on the earth's surface, expressed as an... Details.
segmentIdentifier
segmentLengthInFeet Except for curved segments (see Curve Flag), the Segment Length is computed from the Spatial Coordin... Details.
segmentOrientation This item is a set of codes grouping the possible azimuth values of a segment into eight categories.... Details.
segmentTypeCode Indicates type of segment. Details.
selfCheckCodeOfBillingBbl
sideOfStreetIndicator This field indicates on which side of the street, left or right, the block face containing the input... Details.
sideOfStreetOfVanityAddress This field indicates on which side of the street, left or right, the block face containing the input... Details.
specialAddressGeneratedRecordFlag A non-blank value in this flag indicates one of a variety of special addressing situations. Details.
speedLimit
splitElectionDistrictFlag Details.
splitLowHouseNumber
stateSenatorialDistrict A district of the upper house of the New York State legislature. Consists of an aggregation of Elect... Details.
streetStatus
streetWidth
streetWidthIrregular
streetWidthMaximum
strollingKey
strollingKeyBoroughCode
strollingKeyHighHouseNumber
strollingKeyOnStreetCode
strollingKeySideOfStreetIndicator
taxLogVersionNumberOfHighBbl
taxMapNumberSectionAndVolume
toActualSegmentNodeId
toLionNodeId
toPreferredLgcsFirstSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
toPreferredLgcsSecondSetOf5 Identifies the local group of street names designated by the Department of City Planning as 'preferr... Details.
tpadBinStatus
tpadConflictFlag
tpadNewBin
tpadNewBinStatus
trafficDirection
turnRestrictions
underlyingHnsOnTrueStreet
underlyingStreetCode
uspsPreferredCityName U.S. Postal Service preferred city name. For Queens, the USPS Preferred City Name is based on the ZI... Details.
vacantLotFlag Details.
warningCode1a
warningCode1e
xCoordActualSegmentHighAddressEnd
xCoordActualSegmentLowAddressEnd
xCoordinate X coordinate (longitude) in the State Plane Coordinate system. Details.
xCoordinateHighAddressEnd X coordinate (longitude) in the State Plane Coordinate system. Details.
xCoordinateLowAddressEnd X coordinate (longitude) in the State Plane Coordinate system. Details.
xCoordinateOfCenterofCurvature X coordinate (longitude) in the State Plane Coordinate system. Details.
yCoordActualSegmentHighAddressEnd
yCoordActualSegmentLowAddressEnd
yCoordinate Y coordinate (latitude) in the State Plane Coordinate system. Details.
yCoordinateHighAddressEnd Y coordinate (latitude) in the State Plane Coordinate system. Details.
yCoordinateLowAddressEnd Y coordinate (latitude) in the State Plane Coordinate system. Details.
yCoordinateOfCenterofCurvature Y coordinate (latitude) in the State Plane Coordinate system. Details.
zCoordActualSegmentHighAddressEnd
zCoordActualSegmentLowAddressEnd
zCoordinate Z coordinate is currently not implemented. Details.
zCoordinateHighAddressEnd Z coordinate is currently not implemented. Details.
zCoordinateLowAddressEnd Z coordinate is currently not implemented. Details.
zCoordinateOfCenterofCurvature Z coordinate is currently not implemented. Details.
zipCode U.S. Postal Service's 5-digit zip code. Details.
List of up to 10 groups of street code/name pairs. Details.
numberOfStreetCodesAndNamesInList Indicates the actual number of streets returned for this location.
streetCode1 to 10 Details.
streetName1 to 10 Details.
List of up to 5 groups of high-address-end cross street code/name pairs. Details.
numberOfCrossStreetsHighAddressEnd Indicates the actual number of high-address-end cross streets returned for this location.
highCrossStreetCode1 to 5 8-digit B7SC street code. Details.
highCrossStreetName1 to 5 Street name. Details.
List of up to 5 groups of low-address-end cross street code/name pairs. Details.
numberOfCrossStreetsLowAddressEnd Indicates the actual number of low-address-end cross streets returned for this location.
lowCrossStreetCode1 to 5 8-digit B7SC street code. Details.
lowCrossStreetName1 to 5 Street name. Details.
List of up to 5 groups of high-address-end cross street B5SC codes. Details.
numberOfCrossStreetB5SCsHighAddressEnd Indicates the actual number of high-address-end cross street B5SCs returned for this location.
highCrossStreetB5SC1 to 5 6-digit B5SC street code. Details.
List of up to 5 groups of low-address-end cross street B5SC codes. Details.
numberOfCrossStreetB5SCsLowAddressEnd Indicates the actual number of low-address-end cross street B5SCs returned for this location.
lowCrossStreetB5SC1 to 5 6-digit B5SC street code. Details.
List of up to 21 groups of the following fields. Details.
numberOfEntriesInListOfGeographicIdentifiers Indicates the actual number of groups for this location.
giLowHouseNumber1 to 21 Low house number of segment.
giHighHouseNumber1 to 21 High house number of segment.
giStreetCode1 to 21 6-digit B5SC (1 digit borough + 5-digit street code) Details.
giBoroughCode1 to 21 Details.
gi5DigitStreetCode1 to 21 5-digit street code. Details.
giDcpPreferredLgc1 to 21 Details.
giBuildingIdentificationNumber1 to 21 Details.
giSideOfStreetIndicator1 to 21 Details.
giGeographicIdentifier1 to 21 Details.
giTpadBinStatus1 to 21 Details.
giStreetName1 to 21 Details.

4.0 - Geoclient Data Dictionary

This section describes the set of possible data elements that are returned by each call type. It also provides a brief description of each element which includes format and coded value information.

alleyCrossStreetsFlag

Format 1 byte
Description

Indicates if the segment has been split by alleys, or if the cross streets named in the segment have been copied from a previous or subsequent segment because the segment itself has no cross streets.

Functions Address/Place
CodeMeaning
ASplit by Alley(s)
XCross Streets Modified
BlankNeither Split by Alleys or Cross Streets Modified

alternativeBoroughFlag

Format 1 byte
Description

This flag indicates either that the input address is in Marble Hill or Rikers Island and the alternative (rather than the legal) borough was specified (see UPG Section V.7), or that the input address is on Ruby Street in Brooklyn but it was specified using the alternative (Queens) street name 75 Street (see UPG Section V.8).

Functions Address/Place, Intersection, Blockface, BBL, BIN
CodeMeaning
CRuby Street address specified using 75 Street
MMarble Hill address with Bronx specified
RRikers Island address with Queens specified

assemblyDistrict

Format 2 bytes. RJZF
Description

A district of the lower house of the New York State legislature. Consists of an aggregation of Election Districts

Functions Address/Place

b7scOfTrueStreet

Format 8 bytes (B7SC)
Description

This item contains the B7SC of the street segment upon which the address specified is actually located. This is the street segment that is identified by the field SEGMENT-ID and by the fields LION FACE CODE and LION SEQUENCE NUMBER. In most cases, the B5SC portion of this item is identical to the B5SC specified in the key. However, the two B5SCs differ when the SPECIAL ADDRESS GENERATED RECORD FLAG is either 'B' or 'V'.

Functions Address/Place

bbl

Format 10 bytes in standard version, Numeric.
Description

The first 6 bytes of the standard BBL consists of the 1-byte borough code followed by the 5-byte tax block field, which contains the tax block value right-justified and zero-filled. The last 4 bytes of the 10-byte standard BBL is the standard tax lot field, which contains the tax lot value right-justified and zero-filled. See UPG Section VI.8.

The BBL ("borough-block-and-lot") identifies a parcel of real property in New York City, called a tax lot. The BBL is composed of the concatenation of the Borough Code, Tax Block and Tax Lot. If the property is a condominium (indicated by the Condominium Flag), the WA2 BBL field contains the billing BBL of the condominium (see UPG Section VI.4).

Functions Address/Place, BBL, BIN
FieldLengthPositionFormat
Boro11-1
Tax Block52-6RJZF
Tax Lot47-10RJZF

bblBoroughCode

Format 1 byte
Description

The borough code for the borough on which this lot is located. See UPG Section VI.2.

Functions Address/Place, BBL, BIN
See related bbl

bblBoroughCodeIn

Format 1 byte
Description

Input borough code for calling function BL.

Functions BBL
See related bbl

bblTaxBlock

Format 5 bytes
Description

The tax block on which this property is located. See UPG Section VI.2.

Functions Address/Place, BBL, BIN

bblTaxBlockIn

Format 5 bytes. Numberic.
Description

Input tax block for calling function BL.

Functions BBL
See related bbl

bblTaxLot

Format 4 bytes
Description

The tax lot on which this property is located. See UPG Section VI.2.

Functions Address/Place, BBL, BIN

bblTaxLotIn

Format 4 bytes. Numberic.
Description

Input tax lot for calling function BL.

Functions BBL
See related bbl

boardOfElectionsPreferredLgc

Format 2 bytes. RJZF
Description

This item is the LGC (the sixth and seventh digits of the 10-digit street code) that corresponds to the NYC Board of Elections' preferred street name for a given location.

Functions Address/Place

boroughCode

Format 1 byte. Numeric.
Functions Address/Place, Intersection, Blockface, BBL, BIN
CodeMeaning
1Manhattan
2Bronx
3Brooklyn
4Queens
5Staten Island

boroughCodeIn

Format 1 byte. Numeric.
Description

Borough code for first, second or third input street argument.

Also documents boroughCode1In, boroughCode2In, boroughCode3In
Functions Address/Place, Intersection, Blockface
See related boroughCode

boroughName

Format 9 bytes. Alphabetic.
Description

Normalized borough name

Also documents firstBoroughName
Functions Address/Place, Intersection, Blockface, BBL, BIN
Normalized Borough Names
MANHATTAN
BRONX
BROOKLYN
QUEENS
STATEN IS

buildingIdentificationNumber

Format 7 bytes. Numeric
Description

Building Identification Number. A permanent BIN is a seven-digit numerical identifier unique to each building in the City of New York. The first digit is the Borough Code. There are also two types of temporary BINs; those maintained by the Dept. of Buildings (DOB) and those maintained by the Dept. of City Planning (DCP). The temporary BINs assigned by DOB contain the number '8' as the second digit, and the temporary BINs assigned by DCP contain a '9' in the same position. DCP is currently in the process of phasing out all of its temporary BINs.

Functions Address/Place, BBL, BIN

buildingIdentificationNumberIn

Format 7 bytes. Numeric
Description

Input Building Identification Number for calling function BN.

Functions BIN
See related buildingIdentificationNumber

censusBlock2000

Format 4 bytes. First 3 bytes are numeric. 4th byte contains an alpha suffix (A, B or C).
Description

Smallest geographic area defined by the U.S. Census Bureau for tabulating the 2000 census. Generally (but not always) corresponds to a physical city block as of 2000. Each 2000 census block is numbered uniquely within its 2000 census tract.

Functions Address/Place, Blockface

censusTract

Format 6 bytes, consisting of numeric 4-digit root followed by numeric 2-digit suffix. The root subfield is RJBF and the suffix subfield is RJZF if any. If the tract number contains no suffix, then the suffix subfield is blank.
Description

Geographic area defined by the U.S. Census Bureau for the various decennial censuses. Census tracts for a particular census year are numbered uniquely within borough.

Also documents censusTract1990, censusTract2000, censusTract2010
Functions Address/Place, Intersection, Blockface

cityCouncilDistrict

Format 2 bytes.
Description

A district represented by a member of the New York City Council. Consists of an aggregation of Election Districts. There are currently 51 City Council Districts.

Functions Address/Place

civilCourtDistrict

Format 2 bytes.
Description

A district from which a Civil Court judge is elected. Consists of an aggregation of Election Districts.

Functions Address/Place

communityDistrict

Format 3 bytes. Numeric. RJZF.
Description

The first byte is the Community District Borough Code, and the second and third bytes are the Community District Number.

There are 59 community districts in the City of New York, as well as 12 Joint Interest Areas (JIAs). The JIAs are major parks and airports that are not contained within any CD.

Also documents communityDistrictBoroughCode, communityDistrictNumber
Functions Address/Place, Intersection, Blockface
CodeMeaning
101-112Manhattan except Marble Hill
164Central Park
201-212Bronx except Rikers Island (Note: the Marble Hill section of Manhattan is in Bronx CDs 7 and 8)
226Van Cortlandt Park
227Bronx Park
228Pelham Bay Park
301-318Brooklyn
355Prospect Park
356Brooklyn Gateway National Recreational Area
401-414Queens (Note: the Rikers Island section of the Bronx is in Queens CD 1)
480LaGuardia Airport
481Flushing Meadows - Corona Park
482Forest Park
483JFK International Airport
484Queens Gateway National Recreational Area
501-503Staten Island
595Staten Island Gateway National Recreational Area

communitySchoolDistrict

Format 2 bytes
Description

If the block face or the side of the street segment is split between two or more school districts, the corresponding school district field contains 'SP' rather than a valid school district code.

Functions Address/Place, Intersection, Blockface

compassDirection

Format 1 byte.
Description

In the case of Function 2, the compass direction identifies, for a pair of input streets that intersect at two distinct locations, which of those two intersections is to be processed. (See UPG Section VII.2) In the case of Function 3C, the compass direction identifies which side of the street is to be processed. (See UPG Section VII.5) In the case of Function 3S, if the 'on' street intersects the first cross street at two distinct locations, the compass direction identifies which of those two intersections is to be processed. (See UPG Section VII.6)

Also documents compassDirectionIn, compassDirection2In
Functions Intersection

compassDirectionForIntersectionKey

Format 1 byte.
Description

If the first two entries in the LIST OF INTERSECTING STREETS are an instance of the two-node case (i.e., they intersect twice), this field contains a compass direction value identifying the intersection in terms of those two streets. If the two streets are not an instance of the two-node case, this field is blank. If both a 'longitudinal' compass direction ('N' or 'S') and a 'latitudinal' compass direction ('E' or 'W') are valid for this intersection, the longitudinal compass direction value appears in this field.

Functions Intersection

condominiumFlag

Format 1 byte.
Functions Address/Place, BBL, BIN
CodeMeaning
CProperty is a condominium
BlankProperty is not a condo.

condominiumIdentificationNumber

Format 4 bytes
Description

An identification number assigned by the Department of Finance to each condominium in the city. This field is blank for non-condominiums.

Functions Address/Place, BBL, BIN

congressionalDistrict

Format 2 bytes.
Description

A district of the U.S. House of Representatives. Consists of an aggregation of Election Districts.

Functions Address/Place

continuousParityIndicator

Format 1 byte
Description

An 'address range' is a sequence of house numbers along an 'on' street between (and including) a Low House Number and a High House Number. Every address range has one of three possible parities: odd, even or continuous. An address range of odd parity consists of all odd house numbers along the 'on' street between the Low and High House Numbers. An even-parity range consists of all even house numbers between the Low and High House Numbers. A continuous-parity range consists of all house numbers (both even and odd) between the Low and High House Numbers. Most New York City block faces contain an address range that is either of even or odd parity. However, some block faces have a continuous-parity address range, usually where the opposite side of the street is non-addressable because it is a park, a body of water, etc. Some examples of the continuous parity case in Manhattan are Central Park West (the east side of the street runs along Central Park and is non-addressable, while the west side has both odd and even addresses); Riverside Drive; and the portion of Fifth Avenue that runs alongside Central Park.

If a New York City block face has a continuous parity address range, Geosupport represents this range as two separate ranges, an odd-parity range and an even-parity range. The practical effect of this depends on the Geosupport function. For Functions 1 and 1E, if an input address lies on a continuous-parity block face, only the range (i.e., the Low and High House Numbers) whose parity is the same as that of the input address is returned in WA2. For Function 3, if an input street segment contains a continuous parity address range, both the odd and the even ranges are returned, in the WA2 fields called Left Low House Number and Left High House Number for the range of one parity, and in the fields Right Low and High House Numbers for the range of the other parity; note that in this case, in reality both the odd and the even ranges are on the same side of the street, even though they are returned in fields called 'left' and 'right'. For Function 3C, if an input block face is on a street segment containing a continuous parity address range (regardless of whether the input block face is on the addressable or the non-addressable side of the segment), both the odd and the even ranges are returned, in the WA2 fields called Low House Number and High House Number for the range of one parity, and in the fields Alternate Low House Number and Alternate High House Number for the range of the other parity.

The field Continuous Parity Indicator indicates, for Functions 1, 1B, 1E, 3 and 3C, whether the street segment containing or corresponding to the user input is of the continuous parity type, and if so, which side of the segment is addressable.

Also documents continuousParityIndicator1a, continuousParityIndicator1e
Functions Address/Place, Blockface
CodeMeaning
BlankThe street segment does not have a continuous parity address range
L, RThe street segment has continuous parity. In this case, the Continuous Parity Indicator indicates which side of the street segment, the left or the right, is addressable. (Left and right are specified with respect to the direction of increasing addresses along the segment)

cooperativeIdentificationNumber

Format 4 bytes
Description

This is an identification number assigned by the Department of Finance to each cooperative in the city. This field is blank for non-coops.

Functions Address/Place, BBL, BIN

cornerCode

Format 2 bytes
Functions Address/Place, BBL, BIN
CodeMeaning
SE, SW, NE, NWTax lot occupies the indicated corner of the physical block
CRTax lot occupies more than one corner
BlankTax lot occupies no corners

countyBoundaryIndicator

Format 1 byte
Description

This field is non-blank when the street segment lies along a borough boundary. The value of this field indicates which side of the segment is out of borough.

Functions Blockface
CodeMeaning
LLeft side of segment is out of borough
RRight side of segment is out of borough
BlankNeither side is out of borough

crossStreetNamesFlag

Format 1 byte character.
Description

When this flag is set to 'E', the LIST OF STREET NAMES is used to return street names corresponding to the street codes in the LIST OF CROSS STREETS (Functions 1, 1B, 1E, 3 and 3C) or in the LIST OF INTERSECTING STREETS (Function 2). The cross street names feature incurs processing overhead, and should only be used when necessary. See LIST OF STREET NAMES for related details.

Functions Address/Place, Intersection, Blockface
CodeMeaning
BlankThe names of cross or intersecting streets are not returned in the LIST OF STREET NAMES
EThe names of cross or intersecting streets are returned in the LIST OF STREET NAMES

crossStreetReversalFlag

Format 1 byte
Description

This flag indicates the relationship between the order in which the user specified the input cross streets and the direction of increasing addresses along the 'on' street.

Functions Blockface
CodeMeaning
BlankThe direction from Street Name 2 to Street Name 3 (the two input cross street fields) conforms to the direction of increasing addresses
RThe direction from Street Name 2 to Street Name 3 is opposite to the direction of increasing addresses

curveFlag

Format 1 byte character
Description

This flag indicates whether the given geographic feature segment is in reality curved. If so, the curve may be an arc of a circle or an irregular curve. When the segment specified by the input data is an arc of a circle, Functions 1 and 1E return Spatial Coordinates that are positioned relative to this arc rather than to the segment's chord (the imaginary straight line joining the curved feature's endpoints). When the segment specified by the input data is an irregular curve, Functions 1 and 1E return blanks in the Spatial Coordinate fields (q.v.), and issue a warning with Reason Code value 'P'. In the case of Functions 3 and 3C, if the input data define a street stretch encompassing more than one segment (because of a T-intersection or bend), the Curve Flag is set 'on' (non-blank) if at least one of the constituent segments of the stretch is curved. See also discussion of Segment Length.

Functions Address/Place, Blockface
CodeMeaning
BlankSegment is not curved
ISegment is an irregular curve, i.e., it is curved but it is not an arc of a circle
LSegment is an arc of a circle on the left side of the line joining the segment's FROM and TO nodes
RSegment is an arc of a circle on the right side of the line joining the segment's FROM and TO nodes

dcpPreferredLgc

Format 2 bytes RJZF
Description

Identifies the local group of street names designated by the Department of City Planning as 'preferred' for display purposes for a specific location on a street.

Also documents dcpPreferredLgcForStreet1, dcpPreferredLgcForStreet2, dcpPreferredLgcForStreet3, fromPreferredLgcsFirstSetOf5, fromPreferredLgcsSecondSetOf5, toPreferredLgcsFirstSetOf5, toPreferredLgcsSecondSetOf5
Functions Address/Place, BBL, Intersection, Blockface, BIN

doglegFlag

Format 1 byte
Description

A dogleg is a street configuration in which a street has a displacement or offset as it crosses another street. A non-blank value in the Dogleg Flag indicates that at least one of the cross streets forms a dogleg as it crosses the 'on' street, in such a way that at least one side of the 'on' street has a block face encompassing more than one segment.

When Function 3 returns a non-blank value in this flag, the work area represents the 'innermost' segment of the dogleg configuration. The Dogleg Flag value indicates which side or sides of the street has (or have) the long block face(s).

A Function 3C call will return information on the long block face when the user input data specifies a side of a street where there is a long block face formed by a dogleg or doglegs. The Dogleg Flag will not be set in response to a function 3C call.

Functions Blockface
CodeMeaning
BlankNot a dogleg
BBoth sides of the 'on' street have long block faces formed by doglegs. This can only occur if both cross streets form doglegs as they cross the 'on' street.
LThe left side of the street has a long block face formed by a dogleg
RThe right side of the street has a long block face formed by a dogleg

dotStreetLightContractorArea

Format 1 byte
Functions Address/Place, Intersection, Blockface
CodeMeaning
1Street lights serviced by Manhattan contractors
2Street lights serviced by Bronx contractors
3Street lights serviced by Brooklyn contractors
4Street lights serviced by Queens contractors
5Street lights serviced by Staten Island contractors
XStreet light is located on the Brooklyn, Queens boundary
NStreet light is located in one borough, but serviced by a different borough

dynamicBlock

Format 3 bytes RJZF
Description

A dynamic block is an un-subdivided polygon formed by LION segments. Dynamic blocks are numbered uniquely within 2000 census tract.

Functions Address/Place, Blockface

electionDistrict

Format 3 bytes
Description

A set of districts defined by the NYC Board of Elections to conduct elections. There are approximately 6,000 Election Districts (EDs) in NYC. Each ED is numbered uniquely within its Assembly District. All of NYC's higher-level political districts, namely Assembly Districts, City Council Districts, Municipal Court Districts, Congressional Districts and State Senatorial Districts, are defined as aggregates of Eds.

Functions Address/Place

featureTypeCode

Format 1 byte
Description

Identifies the type of geographic feature represented by the work area

Functions Address/Place, Blockface
CodeMeaning
BlankPublic street that exists physically, other than a type 'W' feature (see below)
1Railroad
2Shoreline
3Census block boundary without physical existence
4Other non-street feature
5'Paper street', i.e., a public street that is legally 'mapped' but does not exist physically
6Private street that exists physically
7Physically nonexistent district boundary, other than a type '3' feature (see above)
8Physical Boundary such as a cemetery wall
9Paper street' that coincides with a non-physical boundary such as a Census block
WPath, non-vehicular, addressable

fireBattalion

Format 2 bytes
Description

An administrative fire district composed of Fire Companies.

Functions Address/Place, Intersection, Blockface

fireCompanyNumber

Format 3 bytes. Numeric RJZF
Description

The smallest kind of administrative fire district defined by the NYC Fire Department. There are two types, indicated by the Fire Company Type: engine companies and ladder companies.

Functions Address/Place, Intersection, Blockface

fireCompanyType

Format 1 byte
Description

Fire companies are characterized by the type of apparatus they use to fight fires.

Functions Address/Place, Intersection, Blockface
CodeMeaning
EEngine Company
LLadder Company

fireDivision

Format 2 bytes
Description

An administrative fire district composed of Fire Battalions.

Functions Address/Place, Intersection, Blockface

fromToNodeCoordinate

Format Spatial coordinates consist of two fields, an X Coordinate and a Y Coordinate, each 7 bytes RJZF.
Description

"fromNode" and "toNode" XY coordinates.

Internal Label Points have also been known as Annotation Points. See SPATIAL COORDINATES for a description of the coordinate system (SPC) used by Geosupport.

NOTE: these fields are only available when Function 3 is called with the extended mode switch.

Also documents fromXCoordinate, fromYCoordinate, toXCoordinate, toYCoordinate
Functions Blockface
See related spatialCoordinates

geosupportFunctionCode

Format 2 bytes. Alphanumeric
Description

Input argument which names the Geosupport function to be called.

Functions Address/Place, Intersection, Blockface, BBL, BIN
Currently Supported Functions
1
1A
1AX
1B
2
3
BL
BN
DG

generatedRecordFlag

Format 1 byte
Description

This flag indicates that the geography defined by the input 'on' street and two cross streets is not a conventional street segment. There are several cases: a segment one of whose cross-features is a pseudo-street name (codes C, D); a street stretch formed by consolidating more than one consecutive LION segment (codes B, L, M, R, S and T); or a segment that is part of such a street stretch (types F, G). If the input data simultaneously satisfy the criteria for a Generated Record Flag value of C or D and for some other value, the flag contains the value other than C or D.

Functions Blockface
CodeMeaning
BRecord has been generated by consolidating several LION segments to represent a stretch of a street where there is a node that is not at an intersection, such as a bending point (or a consecutive sequence of such nodes).
CRecord generated because one or both nodes of segment lie on the City Limit (Bronx-Westchester or Queens- Nassau border), but segment itself lies entirely within the City. The cross street list for a node on the City Limit contains the special street code assigned to the pseudo- street name CITY LIMIT in the Bronx or Queens, as appropriate.
DRecord has been generated for a dead end segment, i.e. a segment at least one of whose nodes either has no other segments incident at it, or has segments of non-street features only. The cross street list at such a node contains only the special street code assigned to the pseudo-street name DEAD END in the given borough.
FRecord represents a segment that is part of a street stretch that either contains a bending point at which there are no cross streets, or the left side of which is the long block face of a T-intersection or a consecutive sequence of T- intersections.
GRecord represents a segment that is part of a street stretch, that either contains a bending point at which there are no cross streets, or the right side of which is the long block face of a T-intersection or a consecutive sequence of T- intersections.
LRecord has been generated to represent the long block face on the left side of a T-intersection.
MRecord has been generated by consolidating two or more LION segments to represent a stretch of a street containing a node or a consecutive sequence of nodes at which the 'on' feature intersects with no streets but intersects with more than one type of non-street feature.
RRecord has been generated to represent the long block face on the right side of a T-intersection.
SRecord has been generated by consolidating two or more LION segments to represent a stretch of a street containing a node or a consecutive sequence of nodes at which the 'on' feature intersects with no streets but intersects with one or more shorelines.
TRecord has been generated by consolidating two or more LION segments to represent a stretch of a street containing a node or a consecutive sequence of nodes at which the 'on' feature intersects with no streets but intersects with one or more train tracks.

healthArea

Format 4 bytes
Description

Districts defined by the NYC Department of Health and used to report statistics on births, deaths, communicable diseases etc. Health Areas are aggregates of Census Tracts.

Functions Address/Place, Intersection, Blockface

healthCenterDistrict

Format 2 bytes
Description

Districts defined by the NYC Department of Health for administrative purposes. Health Center Districts are aggregates of Health Areas.

Functions Address/Place

houseNumber

Format See UPG Section V.2.
Description

If the field name indicates the house number is normalized, it is in HNS format; otherwise, it is in HND format (see UPG Section V.2).

Also documents houseNumberSortFormat
Functions Address/Place, Blockface

houseNumberIn

Format See HND format in UPG Section V.2.
Description

House number input argument in "display" (HND) format required by address-related functions.

Functions Address/Place

houseNumberJustificationFlag

Format 1 byte
Description

Indicates whether the HOUSE NUMBERS IN DISPLAY format (HNDs) in the output area should be left-justified or right-justified.

Functions Address/Place
CodeMeaning
BlankLeft-justify Normalized House Numbers (default)
LLeft-justify Normalized House Numbers
RRight-justify Normalized House Numbers

houseNumberNormalizationLength

Format 2 bytes, numeric
Description

Indicates the length requested for the HOUSE NUMBERS IN DISPLAY format (HNDs) in the output area. Valid values are between 12 and 16. If the field is left blank, the default is 12. For more information, see UPG Section V.2.

Functions Address/Place

hurricaneEvacuationZone

Format 1 byte
Description

Hurricane evacuation zones are the areas of the city that may need to be evacuated due to life safety-related threats from hurricane storm surge. These areas may be inundated by storm surge or isolated by storm surge waters. There are six zones, ranked by the risk of storm surge impact, with zone 1 being the most likely to flood. In the event of a hurricane or tropical storm, residents in these zones may be ordered to evacuate. Areas with a zone value of 'X' are not in any evacuation zone. Areas with a zone value of '0' are either water, small piers, or uninhabited islands.

Functions Address/Place
See related http://www1.nyc.gov/assets/em/html/know-your-zone/knowyourzone.html
CodeMeaning
1Zone 1
2Zone 2
3Zone 3
4Zone 4
5Zone 5
6Zone 6
XNot in a hurricane zone
0Water or pier

instructionalRegion

Format 2 bytes
Description

The Department of Education has divided the city into Instructional Regions which group together two or more Community School Districts for administrative purposes. (Instructional Regions have also been known as Instructional Divisions.)

Functions Address/Place, Intersection, Blockface

interimAssistanceEligibilityIndicator

Format 1 byte
Description

Indicates whether the input location is in a census tract that is Community Development eligible.

Functions Address/Place, Blockface
CodeMeaning
EInput location is in a CD-eligible census tract
ILocation is not in a CD-eligible census tract
BlankLocation is in a census tract, the CD-eligibility status of which is unknown to the Geosupport System. (Note: This is an error condition and should be reported).

internalLabelCoordinate

Format Spatial coordinates consist of two fields, an X Coordinate and a Y Coordinate, each 7 bytes RJZF.
Description

The Internal Label Point is a location within a tax lot selected by the Department of City Planning as the location where information could be displayed about the property in a mapping application. The coordinates associated with the Internal Label Point are guaranteed to be within the property, unlike the coordinates returned by either Function 1 or Function 1E, where the Spatial Coordinates are an approximation based in the address range of the particular street the address is on. In addition, the Function 1/1E Spatial Coordinates always fall in the street bed and not within a tax lot, and most likely will not be adjacent to the tax lot the address is in. Additionally, when using Function 1A, the same coordinates will be returned no matter which of a tax lot's addresses is used as input. There are a few properties which do not have an Internal Label Point; consequently, no coordinates will be returned for these properties.

Internal Label Points have also been known as Annotation Points. See SPATIAL COORDINATES for a description of the coordinate system (SPC) used by Geosupport.

Also documents internalLabelXCoordinate, internalLabelYCoordinate
Functions Address/Place, BBL, BIN
See related spatialCoordinates

intersectionReplicationCounter

Format 1 byte, numeric
Description

The Intersection Replication Counter is non-blank only if the two streets intersect more than once, in which case this field contains the number of such intersections.

Functions Intersection

interiorLotFlag

Format 1 byte
Functions Address/Place, BBL, BIN
CodeMeaning
ITax lot is interior to physical block, ie., it has no street frontages.
BlankTax lot has at least one street frontage

irregularlyShapedLotFlag

Format 1 byte
Functions Address/Place, BBL, BIN
CodeMeaning
ITax lot is irregularly-shaped, i.e., non-rectangular
BlankTax lot is rectangular

latitude

Format 9 bytes. Numeric.
Description

Value of Y coordinate converted to decimal degrees.

Functions Address/Place
See related spatialCoordinates

latitudeInternalLabel

Format 9 bytes. Numeric.
Description

Value of internal label Y coordinate converted to decimal degrees.

Functions Address/Place
See related spatialCoordinates, internalLabelCoordinate

lgiOverflowFlag

Format 1 byte
Description

If set to 'E' indicates that the number of geographic identifiers for the given tax lot exceeds 21, the maximum capacity of the List of Geographic Identifiers; otherwise it is blank. If this flag is set to 'E', the user can obtain a comprehensive list of BINs for the tax lot by using the long Work Area 2 option when calling the same function with the same input data.

Functions Address/Place, BBL, BIN

lionFaceCode

Format 4 bytes. Numeric
Description

A LION Face Code is assigned to each linear geographic feature represented in the LION file. These consist of streets and certain non-street features, such as census boundaries, shorelines and railroad tracks. Face Codes serve as part of LION keys, which identify a unique LION record. Face Code values are assigned uniquely within borough.

Functions Address/Place, Blockface

lionKey

Format 10 bytes. Numeric
Also documents lionBoroughCode, lionBoroughCodeForVanityAddress, lionFaceCode, lionFaceCodeForVanityAddress, lionKeyForVanityAddress, lionSequenceNumber, lionSequenceNumberForVanityAddress
Functions Address/Place, Blockface
FieldLengthPosition
LION Boro Code11-1
LION Face Code42-5
LION Sequence Number56-10

lionNodeNumber

Format 7 bytes. Numeric
Description

A LION node is an endpoint of a geographic feature segment represented in LION. Most nodes in LION are points where a feature bends or terminates or where two features intersect. Each LION node has a node number assigned to it, which is unique in the entire city. Node number assignments are permanent; if a node is deleted from LION, its node number is retired and is never reassigned to a different node.

Functions Intersection

lionSegmentId

Format 7 bytes. RJZF
Description

Identifies, uniquely within the entire city, a geographic feature segment represented in the LION file.

Functions Address/Place, Blockface

lionSequenceNumber

Format 5 bytes
Description

Identifies a LION record uniquely within Face Code. Generally, Sequence Numbers are assigned in the geographic order in which the corresponding LION segments occur along the geographic feature identified by the given face code. The Borough Code, Face Code and Sequence Number concatenated form the LION key, which serves as a unique identifier for one LION record.

Functions Address/Place, Blockface

listOfBuildingsOnTaxLot

Format 17,500 bytes, consisting of 2,500 slots for 7-byte BINs
Description

See UPG Section VI.6.

Functions Address/Place, BBL

listOfCrossStreets

Format 30 bytes, consisting of slots for up to five 6-byte B5SCs. 'Empty' slots contain either numeric zeros or blanks.
Description

A list of B5SCs, for up to five streets incident upon a delimiting node (endpoint) of a block face or street segment. The number of non-empty list entries is returned in the corresponding WA2 field NUMBER OF CROSS STREETS AT (LOW or HIGH) ADDRESS END. It is possible for the list to be entirely empty. If the node lies on a borough boundary, the list may contain streets from both boroughs. Subject to the space limitation, the list may include the input cross street corresponding to the given node, and may include the pseudo- streets 'City Limit', 'Dead End' and 'Bend'. The inclusion of 'Bend' in the list indicates that the node is a bending point of the 'on' street, not that it is a bending point of a cross street (although that may be true).

Functions Address/Place, Blockface

listOfGeographicIdentifiers

Format 756 bytes total, consisting of space for 21 36-byte entries, each entry having fields for the following data items: Low House Number of Address Range, High House Number of Address Range, B5SC, DCP-Preferred LGC, BIN, Entry Type Code, Side of Street Indicator.
Description

The List of Geographic Identifiers (LGI) is intended to provide a comprehensive geographic profile of a tax lot by listing, so far as the information is known and space allows, all of the lot's buildings; all of the street addresses and non- addressable street frontages of each building; all of the lot's 'vacant frontages' (i.e., street frontages of the lot not associated with buildings); and any NAPs associated with the lot. The LGI contains space for up to 21 entries. The number of non- empty entries is indicated in the WA2 field NUMBER OF GEOGRAPHIC IDENTIFIERS.

The first table describes possible entry types. The second table shows, based on entry type which fields will contain information.

Functions Address/Place, BBL, BIN
List of Geographic Identifiers - Possible Entry Types
Entry Type CodeRepresentsDescription
BlankAddress rangeA real address range of a building on a given tax lot. There are values in the Low House Number, High House Number, B5SC, DCP-Preferred LGC, Side of Street Indicator and BIN fields. A single address is represented as an address range in which the low and high house numbers are identical.
BNAUBA Non-Addressable Un-named Building (NAUB) (see UPG Section VI.3).
FVacant Street FrontageA street frontage of the tax lot at which there are no buildings (including NAUBs) and to which no pseudo-addresses have been assigned. The Low and High House Number, BIN and Side of Street Indicator fields are empty. There are values in the B5SC and DCP- Preferred LGC fields.
GNAP of a ComplexA Non-Addressable Place name (NAP) of a complex of buildings and/or other geographic features, usually on a large site or superblock (see UPG Section III.6). The house number and BIN fields are empty. The B5SC, DCP-Preferred LGC, and Side of Street Indicator fields contain the values of these items assigned to the NAP.
NNAP of a SimplexA NAP of a building or other geographic feature that is not part of a complex (see UPG Section III.6). The house number fields are empty.
QPseudo-Address RangeA pseudo-address range assigned to a vacant street frontage of the tax lot. There are values in the Low House Number, High House Number, B5SC, DCP-Preferred LGC and Side of Street Indicator fields. A single address is represented as an address range in which the low and high house numbers are identical. The BIN field is empty.
RReal Street of a Vanity AddressEntry indicates the street and the side of that street on which the building entrance having a vanity address is really located and for which no other address for that building exists. For a discussion of vanity addresses, see UPG Section V.9. In a type R entry, the Low and High House Number fields are empty, and there are non-empty values in the B5SC, DCP-Preferred LGC, Side of Street Indicator and BIN fields. Whenever the LGI contains a type R entry, it also contains a type V entry for the associated vanity address.
VVanity AddressA vanity address or address range. For a detailed discussion of vanity addresses, see UPG Section V.9. There are non-empty values in the Low House Number, High House Number, B5SC, DCP-Preferred LGC, Side of Street Indicator and BIN fields. A single address is represented as an address range in which the low and high house numbers are identical. Whenever the LGI contains a type V entry, it also contains an either an address range entry or a type R entry that indicates the street on which the associated building entrance is really located.
WBlank-Wall Bldg FrontageA building frontage along a street that is not associated with any addresses, such as some building facades with no entrances. The Low and High House Number and Side of Street Indicator fields are blank. There are values in the B5SC and DCP-Preferred LGC fields.
XNAP of a Constituent Entity of a ComplexA NAP of a constituent entity of a complex. (The NAP of the entire complex is represented by a separate entry of type G.) The house number fields are empty. The B5SC, DCP-Preferred LGC and Side of Street Indicator fields contain the values of these items assigned to the NAP. The BIN field is non-empty only if the NAP represents a building.
List of Geographic Identifiers - Which Fields Contain Values By Entry Type
Entry Type CodeEntry TypeLow and High House NumbersB5SCLGCSide of Street IndicatorBIN
BlankReal Address RangeYesYesYesYesYes
BNAUBNote1Note1Yes
FVacant Street FrontageYesYes
GNAP of a complexYesYesYes
NNAP of a simplexYesYesYesNote2
QPseudo-Address RangeYesYesYesYes
RReal Street of Vanity AddressYesYesYesYes
VVanity AddressYesYesYesYesYes
WBlank-Wall Building FacadeYesYesYes
XNAP of a constituent entity of a complexYesYesYesNote2
1NAUB entries may or may not contain B5SC and LGC values. An entry for a NAUB contains a B5SC value and an LGC value only if the GSS staff has determined that the NAUB fronts on, is adjacent to or is principally accessible from a particular street.
2The BIN field is non-empty only if the NAP represents a building.

listOfIntersectingStreets

Format 30 bytes, consisting of slots for up to five 6-byte B5SCs. 'Empty' slots contain numeric zeros or blanks.
Description

A list of B5SCs for up to five streets incident upon the intersection. The field NUMBER OF INTERSECTING STREETS contains the number of non-empty entries in the list. If the intersection lies on a borough boundary, the list may contain streets from both boroughs. Subject to the space limitation, the list may include the two input streets, and may include the pseudo-streets 'City Limit' and 'Dead End'. The list never includes the pseudo- street 'Bend'. The list always contains at least one entry (it contains precisely one entry in the case of a bending point of a street at which there are no other streets).

Functions Intersection

listOfStreetCodes

Format 80 bytes, consisting of 10 fields for B7SCs
Description

List of borough and 7-byte street codes, corresponding to the LIST OF STREET NAMES. The number of street codes in the list is returned in the WA1 output field NUMBER OF STREET CODES AND STREET NAMES IN LIST.

Functions Address/Place, Intersection, Blockface

listOfStreetNames

Format 320 bytes, consisting of 10 fields for street names, each 32 bytes.
Description

This field is used by several Geosupport features (see below) to return a list of street names. The number of street names in the list is returned in the WA1 output field NUMBER OF STREET CODES AND STREET NAMES IN LIST. The similar names feature uses the List of Street Names to return up to ten street names deemed 'similar' to a rejected input street name (see UPG Section III.5). The browse functions, Functions BB and BF, use the List of Street Names to return up to ten normalized street names in alphabetical order as part of a street name browse (see UPG Section III.7).

The local street name validation feature uses the List of Street Names to return up to four locally valid alias street names corresponding to a street name rejected as locally invalid (see UPG Section IV.5).

The cross street names feature (see CROSS STREET NAMES FLAG) uses the List of Street Names to return street names corresponding to the street codes in the LIST OF CROSS STREETS (Functions 1, 1B, 1E, 3 and 3C) or the LIST OF INTERSECTING STREETS (Function 2). In the case of Functions 1, 1B, 1E, 3 and 3C, the first five 32-byte street name fields in the List of Street Names are used for the street names corresponding to the street codes in the LIST OF CROSS STREETS AT LOW ADDRESS END; the second five 32-byte street name fields in the List of Street Names are used for the street names corresponding to the street codes in the LIST OF CROSS STREETS AT HIGH ADDRESS END.

Functions Address/Place, Intersection, Blockface

localGroupCode

Format 2 bytes. Numeric.
Description

Local street name validity is reflected in the sixth and seventh digits of the 10SC, which constitute the Local Group Code (LGC). Street codes are assigned in such a way that two names for a street have the same LGC value if and only if those names are valid for the same portion (possibly all) of the street. Note that if two names are valid for overlapping portions of a street, or one is valid for a subset of the portion where the other is valid, then those names are in different local groups. In order to be in the same local group, names must be valid for exactly the same portion of the street.

Conceptually, the set of all street names for a given street can be viewed as being partitioned into subsets called ?local street name groups?, each group identified by its LGC value and consisting of all the names that are valid for a particular portion (possibly all) of the street. (Most New York City streets only have one local street name group.)

A LGC value is meaningful only relative to its B5SC value. The B5SC identifies the street, and the LGC identifies a local street name group for the given street, that is, the group of all names for the given street that are valid for a particular portion (possibly all) of the street. The B5SC concatenated with the LGC, that is, the first eight bytes of the B10SC, constitute the Borough and Seven-Digit Street Code (B7SC). Two street names have the same B7SC value if and only if they are names for the same street (same B5SC value) and are valid for the same portion of the street (same LGC value relative to the given B5SC value).

For a detailed discussion of local group codes, street codes, and street names please see UPG Section IV.

Also documents listOf4Lgcs, listOfSecondSetOf5Lgcs, csclLgc1, csclLgc2, csclLgc3, csclLgc4, csclLgc5, fromLgc1, fromLgc2, fromLgc3, fromLgc4, lgc1, lgc2, lgc3, lgc4, toLgc1, toLgc2, toLgc3, toLgc4
Functions Address/Place, BBL, Intersection, Blockface, BIN
See related streetCode, streetName

locationalStatusOfSegment

Format 1 byte
Description

Indicates locational status of segment per codes below.

Functions Blockface
CodeMeaning
HSegment internal to a block, but not a Dead End (A Land Hook)
IDead End Segment
XTract Boundary Segment (other than borough boundary)
1Segment bordering Manhattan
2Segment bordering Bronx
3Segment bordering Brooklyn
4Segment bordering Queens
5Segment bordering Staten Island
9Segment bordering City Limits

longitude

Format 11 bytes. Numeric.
Description

Value of X coordinate converted to decimal degrees.

Functions Address/Place
See related spatialCoordinates

longitudeInternalLabel

Format 11 bytes. Numeric.
Description

Value of internal label X coordinate converted to decimal degrees.

Functions Address/Place
See related spatialCoordinates, internalLabelCoordinate

lowHouseNumberOfDefiningAddressRange

Format 11 bytes. Alphanumeric.
Description

Low house number of the defining address range in sort format.

Functions Address/Place, BBL, BIN

numberOfBuildingsOnTaxLot

Format 4 bytes numeric.
Description

Indicates the number of entries in the LIST OF BUILDINGS. Maximum value is 2,500.

Functions Address/Place, BBL

numberOfCrossStreets

Format One byte, containing a numeric digit from 0 to 5.
Description

Indicates the number of non-empty entries in the corresponding LIST OF CROSS STREETS.

Functions Address/Place, Blockface

numberOfGeographicIdentifiers

Format 4 bytes
Description

Indicates the number of entries in the LIST OF GEOGRAPHIC IDENTIFIERS.

Functions Address/Place, BBL, BIN

numberOfIntersectingStreets

Format One byte, containing a numeric digit from 1 to 5.
Description

Indicates the number of non-empty entries in the LIST OF INTERSECTING STREETS.

Functions Intersection

numberOfStreetFrontagesOfLot

Format 2 bytes, RJZF.
Description

Indicates the number of streets on which the given lot has at least one frontage.

Functions Address/Place, BBL, BIN

numberOfStreetCodesAndStreetNamesInList

Format 2 bytes, Numeric
Description

Indicates the number of street names returned in the LIST OF STREET NAMES, corresponding to the number of street codes returned in the LIST OF STREET CODES..

Functions Address/Place, Intersection, Blockface

numberOfStreetNamesInList

Format 2 bytes, packed decimal
Description

Indicates the number of street names returned in the LIST OF STREET NAMES.

Functions Address/Place, Intersection, Blockface

policePatrolBoroughCommand

Format 1 byte
Description

These are sub-borough geographic areas defined by the Police Department. They are composed of Police Precincts.

Functions Address/Place, Intersection, Blockface
CodeMeaning
1Manhattan South
2Manhattan North
3Bronx
4Brooklyn South
5Brooklyn North
6Queens North
7Staten Island
8Queens South

policePrecinct

Format 3 bytes. RJZF.
Description

Police Patrol Borough Commands are sub-divided into Police Precincts which are defined by the Police Department.

Functions Address/Place, Intersection, Blockface

returnCodes

Format 2 byte return code optionally followed by 1 byte reason code.
Description

Indicates success or failure of all function calls. Also indicates warnings and provides warning message where applicable.

See UPG Appendix 4.

Also documents geosupportReturnCode, geosupportReturnCode2, message, message2, reasonCode, reasonCode1a, reasonCode1e, reasonCode2, reasonCodeQualifier, reasonCodeQualifier2, returnCode1a, returnCode1e
Functions Address/Place, Intersection, Blockface, BBL, BIN
FieldFormatMeaning
geosupportReturnCode2 bytes. Alphanumeric.Indicates overall success or failure.
reasonCode1 byte. Alphanumeric.Qualifies the geosupportReturnCode to provide more detailed error or warning information.
message80 bytes. Alphanumeric.Detailed error or warning message.

rpadBuildingClassificationCode

Format 2 bytes
Description

This is a set of land use/building classification codes defined by the Real Property Assessment Division (RPAD) of the Department of Finance. If a tax lot has more than one building or land use, RPAD assigns the building class code they deem to describe best the 'principal' building or the 'predominant' land use on the tax lot. The values and meanings of this set of codes can be obtained from the Department of Finance.

Functions Address/Place, BBL, BIN

rpadCondoIdentificationNumber

Format 4 bytes
Description

This is an identification number assigned by the Department of Finance to each condominium in the city. It identifies the condominium as a whole and not a specific condominium unit.

Functions Address/Place, BBL, BIN

rpadSelfCheckCodeForBbl

Format 1 byte
Description

For each BBL value, the Department of Finance has computed a Self-Check Code (SCC). This is a one-digit number computed from the BBL value using a algorithm chosen by DOF. The purpose of the SCC is to assist in validating key-entered BBLs. For more information on SCCs inquire to the information technology division of the Department of Finance.

Functions Address/Place, BBL, BIN

roadbedRequestSwitch

Format 1 byte
Description

Indicated request for Roadbed information for roads that are divided into two or more roadbeds. If Roadbed information if requested for a street that is not divided, Geosupport returns the generic information. The Segment Type Code will indicate the type of information that is being returned.

Functions Address/Place
CodeMeaning
RRoadbed information requested
BlankGeneric (non-roadbed) information requested (default)

sanbornVolumeAndPage

Format The Volume field is 3 bytes (2-digit volume number + 1-digit character suffix). The Page field is 4 bytes (3-digit page number + 1-digit character suffix).
Description

The Sanborn Map Company maintains a 79 volume atlas of New York City geography that is widely used by New York city agencies. The atlases contain approximately 6000 maps covering all five boroughs.

Functions Address/Place, BBL, BIN, Intersection

sanitationDistrict

Format 3 bytes
Description

Sanitation district is defined by the Department of Sanitation for waste collection.

Functions Address/Place, Intersection

sanitationCollectionSchedulingSectionAndSubsection

Format 2 bytes
Description

Districts defined by the Department of Sanitation for waste collection.

Functions Address/Place

sanitationRecyclingCollectionSchedule

Format 3 bytes
Description

Indicates which days of the week the Department of Sanitation will pick up recycling at the given address.

Also documents sanitationRecyclingCollectionSchedule
Functions Address/Place

sanitationRegularCollectionSchedule

Format 3 bytes
Description

Indicates which days of the week the Department of Sanitation will pick up non-recycling waste at the given address.

Also documents sanitationRegularCollectionSchedule
Functions Address/Place

sanitationOrganicsCollectionSchedule

Format 5 bytes
Description

Indicates which days of the week the Department of Sanitation will pick up organic waste at the given address. Not available in all locations.

Also documents sanitationOrganicsCollectionSchedule
Functions Address/Place

segmentAzimuth

Format 3 bytes
Description

This item represents the direction in which the segment lies on the earth's surface, expressed as an angle in degrees measured counterclockwise from due east. The segment is considered to be pointing in the direction of increasing addresses, and the azimuth value can range from 0 to 359 degrees, inclusive. For example, a segment pointing due east has an azimuth of 0; one pointing due north has an azimuth of 90; one pointing due west has an azimuth of 180; one pointing halfway between due west and due south (i.e, pointing due southwest) has an azimuth of 225.

Functions Blockface

segmentLengthInFeet

Format 5 bytes numeric
Description

Except for curved segments (see Curve Flag), the Segment Length is computed from the Spatial Coordinates of the segment's endpoints, as digitized in the LION file. For curved segments, the Segment Length is computed by summing the lengths of the small straight line segments that approximate the curve in the GIS version of LION; this is a more accurate approximation to the true arc length of the curve than would be the segment's 'secant length', that is, the straight line distance between the curve's extreme endpoints. In the case of Functions 3 and 3C, if the input data define a street stretch encompassing more than one segment (because of a T-intersection or bend), the Segment Length returned is the sum of the lengths of the constituent segments of the stretch. In all cases, the Segment Length has a very approximate level of accuracy only, and should not be used in applications requiring high precision.

Functions Address/Place, Blockface

segmentOrientation

Format 1 byte character
Description

This item is a set of codes grouping the possible azimuth values of a segment into eight categories. The categories are "approximately" due north, south, east and west, and the four quadrants of the rectangular coordinate system for segments that do not lie approximately due north, south, east or west. "Approximately" as used here means "within 5 degrees". In Manhattan, all orientation codes are defined with a 30-degree clockwise shift (i.e., 30 is subtracted from the azimuth value) in order to conform to the conventional concept that the midtown streets and avenues lie due east-west and due north-south, respectively. For example, "approximately due north" means "within 5 degrees of due north"; for the boroughs other than Manhattan, this corresponds to the range of azimuth values from 85 to 95; in Manhattan, the corresponding azimuth value range is 55 to 65. There is a ninth orientation category, with a code value of 'U', meaning Geosupport could not determine the segment's orientation because of a problem with the segment's Spatial Coordinates. All occurrences of an orientation code of 'U' should be reported to Geographic Systems Section staff.

Functions Blockface
CodeMeaningManhattan1Other Boroughs1
UOrientation is undefined
EApproximately due east0-5 and 355-359325-335
1First quadrant, i.e. northeasterly6-84336-359 and 0-54
NApproximately due north85-9555-65
2Second quadrant, i.e. northwesterly96-17466-144
WApproximately due west175-185145-155
3Third quadrant, i.e. southwesterly186-264156-234
SApproximately due south265-275235-245
4Fourth quadrant, i.e. southeasterly276-354246-324
1Corresponding Range of Azimuth Values

segmentTypeCode

Format 1 byte
Description

Indicates type of segment.

Functions Address/Place, Blockface
CodeMeaning
UUndivided
GGeneric
BBoth Generic and Roadbed
RRoadbed
CConnector
EExit/Entrance Ramp
TTerminator
FFaux Ramps (ramp segments connecting the roadbed segments to the generic segments)

sideOfStreetIndicator

Format 1 byte character
Description

This field indicates on which side of the street, left or right, the block face containing the input address lies. Left and right are defined with respect to the direction of increasing addresses along the 'on' street.

Also documents sideOfStreetOfVanityAddress
Functions Address/Place
CodeMeaning
LBlock face is on left side of street with respect to direction of increasing address
RBlock face is on right with respect to direction of increasing address

spatialCoordinates

Format Spatial coordinates consist of two fields, an X Coordinate and a Y Coordinate, each 7 bytes RJZF.
Description

Spatial coordinates are a pair of numbers that specify a location on the earth's surface. Geosupport returns spatial coordinates for an input address (Functions 1 and 1E) or intersection (Function 2). Spatial coordinates are often used in conjunction with separate computer mapping and Geographic Information System (GIS) software to generate maps and for spatial analysis, although the Geosupport System does not itself provide users with such capabilities. Note: For Functions 1 and 1E, the spatial coordinates that Geosupport returns are imprecise approximations of real-world locations, and are not appropriate for use in applications that require a high level of spatial accuracy.

Spatial coordinates are expressed various geodetic coordinate systems, of which latitude/longitude is a well-known example. The coordinate system that Geosupport uses is known as the State Plane Coordinate (SPC) system. The SPC system is based upon the fact that, in a small enough geographic area, the earth's surface can be assumed to be flat without introducing a significant error. In the SPC system, each state of the U.S. is subdivided into zones small enough to model as planar areas. In each SPC zone, a Cartesian coordinate system is established, with the X and Y coordinate axes oriented due east and due north, respectively, and the origin selected to be a point well to the southwest of the entire zone. (The origin is so selected to insure that the X and Y coordinates of all points within the zone are positive values.) The SPC zone that New York City is in, and which Geosupport uses, is called the New York-Long Island zone, NAD 83. In the SPC system, one unit of X or Y represents one foot of distance on the ground. A major advantage of the SPC system over other map projection systems is the ease of calculating the distance between two points.

In the case of Functions 1 and 1E, if the street segment on which the input address lies is a straight line segment or an arc of a circle, Geosupport computes and returns output spatial coordinates using a complex algorithm, a detailed description of which is beyond the scope of this document. If, however, the input address lies on a irregularly curved geographic feature (see Curve Flag), Functions 1 and 1E return blanks in the spatial coordinate fields.

Function 1/1E's spatial coordinates algorithm produces a point position based on how the input address is prorated with respect to the administrative address range allocated to the entire block face. In addition, the computed point is positioned slightly set off from the segment, on the side of the street where the input address is located. This offset is graphically desirable and also insures that the point will fall within the interiors of the proper political and administrative district boundary polygons for the given address. The computed point is a rough approximation to the location of the input address, intended to be used only for thematic mapping and other purposes that do not require a high level of spatial accuracy. If the input address is a vanity address (see UPG Section V.9), the computed point is based on the street segment where the address is actually located. In general, points computed for vanity addresses have even less spatial accuracy than points computed for conventional addresses.

In the case of Function 2, the spatial coordinates returned are those of the LION node that corresponds to the input street intersection. Those coordinates represent an approximate center point of the intersection.

Functions Address/Place, Intersection

specialAddressGeneratedRecordFlag

Format 1 byte character
Description

A non-blank value in this flag indicates one of a variety of special addressing situations.

Functions Address/Place
CodeMeaning
AThe address range returned in this work area is alternative to the address range that is stored in LION for this block face. This case arises most commonly when the input address is an old (superseded) address on a block face on which the buildings were re-numbered at some time in the past. For such an input address, the address range returned in this work area is the old address range, whereas the current address range is stored in LION. Another situation in which this flag is 'A' is when the given street segment has continuous parity address ranges on both sides of the street, such as when buildings are numbered consecutively around the arc of a cul-de-sac.
BThe input street name or five-digit street code is different from that stored in LION for this block face. This case arises when two street names having different B5SCs are both valid along a street or portion of a street. These are situations in which treating the two street names as aliases would result in an address range overlap.
CThe input address pertains to Ruby Street, a street along the Brooklyn-Queens border that has a unique addressing situation. See UPG SectionV.8.
DThe input address involves a duplicate address situation. See UPG Section V.6.
EThe input address is in one of the neighborhoods in which the name of the neighborhood can serve as an alternative street name for the streets in that neighborhood. Two Bronx neighborhoods, Edgewater Park and Harding Park, have this characteristic.
GThe input name or street code corresponds to a non-addressable place name of a complex. A complex is a geographic feature that contains constituent entities that are separately geographically identifiable. Typical examples of complexes include airports, housing projects and university and hospital campuses. See UPG Section III.6.
NThe input name or street code corresponds to a non-addressable place name of a "stand-alone" geographic feature (a geographic feature that is neither a complex nor a constituent entity of a complex). Typical examples are individual named buildings, such as Empire State Building, Shea Stadium, Carnegie Hall. See UPG Section III.6.
OThe block face contains out-of-sequence and/or opposite-parity addresses. An out-of-sequence address contains a house number that is out of sequence with those of the immediately adjacent buildings. An opposite-parity address contains a house number that is of the opposite parity to the predominant parity on the block face. See UPG Section V.10.
PThe input address contains an addressable place name. Example: 2 Penn Plaza. See UPG Section III.6.
SThe input address contains a house number suffix and is either the first or last address on this block face.
VThe input address is a 'vanity address', that is, an address in which the street name refers to a different street than the one on which the referenced building entrance is actually located. See UPG Section V.9.
XThe input data specify a non-addressable place name of a constituent entity of a complex. Examples: AVERY FISHER HALL and NEW YORK STATE THEATER are names of constituent entities of the complex LINCOLN CENTER. See UPG Section III.6.

splitCommunitySchoolDistrictFlag

Format 1 byte.
Functions Address/Place
CodeMeaning
SBlock face is split among two or more school districts
BlankBlock face lies entirely within a single school district

splitElectionDistrictFlag

Format 1 byte.
Functions Address/Place
CodeMeaning
SBlock face is split among two or more election districts
BlankBlock face lies entirely within an election district

stateSenatorialDistrict

Format 2 bytes. Numeric.
Description

A district of the upper house of the New York State legislature. Consists of an aggregation of Election Districts

Functions Address/Place

streetAttributeIndicator

Format 1 byte character
Description

Indicates certain characteristics of selected streets.

Functions Address/Place
CodeMeaning
EInput street is entirely in Edgewater Park (a Bronx neighborhood that has special addressing characteristics).
FInput street is partly in Edgewater Park and partly outside of it.
GNAP of a complex.
HAll house numbers on input street are hyphenated.
INamed Intersection
MHouse numbers on input street are of mixed hyphenation, i.e., some are hyphenated and some are not.
NInput street is a Non-Addressable Place Name (NAP).
SFront Truncated Street Name.
XNap Of a Constituent Entity of a Complex
BlankNone of the above. In particular, all addresses on the input street are un-hyphenated.

streetCode

Format 5, 7, or 10 bytes. Numeric.
Description

See UPG Section IV.0 of the UPG for a complete discussion of DCP street codes.

In the case of first, second and thirdStreetCodes, indcates the street code of the corresponding input street.

Also documents firstStreetCode, secondStreetCode, thirdStreetCode
Functions Address/Place, Intersection, Blockface, BBL, BIN

streetCodeIn

Format 10 bytes. Numeric.
Description

Street code for the first, second or third input street that can be used in place of the street name. NOTE: this field does not include the borough code.

Also documents streetCode1In, streetCode2In, streetCode3In
Functions Address/Place, Intersection, Blockface
See related streetCode

streetName

Format 32 bytes. Alphanumeric.
Description

See UPG Section III.1 of the UPG for a complete discussion of DCP street names.

In the case of first, second, and thirdStreetNameNormalized, indicates the normalized street name of the corresponding input street.

Also documents firstStreetNameNormalized, secondStreetNameNormalized, thirdStreetNameNormalized
Functions Address/Place, Intersection, Blockface, BBL, BIN

streetNameIn

Format 32 bytes. Alphanumeric.
Description

Street name for the first, second or third input street.

Also documents streetName1In, streetName2In, streetName3In
Functions Address/Place, Intersection, Blockface
See related streetName

streetNameNormalizationFormatFlag

Format 1 byte.
Description

Specifies the format in which Geosupport is to return output normalized street names. The default is to return street names in the sort format.

Functions Address/Place, Intersection, Blockface
CodeMeaning
BlankReturn normalized street names in the sort format
CReturn normalized street names in the compact format
SReturn normalized street names in the sort format

streetNameNormalizationLengthLimit

Format 2 bytes, blank or numeric, either LJBF or RJZF.
Description

Specifies the maximum length in bytes within which Geosupport is to normalize street names. The minimum and maximum permissible SNL values are 4 and 32. The default that is in effect if the application does not specify an SNL value is 32.

Functions Address/Place, Intersection, Blockface

taxMapSection

Format 2 bytes
Description

The Department of Finance real property tax maps are organized into sections; each section is organized into volumes; and each volume consists of pages. Tax Map Section values are unique within borough.

Functions Address/Place, BBL, BIN

taxMapVolume

Format 2 bytes
Description

See description at Tax Map Section. Tax Map Volume values are unique within Tax Map Section.

Functions Address/Place, BBL, BIN

vacantLotFlag

Format 1 byte.
Functions Address/Place, BBL
CodeMeaning
VTax lot is currently vacant, i.e., it has no existing buildings
BlankTax lot has at least one existing building

workAreaFormatIndicator

Format 1 byte
Description

This indicator specifies which work area layouts are to be used in an API call. Note: This indicator is also known as the Platform Indicator.

Also documents workAreaFormatIndicatorIn
Functions Address/Place, Intersection, Blockface, BBL, BIN
CodeMeaning
BlankThe IBM mainframe specific work areas (MSWs) are used. The MSWs contain packed decimal fields. In general, these work areas are the ones described throughout this manual.
CThe platform-independent work areas known as the Character-Only Work Areas (COWs) are used. These contain no packed decimal fields. For information on using COWs on the mainframe and the differences from the MSWs, see Appendix 12. For the work area layouts of the COWs, see Appendix 13.

xCoordinate

Format 7 bytes RJZF. Numeric.
Description

X coordinate (longitude) in the State Plane Coordinate system.

Also documents xCoordinateLowAddressEnd, xCoordinateHighAddressEnd, xCoordinateOfCenterofCurvature
Functions Address/Place, Intersection
See related spatialCoordinates

yCoordinate

Format 7 bytes RJZF. Numeric.
Description

Y coordinate (latitude) in the State Plane Coordinate system.

Also documents yCoordinateLowAddressEnd, yCoordinateHighAddressEnd, yCoordinateOfCenterofCurvature
Functions Address/Place, Intersection
See related spatialCoordinates

zCoordinate

Format 7 bytes RJZF. Numeric.
Description

Z coordinate is currently not implemented.

Also documents zCoordinateLowAddressEnd, zCoordinateHighAddressEnd, zCoordinateOfCenterofCurvature
Functions Address/Place, Intersection
See related spatialCoordinates

uspsPreferredCityName

Format 25 bytes.
Description

U.S. Postal Service preferred city name.

For Queens, the USPS Preferred City Name is based on the ZIP code associated with the input address. In the rare, and unexpected, instance where there is no city name available, then the City Name will be set to a default of QUEENS and the following warning message will be issued. For all the other boroughs, unless there is a special ZIP code, the default for that borough will appear in the City Name field. See the defaults listed below.

Functions Address/Place
BoroughDefault USPS Preferred City Name
BronxBRONX
BrooklynBROOKLYN
ManhattanNEW YORK
QueensQUEENS
Staten IslandSTATEN ISLAND

zipCode

Format 5 bytes. Numeric.
Description

U.S. Postal Service's 5-digit zip code.

Functions Address/Place, Intersection, Blockface

latitude

Format
Description

Value of yCoordinate converted to decimal degrees.

Functions Address/Place, Intersection

longitude

Format
Description

Value of xCoordinate converted to decimal degrees.

Functions Address/Place, Intersection

latitudeInternalLabel

Format
Description

Value of internalLabelYCoordinate converted to decimal degrees.

Functions Address/Place, BBL, BIN

longitudeInternalLabel

Format
Description

Value of internalLabelXCoordinate converted to decimal degrees.

Functions Address/Place, BBL, BIN

latitude

Format
Description

Value of yCoordinate converted to decimal degrees.

Functions Address/Place, Intersection

longitude

Format
Description

Value of xCoordinate converted to decimal degrees.

Functions Address/Place, Intersection

latitudeInternalLabel

Format
Description

Value of internalLabelYCoordinate converted to decimal degrees.

Functions Address/Place, BBL, BIN

longitudeInternalLabel

Format
Description

Value of internalLabelXCoordinate converted to decimal degrees.

Functions Address/Place, BBL, BIN

latitude

Format
Description

Value of yCoordinate converted to decimal degrees.

Functions Address/Place, Intersection

longitude

Format
Description

Value of xCoordinate converted to decimal degrees.

Functions Address/Place, Intersection

latitudeInternalLabel

Format
Description

Value of internalLabelYCoordinate converted to decimal degrees.

Functions Address/Place, BBL, BIN

longitudeInternalLabel

Format
Description

Value of internalLabelXCoordinate converted to decimal degrees.

Functions Address/Place, BBL, BIN

5.0 - Version Information

This section provides version information about the Geoclient and Geosupport software providing this service.

5.1 - Geoclient Version

The Geoclient service provides a simple API for calling Geosupport functions.

Geoclient Component Version
Geoclient Service API 1.0.14.1
Geoclient Library 1.0.17.1
Geoclient Parser 1.0.1
Geoclient Native Interface 1.0.10
Geosupport Access Method Local/JNI

The look and feel of this documentation page was generated on GitHub Pages using the Dinky theme.

5.2 - Geosupport Version

Geosupport is the underlying system that does the actual geocoding for the Geoclient service. It is written and maintained by the Department of City Planning. Geosupport uses "version" to refer to software component versioning and "release" to refer to data changes.

Geosupport Release/Version
Release 23A
Version 23.10
File Record Type Tag File Date Release Record Count
GEO1 0000 GEO 2023-01-25 2310 00000001
GEO2 0000 EDEQ 2020-02-21 20A 00000001
GEO3 0000 GRD1 2023-01-25 23A 00232043
GEO4 0000 GRD2 2023-01-24 23A 00077777
GEO5 0000 GRD3 2023-01-24 23A 00228750
GEO6 PAD 2023-01-25 23A 01287091
GEO7 0000 SAN 2023-01-26 23A 00000750
GEO8 0000 SND 2023-01-24 23A 00111926
GEO9 0000 STCH 2023-01-24 23A 00029306
THINED rectype1: 0000
rectype2: 0001
rectype3: 0002
THIN 2023-01-17 23A 00004398
GRID1R 0000 GR1R 2023-01-25 23A 00232022
AUXSEG 0000 SAUX 2023-01-24 23A 00040395
TPAD 0000 TPAD 2023-01-13 22C 00000000
APEQUIV 0000 APEQ 2023-01-31 23A 00000018
DSNAMES Value
DSNAME 1 0000AP 23011723A 009679390000UPAD23012523A 00000001STAT****
DSNAME 2 ******************STT1**********************STT1A***********
DSNAME 3 **********STT2**********************STT3********************
DSNAME 4 **STT3S*********************STTAP*********************STTBL*
DSNAME 5 ********************STTBN*********************STTD**********
DSNAME 6 ************0000SNEQ23012623A 00000819edequiv
DSNAME 7 GRID1
DSNAME 8 GRID2
DSNAME 9 GRID3
DSNAME 10 PAD
DSNAME 11 san
DSNAME 12 snd
DSNAME 13 STRETCH
DSNAME 14 thined
DSNAME 15 GRID1R
DSNAME 16 AUXSEG
DSNAME 17 TPAD
DSNAME 18 apequiv
DSNAME 19 AP
DSNAME 20 UPAD

6.0 - Contact Us

For Geoclient API usage, bug reporting and enhancement requests, please contact the Citywide GIS Development group.

For questions or issues with the data provided by Geosupport, please contact the Department of City Planning.