This section contains the valid variables used with GSHGET, GSDATSET, GSDATGET, and GSMGET.
The following describes the contents of each table column:
Variable |
Lists the defined constant used to access this element. |
GSHGET |
|
GSDATSET |
A bullet • indicates this variable is valid when using GSDATSET. |
GSDATGET |
|
GSMGET |
Indicates the valid match types.
|
Length |
A number indicating the largest string GeoStan returns for this variable. This length includes a NULL-termination character. Symbolic constants use the naming convention <<NAME>>-LENGTH. For example the variable GS-ADDRLINE returns the input or output address line. The maximum length of an address line is 61. Therefore, the symbolic constant is GS-ADDRLINE-LENGTH and is defined as 61. |
Description |
A brief explanation of the information returned. If you use an invalid variable, GeoStan returns an Invalid Argument error. |
Variable Name | Buffer Length | GSHGET | GSDATSET | GSDATGET | GSMGET | ||||
---|---|---|---|---|---|---|---|---|---|
Street | Segment | Range | Input | Output | Centerline | ||||
GS-ADDRLINE
First address line or address line for singleline addresses. For singleline addresses, enter address line and last line combined as a single input, for example,"4750 Walnut St 80301". |
61 |
• | • | • | • | ||||
GS-ADDRLINE-SHORT
Shortest possible address line that can be constructed from available short street name and the other address line components. |
61 |
• | |||||||
GS-ADDR2
Second address line. |
61 |
• | • | • | |||||
GS-ADDRTYPE
Address Type regarding number of units:
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
GS-ALIAS
Use this to specify alias info instead of normal. |
• | • | • | • | |||||
GS-ALT-FLAG Base/Alternate record:
|
2 |
• | • |
A |
|||||
GS-APN-ID
Assessor's Parcel Number (APN) This field is only available with the MLD Extended Attributes Dataset. |
51 |
A,M |
A,M | ||||||
GS-AUX-USERDATA
User data from the auxiliary file. Blank if no auxiliary file. |
301 |
• | • | ||||||
GS-BEARING
Compass direction, in decimal degrees, from the point data match to the centerline match. Measured clockwise from 0 degrees north. |
6 |
• | |||||||
GS-BLOCK
15-digit census block ID/census FIPS code, using the syntax sscccttttttgbbb where:
If the address is on the left side of the street, GS-BLOCK will contain the equivalent of GS-BLOCK-LEFT. If the address is on the right, GS-BLOCK will contain the equivalent of GS-BLOCK-RIGHT. GeoStan does not return a period for the Census Tract FIPS Code, this may deviate from the industry standard. |
16 |
A |
A |
||||||
GS-BLOCK-2010
15-digit 2010 Census Block ID This field is only available with the MLD Extended Attributes Dataset. |
16 | A,M | |||||||
GS-BLOCK-LEFT
Census block ID from the left side of the street. See GS-BLOCK for more information. |
16 |
• | • |
A |
• | • | |||
GS-BLOCK-LEFT2
GS-BLOCK-LEFT for the second segment in the intersection. See GS-BLOCK for more information. |
16 |
I |
|||||||
GS-BLOCK-RIGHT
Census block ID from the right side of the street. See GS-BLOCK for more information. |
16 |
• | • |
A |
• | • | |||
GS-BLOCK-RIGHT2
GS-BLOCK-RIGHT for the second segment in the intersection. See GS-BLOCK for more information. |
16 |
I |
|||||||
GS-CART
Carrier route. |
5 |
• |
A |
A |
|||||
GS-CBSA-DIVISION-NAME
CBSA division name. |
128 |
• | • | ||||||
GS-CBSA-DIVISION-NAME2
GS-CBSA-DIVISION-NAME for the second segment in the intersection. |
128 |
I |
|||||||
GS-CBSA-DIVISION-NUMBER
CBSA division number. |
6 |
• | • | ||||||
GS-CBSA-DIVISION-NUMBER2
GS-CBSA-DIVISION-NUMBER for the second segment in the intersection. |
6 |
I |
|||||||
GS-CBSA-NAME
CBSA name. |
128 |
• | • | ||||||
GS-CBSA-NAME2
GS-CBSA-NAME for the second segment in the intersection. |
128 |
I |
|||||||
GS-CBSA-NUMBER
CBSA number. |
6 |
• | • | ||||||
GS-CBSA-NUMBER2
GS-CBSA-NUMBER for the second segment in the intersection. |
6 |
I |
|||||||
GS-CHECKDIGITb
Check digit. |
2 |
• | |||||||
GS-CITY
Abbreviated city name from the last line of the input or output address; the value from GS-NAME-CITY or GS-PREF-CITY. |
29 |
• | • | • | • | • | |||
GS-CITY-SHORT
The output city name that appears in GS_LASTLINE_SHORT. This value is determined by logic similar to GS_CITY. Whenever possible, this city name is 13 characters or less. This output city name is determined by CASS rules. This can be either City State Name, City State Name Abbreviation, or Preferred Last Line City State Name. |
29 |
• | • | ||||||
GS-CLOSE-MATCH
Indicates if the address was a Close match.
|
• | • | |||||||
GS-CMSA
CMSA name. |
81 |
• | • | ||||||
GS-CMSA-NUMBER
CMSA number. |
5 |
• | • | ||||||
GS-COUNTY
Current county FIPS code assigned by the state. This value may be different than the Census County FIPS code from the last US Census which is returned in GS_BLOCK, GS_BLOCK2, GS_BLOCK_LEFT, GS_BLOCK_LEFT2, GS_BLOCK_RIGHT, and GS_BLOCK_RIGHT2.
|
6 |
• | • | • | |||||
GS-COUNTY2
GS-COUNTY for the second segment in the intersection. |
6 |
I |
|||||||
GS-COUNTY-FIPS
Current county FIPS code assigned by the state. This value may be different than the Census County FIPS code from the last US Census which is returned in GS_BLOCK, GS_BLOCK2, GS_BLOCK_LEFT, GS_BLOCK_LEFT2, GS_BLOCK_RIGHT, and GS_BLOCK_RIGHT2. |
4 |
• | |||||||
GS-COUNTY-NAME
County name assigned by the state. |
128 |
• | • | • | |||||
GS-COUNTY-NAME2
GS-COUNTY-NAME for the second segment in the intersection. |
128 |
I |
|||||||
GS-CSA-NAME
CSA name. |
128 |
• | • | ||||||
GS-CSA-NAME2
GS-CSA-NAME for the second segment in the intersection. |
128 |
I |
|||||||
GS-CSA-NUMBER
CSA number. |
4 |
• | • | ||||||
GS-CSA-NUMBER2
GS-CSA-NUMBER for the second segment in the intersection. |
4 |
I |
|||||||
GS-CTYST-KEY
USPS city state key (an alphanumeric value that uniquely identifies a locale in the USPS city state product). |
7 |
• | • | • | |||||
GS-DATATYPE
Type of data used to make the match.
|
3 |
• | • | • | • | ||||
GS-DATATYPE2
GS-DATATYPE for the second segment in the intersection. |
3 |
I |
|||||||
GS-DFLTb
Indicates the return status of GS-HI-RISE-DFLT and GS-R-RTE-DFLT
|
2 |
• |
A |
||||||
GS-DPBCb
Delivery Point Bar Code. |
3 |
• | |||||||
GS-DPV-CONFIRM
Indicates if a match occurred for DPV data.
|
2 |
• | |||||||
GS-DPV-CMRA
DPV CMRA indicator.
|
2 |
• | |||||||
GS-DPV-FALSE-POS
DPV false-positive indicator.
|
2 |
• | |||||||
GS-DPV-FOOTNOTE1
Information about matched DPV records.
|
3 |
• | |||||||
GS-DPV-FOOTNOTE2
Information about matched DPV records.
A unique ZIP Code is a ZIP Code assigned to a company, agency, or entity with sufficient mail volume to receive its own ZIP Code. |
3 |
• | |||||||
GS-DPV-FOOTNOTE3
Information about matched DPV records.
|
3 |
• | |||||||
GS-DPV-FOOTNOTE4
Reserved by USPS for future use. |
3 |
• | |||||||
GS-DPV-FOOTNOTE5
Reserved by USPS for future use. |
3 |
• | |||||||
GS-DPV-FOOTNOTE6
Reserved by USPS for future use. |
3 |
• | |||||||
GS-DPV-NO-STAT
|
2 | A | |||||||
GS-DPV-SHUTDOWN
|
2 |
• | |||||||
GS-DPV-VACANT
|
3 |
• | |||||||
GS-EWS-MATCH
Indicates if GeoStan made an EWS match.
|
2 |
• | |||||||
GS-FIRM-NAME
Name of firm from the USPS data or the input firm name. |
41 |
• | • | • |
A |
A |
|||
GS-GOVT-FLAG
Government building indicator.
A, B, C, E, F, and G are valid for alternate records only (GS-ALT-FLAG=A). D is valid for both base and alternate records. |
2 |
• | • |
A |
|||||
GS-HI-RISE-DFLT
Indicates if GeoStan matched to a highrise.
|
2 |
• |
A |
||||||
GS-HIRANGE
House number at high end of range. |
12 |
• |
A |
A |
|||||
GS-HIUNIT
High unit number. |
12 |
• |
A |
A |
|||||
GS-HIZIP4
High ZIP + 4 for this range. |
5 |
• |
A |
||||||
GS-HOUSE-NUMBER
House number of input or output address. |
12 |
• |
A |
• | |||||
GS-HOUSE-NUMBER2
Second house number for a ranged house number match. If GS_FIND_ADDRESS_RANGE is enabled, the second number in the ranged address. |
12 |
• |
A |
• | |||||
GS-INC-IND
Incorporated Place Indicator.
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
GS-INTERSECTION
Indicates if the address is an intersection.
|
2 |
• | • | • | |||||
GS-IS-ALIAS
The first character is:
|
4 |
• | • | • |
A |
• | • | ||
GS-LACS-FLAG
Indicates if GeoStan marked the address for conversion.
|
2 |
• | • |
A |
|||||
GS-LACSLINK-IND
LACSLink indicator.
|
2 |
• | |||||||
GS-LACSLINK-SHUTDOWN
|
2 |
• | |||||||
GS-LACSLINK-RETCODE
LACSLink return code.
|
3 |
• | |||||||
GS-LASTLINEc
Complete last line (ZIP + 4 not available with GSMGET or intersection matches). |
61 |
• | • | • | • | • | |||
GS-LASTLINE-SHORT
This is the address "lastline". It contains the values of GS_CITY_SHORT, GS_STATE, and GS_ZIP10. Whenever possible, this field is 29 characters or less:
|
61 |
• | |||||||
GS-LAT
Latitude of located point (in millionths of degrees). |
11 |
• | • | • | • | ||||
Used for multiple line entry. GeoStan does not process these as output. PMB-DESIGNATOR and PMB-NUMBER are not returned in this mode. |
104 |
• | |||||||
GS-LOC-CODE
Location code. For descriptions of location codes, see Status Codes |
5 |
• | • | ||||||
GS-LON
Longitude of located point (in millionths of degrees). |
12 |
• | • | • | • | ||||
GS-LORANGE
House number at low end of range. |
12 |
• |
A |
A |
|||||
GS-LOT-CODEb
eLot ascending and descending value. Only available for addresses GeoStan can standardize. |
2 |
• | |||||||
GS-LOT-NUMb
4-digit eLOT number. Requires an input address GeoStan can standardize. |
5 |
• | |||||||
GS-LOTSIZE
Lot size of the parcel expressed in square feet; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
11 |
A,M |
A,M |
||||||
GS-LOTSIZE-METERS
Lot size of the parcel expressed in square meters; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
11 |
A,M |
A,M |
||||||
GS-LOUNIT
Low unit number. |
12 |
• |
A |
A |
|||||
GS-LOZIP4
Low ZIP + 4 for this range. |
5 |
• |
A |
||||||
GS-MAIL-STOP
Returns address information appearing after mail stop designator words: MSC, MS, MAILSTOP, MAIL STOP, ATTN, ATTENTION. |
61 |
• | |||||||
GS-MATCH-CODE
Match code. For descriptions of match codes, see Status Codes |
5 |
• | • | ||||||
GS-MATCHED-DB
Index of database for matched record. |
• | • | |||||||
GS-MCD-NAME
Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match. |
41 |
• |
A |
||||||
GS-MCD-NUMBER
Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match. |
6 |
• |
A |
||||||
GS-METRO-FLAG
Indicates if GS-CBSA-NAME
|
2 |
• | • | ||||||
GS-METRO-FLAG2
GS-METRO-FLAG for the second segment in the intersection. |
2 |
I |
|||||||
GS-MM-RESULT-CODE
Returns a MapMarker style result code. |
12 |
• | • | ||||||
GS-NAME
Street name |
41 |
• | • | • | • | • | • | • | |
GS-NAME2
Second street name in an intersection match. |
41 |
I |
I |
• | |||||
GS-NAME-CITY
City name for the matched address from the City State record. |
29 |
• | • | ||||||
GS-NAME-SHORT
The short street name field contains the short street name used to construct the short address line. All attempts are made to abbreviate this name according to the process specified by the USPS in the 30 Character Abbreviation - Cycle M Flow Chart. If an abbreviated address cannot be constructed that is 30 characters or less, this field then contains the same street name value as the GS_NAME field variable return. |
41 |
• | |||||||
GS-NON-DELIVERABLE
Indicates if the USPS can deliver mail to the output address.
|
2 | A | |||||||
GS-PARCEN-ELEVATION
Elevation, in feet, of the geocode at the parcel centroid. This field is only available with the MLD Extended Attributes Dataset. |
7 |
A,M |
A,M |
||||||
GS-PARCEN-ELEVATION-METERS
Elevation, in meters, of the geocode at the parcel centroid. This field is only available with the MLD Extended Attributes Dataset. |
7 |
A,M |
A,M |
||||||
GS-PARENT-ID
Precisely ID of the address without units or blank if there are no units This field is only available with the MLD Extended Attributes Dataset. |
13 |
M |
M | ||||||
GS-PB-KEY
As an input field used with GSDATSET, this field specifies the PreciselyID unique identifier is used as input data for matching with Reverse PreciselyID Lookup. For more information, see PreciselyID Fallback. As an output field, this is a unique address identifier returned when an address match is returned from the Master Location Dataset. The leading character is a 'P'. For example: P00001XSF1IF For a fallback GS-PB-KEY, the leading character is an 'X'. For more information, see GS-FIND-APPROXIMATE-PBKEY. Fallback PreciselyIDs are not returned using GSHGET. This field is only available for the Master Location Dataset. |
13 |
A,M |
• |
A,M |
A,M |
||||
GS-PERCENT-GEOCODE
Percentage along the street segment to the interpolated match. The range is 0.0 - 100.0. The range is always 0.0 for point data. |
5 |
R |
A |
||||||
GS-PLACE
TIGER Place code; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
8 |
A,M |
A,M |
||||||
GS-PMB-DESIGNATOR
PMB designator (always "PMB"). Not output when using GS-LINE to set the address. |
5 |
• | |||||||
GS-PMB-NUMBER
PMB number. Not output when using GS-LINE to set the address. |
9 |
• | |||||||
GS-POBOX-ZONE
Indicates if the ZIP Code has only PO Box addresses. Those addresses can be either a PO Box or a PO Box street address (PBSA).
|
2 | A | |||||||
GS-POINT-ID
Unique point ID of the matched record when matched to point-level data. Blank if the matched record is not from point-level data. |
11 |
A,M,P |
A,M,P |
A,M,P |
|||||
GS-POSTDIR
Postfix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
3 |
• | • | • | • | • | • | • | |
GS-POSTDIR2
Cross street postfix direction. |
3 |
I |
I |
I |
|||||
GS-POSTDIR-SHORT
Postdir from the GS-ADDRLINE-SHORT. |
3 |
• | |||||||
GS-PREDIR
Prefix direction. Can be blank, N, S, E, W, NE, NW, SW, or SE. |
3 |
• | • | • | • | • | • | • | |
GS-PREDIR2
Cross street prefix direction. |
3 |
I |
I |
I |
|||||
GS-PREDIR-SHORT
Predir from the GS-ADDRLINE-SHORT. |
3 |
• | • | ||||||
GS-PREF-CITY
Preferred city name for the output ZIP Code of the matched address. |
29 |
• | • | ||||||
GS-PROPERTY-ACCOUNT-ID
County property account ID This field is only available for the Master Location Dataset. |
51 |
M |
M | ||||||
GS-QCITY
State , city , or finance numbers. |
10 |
• | • | • | • | • | • | ||
GS-R-RTE-DFLT
Match indication for rural routes.
|
2 |
• |
A |
||||||
GS-RANGE-PARITY
Indicates the parity of the house number in the range.
|
41 |
• |
A |
||||||
GS-RDI-RETCODE
USPS Residential Delivery Indicator (requires DPV-confirmed ZIP+4)
|
2 | A | |||||||
GS-REC-TYPEb
Range record type.
|
2 |
• |
A |
A |
|||||
GS-RESBUS
Usage indicator
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
GS-RESOLVED-LINE
indicates which line in a 2-line address GeoStan used to resolve the address. Relates to GS-ADDRLINE and GS-ADDR2 with GSDATSET. |
5 |
• | |||||||
GS-ROAD-CLASS
Road class code.
|
3 |
• | • |
A |
• | • | |||
GS-ROAD-CLASS2
GS-ROAD-CLASS for the second segment in the intersection. |
3 |
I |
|||||||
GS-SEG-HIRANGE
High house number in segment. |
12 |
• | • | • | • | ||||
GS-SEG-HIRANGE2
GS-SEG-HIRANGE for the second segment in the intersection. |
12 |
I |
|||||||
GS-SEG-LORANGE
Low house number in segment. |
12 |
• | • | • | • | ||||
GS-SEG-LORANGE2
GS-SEG-LORANGE for the second segment in the intersection. |
12 |
I |
|||||||
GS-SEGMENT-DIRECTION
|
2 |
• | • | • | • | ||||
GS-SEGMENT-DIRECTION2
GS-SEGMENT-DIRECTION for the second segment in the intersection. |
2 |
I |
|||||||
GS-SEGMENT-ID
Segment ID (TLID) or unique ID from premium data vendors. |
11 |
• | • |
A |
• | • | |||
GS-SEGMENT-ID2
GS-SEGMENT-ID for the second segment in the intersection. |
11 |
I |
|||||||
GS-SEGMENT-PARITY
Odd numbers in the segment are on:
|
2 |
• | • | • | • | ||||
GS-SEGMENT-PARITY2
GS-SEGMENT-PARITY for the second segment in the intersection. |
2 |
I |
|||||||
GS-STATE
State abbreviation. |
3 |
• | • | • | • | • | • | • | |
GS-STATE-FIPS
State FIPS code. |
3 |
• | |||||||
GS-STREET-SIDE
The matched address is on the following side of the street:
This is relative to the segment end points and the segment direction (GS-SEGMENT-DIRECTION). This enum does not reflect the value in the "Side of Street" field of any particular data vendor. |
2 |
• |
A |
||||||
GS-SUITELINK-RET-CODE
|
4 |
A |
|||||||
GS-TFID
TIGER Face Identifier. This field can be used to match to all Census geocodes using external data; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
10 |
A,M |
A,M |
||||||
GS-TYPE
Street type (also called street suffix). |
5 |
• | • | • | • | • | • | • | |
GS-TYPE2
Cross street type. |
5 |
I |
I |
I |
|||||
GS-TYPE-SHORT
Postdir from the GS-ADDRLINE-SHORT. |
6 |
• | |||||||
GS-UACE
TIGER Urban Area Identifier. Defines the urban area if any; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
6 |
A,M |
A,M |
||||||
GS-UACEPOP
Census population of the urban area; 0 if none. This field is only available with the MLD Extended Attributes Dataset. |
11 |
A,M |
A,M |
||||||
GS-UNIT-NUMBER
Unit number. |
12 |
A |
A |
A |
|||||
GS-UNIT-NUMBER2
Second unit number parsed from the address line. Available in CASS and relaxed modes only. |
12 |
A |
A |
||||||
GS-UNIT-PARITY
Indicates the parity of the unit number range (GS-LOUNIT and GS-HIUNIT).
|
2 |
• |
A |
||||||
GS-UNIT-TYPE
Unit type (APT, STE, etc.). |
5 |
• |
A |
A |
A |
||||
GS-UNIT-TYPE2
Second unit type parsed from the address line. Available in CASS and relaxed modes only. |
5 |
A |
A |
||||||
GS-URBANICITY
Urbanicity Indicator. An indicator that defines per the Census the Urbanicity of the Address using TIGER UACE codes for categorization.
This field is only available with the MLD Extended Attributes Dataset. |
2 |
A,M |
A,M |
||||||
GS-URB-NAME
Urbanization name for Puerto Rico. |
31 |
• | • | • |
A |
||||
GS-ZIP
5-digit ZIP Code. |
6 |
• | • |
A |
A |
• | |||
GS-ZIP4b
4-digit ZIP Code extension. |
5 |
• |
A |
A |
A |
||||
GS-ZIP9c
9-digit ZIP Code (ZIP + 4). |
10 |
• |
A |
A |
A |
||||
GS-ZIP10c
9-digit ZIP Code (ZIP + 4) with dash separator. |
11 |
• |
A |
A |
A |
||||
GS-ZIP-CARRTSORT
Indicates the type of cart sort allowed.
|
2 |
• |
A |
• | |||||
GS-ZIP-CITYDELV
Indicates if city-delivery is available.
|
2 |
• |
A |
• | |||||
GS-ZIP-CLASS
ZIP Classification Code:
|
2 |
• | • | • | |||||
GS-ZIP-FACILITY
Returns USPS City State Name Facility Code.
|
2 |
• | • | • | |||||
GS-ZIP-UNIQUE
|
2 |
• | • | • | |||||
GS-ZIP-VALID
Describes if the output ZIP Code is valid.
|
2 | A |
aThe length column is not applicable. bBlank if running in CASS mode and you have not initialized DPV or the output address does not DPV confirm. cLast 4 digits are blank if running in CASS mode and you have not initialized DPV or the output address does not DPV confirm. For GSMGET(), GeoStan returns ZIP+4 but only for Address matches. |