PostalAddress
Describes the properties of a postal delivery address.
Note that while this is tailored to USPS addresses, it can be used for other postal services, with varying degrees of success.
Title
Postal Address
Extends
Properties
accuracy?
optional accuracy: null | PostalAddressAccuracy;
The accuracy of the postal address determined during geocoding.
Title
Postal Address Accuracy
admin_level1?
optional admin_level1: AdminLevel1Abbreviation;
The two-letter abbreviation of a US state.
Title
State Abbreviation
country_code?
optional country_code: string;
The two-letter abbreviation of a US state.
Title
Country
created_at?
optional created_at: Date;
The date and time the record was created.
Title
Created At
Inherited from
deleted_at?
optional deleted_at: Date;
The date and time the record was soft deleted.
Title
Deleted At
Inherited from
directional_abbreviation?
optional directional_abbreviation: DirectionalAbbreviation;
The 8 directional abbreviations accepted by the USPS.
Example
N, NE, E, SE, S, SW, W, NW
Title
Directional Abbreviation
fabric_id?
optional fabric_id: number;
FCC Broadband serviable location ID.
Title
Broadband Servicable Location ID
FOOTPRINT?
optional FOOTPRINT: null | MultiPolygonLiteral<SolidPolygonPath>;
The footprint of the address, if any.
Title
Footprint
formatted_address
formatted_address: string;
The canonical address, as determined by a geocoding service.
Example
123 Main Street, Apt 1, San Francisco, California 94103, USA
Title
Formatted Address
GEOID?
optional GEOID: string;
The Census GEO ID associated with the address, if any.
Title
Census Geo ID
GEOM
GEOM: PointLiteral;
The geographic coordinates of the address.
Title
Geographic Coordinates
google_place_id?
optional google_place_id: GooglePlaceID;
A place ID provided by Google's geocoding API.
Note that while place IDs are unique, they are not stable over time. This means that the same place ID may refer to a different location at a later date.
Title
Google Place ID
See
h3_cell?
optional h3_cell: H3Cell;
The H3 cell associated with the address, typically at resolution 15.
Title
H3 Cell
id
id: PostalAddressID;
The unique identifier of the postal address, derived from the address components.
Title
Postal Address ID
locality?
optional locality: string;
The city, town, village, or other locale portion of the address.
Example
San Francisco, New York, Los Angeles
Title
Locality
plus_code?
optional plus_code: null | string;
A Plus Codes is a location-based digital addressing system that covers the entire world, allowing people to refer to any location on the Earth.
Title
Plus Code
See
po_box?
optional po_box: string;
Present for PO Box addresses.
Example
PO Box 123, P.O. Box 456
Title
PO Box
pointsOfContact?
optional pointsOfContact: PointOfContact[];
The points of contact associated with the postal address, if any.
Title
Points of Contact
postal_code?
optional postal_code: string | ZipCode | ZipCodePlusFour;
The ZIP code portion of the address.
Title
ZIP Code
postal_floor?
optional postal_floor: string;
Present when the floor of the address is specified.
Example
Floor 1, 2nd Floor, 3rd Floor, Basement
Title
Floor
range_first?
optional range_first: number;
The first number of the address range, such as the beginning of a block.
Example
100, 200, 300
Title
Range First
range_last?
optional range_last: number;
The last number of the address range, such as the end of a block.
Example
199, 299, 399
Title
Range Last
sanitized_address
sanitized_address: SanitizedPostalAddress;
The formatted mail delivery address.
Example
123 MAIN ST, APT 1, SAN FRANCISCO, CA 94103
Title
Formatted Address
secondary_address_designator?
optional secondary_address_designator: string;
Present when the address is a secondary unit, i.e. an apartment, suite, or unit.
Example
Apt 1, Suite 2, Unit 3
Title
Secondary Address Designator
street_name?
optional street_name: string;
The name portion of the road.
Example
Main, Elm, Maple
Title
Street Name
street_number?
optional street_number: string;
The house number portion of the address.
Example
123, 456, 789
Title
Street Number
street_suffix_abbreviation?
optional street_suffix_abbreviation:
| "ALY"
| "ANX"
| "ARC"
| "AVE"
| "BYU"
| "BCH"
| "BND"
| "BLF"
| "BLFS"
| "BTM"
| "BLVD"
| "BR"
| "BRG"
| "BRK"
| "BRKS"
| "BG"
| "BGS"
| "BYP"
| "CP"
| "CYN"
| "CPE"
| "CSWY"
| "CTR"
| "CTRS"
| "CIR"
| "CIRS"
| "CLF"
| "CLFS"
| "CLB"
| "CMN"
| "CMNS"
| "COR"
| "CORS"
| "CRSE"
| "CT"
| "CTS"
| "CV"
| "CVS"
| "CRK"
| "CRES"
| "CRST"
| "XING"
| "XRD"
| "XRDS"
| "CURV"
| "DL"
| "DM"
| "DV"
| "DR"
| "DRS"
| "EST"
| "ESTS"
| "EXPY"
| "EXT"
| "EXTS"
| "FALL"
| "FLS"
| "FRY"
| "FLD"
| "FLDS"
| "FLT"
| "FLTS"
| "FRD"
| "FRDS"
| "FRST"
| "FRG"
| "FRGS"
| "FRK"
| "FRKS"
| "FT"
| "FWY"
| "GDN"
| "GDNS"
| "GTWY"
| "GLN"
| "GLNS"
| "GRN"
| "GRNS"
| "GRV"
| "GRVS"
| "HBR"
| "HBRS"
| "HVN"
| "HTS"
| "HWY"
| "HL"
| "HLS"
| "HOLW"
| "INLT"
| "IS"
| "ISS"
| "ISLE"
| "JCT"
| "JCTS"
| "KY"
| "KYS"
| "KNL"
| "KNLS"
| "LK"
| "LKS"
| "LAND"
| "LNDG"
| "LN"
| "LGT"
| "LGTS"
| "LF"
| "LCK"
| "LCKS"
| "LDG"
| "LOOP"
| "MALL"
| "MNR"
| "MNRS"
| "MDW"
| "MDWS"
| "MEWS"
| "ML"
| "MLS"
| "MSN"
| "MTWY"
| "MT"
| "MTN"
| "MTNS"
| "NCK"
| "ORCH"
| "OVAL"
| "OPAS"
| "PARK"
| "PKWY"
| "PASS"
| "PSGE"
| "PATH"
| "PIKE"
| "PNE"
| "PNES"
| "PL"
| "PLN"
| "PLNS"
| "PLZ"
| "PT"
| "PTS"
| "PRT"
| "PRTS"
| "PR"
| "RADL"
| "RAMP"
| "RNCH"
| "RPD"
| "RPDS"
| "RST"
| "RDG"
| "RDGS"
| "RIV"
| "RD"
| "RDS"
| "RTE"
| "ROW"
| "RUE"
| "RUN"
| "SHL"
| "SHLS"
| "SHR"
| "SHRS"
| "SKWY"
| "SPG"
| "SPGS"
| "SPUR"
| "SQ"
| "SQS"
| "STA"
| "STRA"
| "STRM"
| "ST"
| "STS"
| "SMT"
| "TER"
| "TRWY"
| "TRCE"
| "TRAK"
| "TRFY"
| "TRL"
| "TRLR"
| "TUNL"
| "TPKE"
| "UPAS"
| "UN"
| "UNS"
| "VLY"
| "VLYS"
| "VIA"
| "VW"
| "VWS"
| "VLG"
| "VLGS"
| "VL"
| "VIS"
| "WALK"
| "WALL"
| "WAY"
| "WAYS"
| "WL"
| "WLS";
The standard abbreviation of the street's suffix portion of the address.
Example
ST, AVE, BLVD, RD
Title
Street Suffix Abbreviation
updated_at?
optional updated_at: Date;
The date and time the record was last updated.
Title
Updated At