You can search for many different kinds of addresses using the LocateNYC API /findAddressCandidates operation
including address, place, intersection, NYC building (using BIN), NYC tax lot (using BBL), 3D building floor, street segment (the street between
two consecutive intersections), street segment blockface (one side of the street), and street stretch (the stretch of street between intersections that are not consecutive).
You can pass the address components in a single parameter using the singleLine option
or separtated into multiple parameters. The response is the same for both scenarios.
This page focuses on searching for intersections, which is when two (or more) streets cross one another. For a discusson of address and place search
please see the Address Search page.
LocateNYC returns a wide variety of response parameters. Please see the Response Parameters
sections below for a full list. Many of these parameters are derived directly for the NYC Geosupport API and are described using the
descriptions provided in the Geosupport User Programming Guide (UPG). Many other parameters are created directly from the LocateNYC
API and are also descirbed in Repsonse Parameters section.
Specifies the location to be geocoded. The input address components are formatted as a single string.
Address Example:
singleLine=231 East 10th Street, Manhattan
Place Example:
singleLine=Carnegie Hall
BIN Example:
singleLine=1006458
BBL Example:
singleLine=1007810001
Intersection Example:
singleLine=8th Avenue and 41st Street, Manhattan
Street Segment Example:
singleLine=10th Ave between W 50 St and W 51 St, Manhattan
Blockface Example:
singleLine=West side of 10th Ave between W 50 St and W 51 St, Manhattan
3D Address Example:
singleLine=231 East 10th Street, Manhattan, Floor 3
3D Place (the "B" represents below ground or basement) Example:
singleLine=Carnegie Hall, Floor B1
houseNumber
The number of the address to be geocoded. To be used in coordination with street, borough, zip
street
The street name of the address to be geocoded. To be used with houseNumber, borough, zip
borough
The borough of the address to be geocoded. Accepts both spelled and coded values. Accepts [Manhattan, Bronx, Brooklyn, Queens, Staten Island, MN, BR, BK, QN, SI, 1, 2, 3, 4, 5]
as well as coded values for boroughs. See BOROUGH CODE for more details on the coded values.
To be used with houseNumber, street, zip
Example:
borough=Manhattan
zip
The zip code (postal) of the address to be geocoded. 5 bytes. To be used with houseNumber, street, borough
Example:
zip=10035
onStreet
The "on" street segment/stretch for street segment/blockface queries. For example, the address is "on" W 41 St between 7 Ave and 8 Ave. If passed to the API, crossStreetOne
and crossStreetTwo are required.
Example:
onStreet=West 41 Street
crossStreetOne
The first cross street for street segment/blockface queries. For example, the address is "on" W 41 St
between 7 Ave and 8 Ave. If passed to the API, onStreet
and crossStreetTwo are required.
Example:
crossStreetOne=7 Ave
crossStreetTwo
The first cross street for street/segment blockface queries. For example, the address is "on" W 41 St
between 7 Ave and 8 Ave. If passed to the API, onStreet
and crossStreetOne are required.
Example:
crossStreetTwo=8 Ave
compassDirection
The compass direction [n, s, e, w] for single side blockface queries. If the LocateNYC API finds a match, then Geosupport blockface
information (only one side of a street segment) will be returned.
If passed to the API, onStreet
, crossStreetOne, and crossStreetTwo are required.
Example:
compassDirection=e
boroughCrossStreetOne
The borough of the first cross street (crossStreetOne) for street segment/blockface queries.
Only required if crossStreetOne parameter is passed.
Example:
boroughCrossStreetOne=manhattan
boroughCrossStreetTwo
The borough of the second cross street (crossStreetTwo) for street segment/blockface queries.
Only required if crossStreetTwo parameter is passed.
Example:
boroughCrossStreetTwo=manhattan
outSR
The well-known ID of the spatial reference, or a spatial reference JSON object for the returned addresses. WKID accepted include:
[4326 (default, WGS), 2263 (Long Island State Plane), 3857 (Web Mercator),
102100 (Web Mercator), 26918 (UTM 18N)]. Format 1; 3857. Format 2; {"wkid":102100}.
Examples:
outSR=3857
outSR={"wkid":102100}
normalizeType
The normalize type parameter represents how the address should be normalized by LocateNYC/Geosupport.
For more details, please refer to the Geosupport User Guide
The supported types are
input - (default) normalizes the provided input address
primary - normalizes to DCP primary street name
principal - normalizes to DCP principal street name
preferred - normalizes to DCP preferred street name
nycps - Only supported for on-premise Enterprise install. If this value is passed using locatenyc.io, the default value of input will be used instead. For /reverseGeocode, the default is preferred and passing input will result in preferred normalized output. Only active for input will be used instead. For /reverseGeocode, street segment, street strech, and blockface requests
callback
Callback parameter. Produces padded JSON response. Used by Esri APIs/SDKs. Only use this if you really know what your doing.
f
Requested format of the response. Only accepts 'json', and the default value is 'json'.
An intersection is where two (or more) streets cross one another. An intersection search consists of
providing the first and second cross streets, along with an a borough name. For example,
7th avenue and west 40th street, manhattan or using the
ampersand symbol 7th avenue & west 40th street, manhattan
A dead end psuedo-intersection is a street that has a termination point that is not at a city limit and at which there are no cross streets. "Dead End" should be used as the second cross street.
Example: Search for an intersection on a dead end street (e.g. cul-de-sac, or dead end street). Marvin Place and Dead End, Bronx
A city limit psuedo-intersection is where the street (or non-street feature e.g. bridge or tunnel)
intersects with the NYC city limits. (The street may terminate at that point or it
may continue as a suburban street). City Limit points occur at the Bronx-
Westchester County border, the Queens-Nassau County border, the New
York-New Jersey border and the Staten Island –New Jersey border.
The New Jersey borders occur in the Hudson River, for
example HOLLAND TUNNEL and CITY LIMIT in
Manhattan. "City Limit" should be used as the second cross street (even though it doesn't exist).
Example: Search for an intersection with the city limit. Linden Boulevard and City Limit, Queens
The map above shows the intersection of Linden Boulevard in Queens intesecting with the Queens County - Nassau County line. Linden Boulevard does not terminate at the county line, instead it continues into Nassau County, NY.
Example: Search for an intersection with the city limit. Holland Tunnel and City Limit
A bend in a street segment is considered as a bend point if the angle of the bend is greater than a 20°. Bend points are considered psuedo-intersections because there is technically no second
cross street in reality. "Bend" should be used as the second cross street.
Example: Search for a psuedo-intersection with the bend. Minetta Street and Bend, Manhattan
Below is a list of response parameters that may be returned in the response for the intersection search
function in LocateNYC. Most of these parameters are derived from the NYC Geosupport software. Some of
the parameters are returned from LocateNYC software only.
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 Chapter 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 Chapter V.8). This field was also known as the Marble Hill / Rikers Island Flag.
An atomic polygon is an un-subdivided polygon . Atomic polygons are created based on the New York City CSCL (Citywide Street Centerline) database. Atomic polygons are numbered uniquely within census tract.
B7SC OF “TRUE” STREET (a.k.a. B7SC OF “UNDERLYING” STREET)
Geosupport Functions:
1and 1E (MSW: Long WA2 only),1,1B,1E
Field Length:
8
Field Format:
8 bytes
Field Status:
Active
Description:
This item typically applies to Addressable Place Names, Non-addressable Place Names and Vanity Addresses. 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 FACE CODE and 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’, ‘N’, ‘P’, or ‘V’.
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 standard BBL is the standard tax lot field, which contains the tax lot value right-justified and zero-filled. See Chapter 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 Chapter VI.4).
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 standard BBL is the standard tax lot field, which contains the tax lot value right-justified and zero-filled. See Chapter 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 Chapter VI.4).
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 standard BBL is the standard tax lot field, which contains the tax lot value right-justified and zero-filled. See Chapter 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 Chapter VI.4).
The Browse Flag allows users to request the return of primary or principal output street names and street codes (for Functions 1, 1A, 1B, 1E, 1N, 2, 3, 3C and AP). The Browse Flag also allows users to request the return of preferred output street names and street codes (for Functions 1, 1A, 1B. 1E, 2, 3, 3C and AP).
1,1E (MSW: Long WA2 Only),1,1E(COW),2,3 (MSW: Long WA2 Only),3(COW),3C
Field Length:
4
Field Format:
4 bytes, numeric
Field Status:
Active
Description:
When appended by the CENSUS BLOCK SUFFIX, this area is the smallest geographic area defined by the U.S. Census Bureau for tabulating the census. Generally (but not always) corresponds to a physical city block. Each census block is numbered uniquely within its census tract.
1,1E (MSW: for 2010 - Regular WA2),1,1E(COW),2,3 (MSW: Long WA2 Only),3(COW),3C
Field Length:
4
Field Format:
4 bytes, numeric
Field Status:
Active
Description:
When appended by the CENSUS BLOCK SUFFIX, this area is the smallest geographic area defined by the U.S. Census Bureau for tabulating the census. Generally (but not always) corresponds to a physical city block. Each census block is numbered uniquely within its census tract.
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.
Field Status:
Active
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.
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.
Field Status:
Active
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.
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.
Field Status:
Active
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.
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.
3 bytes. Numeric. The first byte is the Community District Borough Code, and the second and third bytes are the Community District Number, RJZF.
Field Status:
Active
Description:
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. Examples are Central Park, Van Cortlandt Park, LaGuardia and JFK Airports. The JIAs are the numerically highest items in each borough.
Coded Values:
Code
Meaning
101-112
Manhattan except Marble Hill
164
Central Park
201-212
Bronx except Rikers Island (Note: the Marble Hill section of Manhattan is in Bronx CDs 7 and 8)
226
Van Cortlandt Park
227
Bronx Park
228
Pelham Bay Park
301-318
Brooklyn
355
Prospect Park
356
Brooklyn Gateway National Recreational Area
401-414
Queens (Note: the Rikers Island section of the Bronx is in Queens CD 1)
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 Chapter VII.2) In the case of Function 3C, the compass direction identifies which side of the street is to be processed. (See 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 Chapter VII.6)
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.
CROSS STREET NAMES FLAG (a.k.a. EXPANDED FORMAT FLAG)
Geosupport Functions:
1,1E,2,3,3C,1B (COW)
Field Length:
1
Field Format:
1 byte
Field Status:
Active
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.
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.
DYNAMIC BLOCK (will be replaced by ATOMIC POLYGON)
Geosupport Functions:
1,1B,1E,3 (MSW: Long WA2),3 (COW Only),3C
Field Length:
3
Field Format:
3 bytes RJZF
Field Status:
Active
Description:
An atomic polygon is an un-subdivided polygon . Atomic polygons are created based on the New York City CSCL (Citywide Street Centerline) database. Atomic polygons are numbered uniquely within census tract.
The smallest kind of administrative fire district defined by the NYC Fire Department. There are three types, indicated by the Fire Company Type: engine companies, Squad and ladder companies.
A node is an endpoint of a geographic feature segment represented in CSCL/LION. Most nodes are points where a feature bends or terminates or where two features intersect in CSCL/LION. Each node has a node ID assigned to it, which is unique in the entire city. Node ID assignments are permanent; if a node is deleted from CSCL, its node ID is retired and is never reassigned to a different node. A Node ID may be used to identify an intersection or the end points of a segment. An end point node is often referred to as a From Node or a To Node.
From NYC LION. A unique ID assigned in order to aggregate granular geometry to represent a Generic view of the city's street network. Streets that contain multiple carriageways or roadbeds (such as Queens Boulevard in Queens and Park Ave in Manhattan) are represented by multiple centerlines corresponding to each roadbed as well as an imaginary 'single' generic centerline.
Geosupport has an elaborate apparatus to support application problem-handling. There are three output fields in Work Area 1 that are used to inform calling applications of the outcome of each call to Geosupport. These fields are the Geosupport Return Code (GRC), the Reason Code and the Message. A comprehensive list of GRCs, Reason Codes and Messages is contained in UPG Appendix 4.
Coded Values:
Code
Meaning
00
indicates unconditionally successful completion
01
indicates a warning condition.
Values other than 00 or 01
signifies unsuccessful completion, or rejection, caused by either a system error or a user error
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.
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.)
INTERIM ASSISTANCE ELIGIBILITY INDICATOR (IAEI) - a.k.a. CD Eligibility Flag
Geosupport Functions:
1,1E,2 (COW only),3,3C,1B
Field Length:
1
Field Format:
1 byte
Field Status:
Active
Description:
Indicates whether the input location is in a census tract that meets the U.S. Department of Housing and Urban Development (HUD) criteria to be eligible for Community Development Block Grant (CDBG) funding. A census tract is eligible for CDBG funding if at least 51.00% of the residents are low- and moderate-income persons (less than 80% of the Median Family Income) and 50% of its total floor area must be comprised of residential usage. All other census tracts are ineligible. In Release 19B, the 'CD Eligibility' values were updated to reflect more current data. Updated income data was provided by HUD and residential usage was calculated by the Department of City Planning (DCP) using PLUTO data (18v2.1).
Coded Values:
Code
Meaning
E
Input location is in a CD-eligible census tract
I
Location is not in a CD-eligible census tract
Blank
Location 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).
INTERNAL LABEL POINT a.k.a. SPATIAL COORDINATES OF THE TAX LOT CENTROID
Geosupport Functions:
2
Field Length:
1
Field Format:
1 byte, numeric
Field Status:
Active
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.
1/1E Extended,all variations of 1A/BL/BN (viz. Regular, Long and Extended),1B,2W,3 Extended,3C Extended
Field Length:
9
Field Format:
9 bytes
Field Status:
Active
Description:
Spatial coordinates based on the lines of latitude and longitude. Lines of latitude measure the north-south position between the poles with the equator defined as 0 degrees. Lines of longitude (or meridians) measure the east-west position, with the prime meridian running through Greenwich, England. For NYC, Latitude is always positive and Longitude is always negative. The latitude and longitude of a location are calculated based on the spatial coordinates (x,y) returned for that location. As a result, the latitude and longitude returned by the Address Processing functions (e.g. 1/1E Extended) will be somewhat different from the values returned by Tax Lot and Building processing functions (e.g. 1A/BL/BN). See also SPATIAL COORDINATES and SPATIAL COORDINATES OF THE TAX LOT CENTROID.
A node is an endpoint of a geographic feature segment represented in CSCL/LION. Most nodes are points where a feature bends or terminates or where two features intersect in CSCL/LION. Each node has a node ID assigned to it, which is unique in the entire city. Node ID assignments are permanent; if a node is deleted from CSCL, its node ID is retired and is never reassigned to a different node. A Node ID may be used to identify an intersection or the end points of a segment. An end point node is often referred to as a From Node or a To Node.
30 bytes, consisting of slots for up to five 6-byte B5SCs. ‘Empty’ slots contain either numeric zeros or blanks.
Field Status:
Active
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).
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.
320 bytes, consisting of 10 fields for street names, each 32 bytes.
Field Status:
Active
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.
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.
1/1E Extended,all variations of 1A/BL/BN (viz. Regular, Long and Extended),1B,2W,3 Extended,3C Extended
Field Length:
11
Field Format:
11 bytes
Field Status:
Active
Description:
Spatial coordinates based on the lines of latitude and longitude. Lines of latitude measure the north-south position between the poles with the equator defined as 0 degrees. Lines of longitude (or meridians) measure the east-west position, with the prime meridian running through Greenwich, England. For NYC, Latitude is always positive and Longitude is always negative. The latitude and longitude of a location are calculated based on the spatial coordinates (x,y) returned for that location. As a result, the latitude and longitude returned by the Address Processing functions (e.g. 1/1E Extended) will be somewhat different from the values returned by Tax Lot and Building processing functions (e.g. 1A/BL/BN). See also SPATIAL COORDINATES and SPATIAL COORDINATES OF THE TAX LOT CENTROID.
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 Chapter 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 Chapter V.8). This field was also known as the Marble Hill / Rikers Island Flag.
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.
In order to support Neighborhood Policing, the NYC Police Department has divided each precinct into four or five fully-staffed Police Sectors. The Police Sectors correspond, as much as possible, to the boundaries of actual established neighborhoods. The Police Sector field consists of the Precinct Number followed by a letter, e.g. 114A.
From NYC LION. A unique ID assigned in order to aggregate granular geometry to represent a Physical View of the city's street network. In CSCL, segmentation is very granular in order to accommodate many types of physical and non-physical geometry. The Physical ID is a unique number used to identify a physically existing piece of geometry that may or may not be comprised of several Segment IDs. For example, E 28 Street between 2nd Ave and 3rd Ave in Manhattan would have 1 Physical ID although there are 3 segments defining that block face, with 3 separate Segment IDs.
Geosupport has an elaborate apparatus to support application problem-handling. There are three output fields in Work Area 1 that are used to inform calling applications of the outcome of each call to Geosupport. These fields are the Geosupport Return Code (GRC), the Reason Code and the Message. The reason code is provided when a non '00' GRC is returned in order to provide more context to the warning or error condition. A comprehensive list of GRCs, Reason Codes and Messages is contained in UPG Appendix 4.
This field indicates on which side of the street, left or right, the blockface containing the input address lies. Left and right are defined with respect to the direction of increasing addresses along the ‘on’ street.
Coded Values:
Code
Meaning
L
Block face is on left side of street with respect to direction of increasing address
SPATIAL COORDINATES (See also SPATIAL COORDINATES OF TAX LOT CENTROID)
Geosupport Functions:
1,1B (blockface information),1E,2,3 Extended,3C Extended,AP (For Function 1A, BL, BN, 1B (property level information) see also SPATIAL COORDINATES OF TAX LOT CENTROID)
Field Length:
7
Field Format:
Spatial coordinates consist of two fields, an X Coordinate and a Y Coordinate, each 7 bytes RJZF.
Field Status:
Active
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, 1B (blockface information), 1E, and AP), intersection (Function 2), and nodes at the end of a blockface (Functions 3 Extended and 3C Extended). 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, 1B (blockface information) 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, 1B (blockface information) 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, 1B (blockface information), and 1E return blanks in the spatial coordinate fields. Functions 1, 1B (blockface information), and 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 blockface. 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. The spatial coordinates returned by Functions 1/1E/1B (blockface information) for NAPs and Vanity Addresses (see Chapter V.9) were an estimate calculated by Geosupport. As of Version 11.2, Geosupport will use the Citywide Street Centerline file (CSCL) X-Y Coordinates. The CSCL information guarantees that the X-Y coordinates fall within the actual location of the NAP or Vanity Address. 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. In the case of Function 3 Extended and Function 3C Extended, the spatial coordinates returned are those of the nodes at the end of the blockface. Those coordinates represent an approximate center point of the intersection. In the case of Function AP, the spatial coordinates returned are those of the Address Point which is within 5 feet of the entrance(s) of the building. In the case of Functions 1A, BL, BN, 1B (property level information),the spatial coordinates returned are those of the Tax Lot Centroid. See SPATIAL COORDINATES OF THE TAX LOT CENTROID.
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
This item typically applies to Addressable Place Names, Non-addressable Place Names and Vanity Addresses. 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 FACE CODE and 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’, ‘N’, ‘P’, or ‘V’.
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.
Coded Values:
Code
Meaning
C
The 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](/appendices/appendix12/). For the work area layouts of the COWs, see [Appendix 13](/appendices/appendix13/).
Blank
The 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
U.S. Postal Service’s 5-digit ZIP code. ZIP code may also be used as input with functions 1, 1A, 1B, and 1E to identify the borough or Duplicate Address Pseudo-Street name (DAPS).
LocateNYC locator name. This is the internal locator that was used to locator the coordinates. This parameter is added for Esri reverseGeocode standardization.
The type of address that was returned in the reverse geocode. This will be 'PointAddress' if an address point locator was used. It will be 'StreetAddress' if an address interpolation was used. This parameter is added for Esri reverseGeocode standardization.
Match score. Indicates strength of match with 100 being the highest and 0 being the lowest (no match). This parameter is added for Esri reverseGeocode standardization
This indicates the Projected Coordinate System or the Geographic Coordinate System used to locate geographic features in the map. For a list of projected coordinate systems please see https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm. For a list of geographic coordinate systems please see https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm
This indicates the Projected Coordinate System or the Geographic Coordinate System used to locate geographic features in the map. For a list of projected coordinate systems please see https://developers.arcgis.com/rest/services-reference/projected-coordinate-systems.htm. For a list of geographic coordinate systems please see https://developers.arcgis.com/rest/services-reference/geographic-coordinate-systems.htm. Identifies the current wkid value associated with the same spatial reference. For example a WKID of '102100' (Web Mercator) may have a latestWKid of '3857' since '102100' is deprecated.
demo
sign up
powered by
