# Canada National Address Register

## Example Record

| Field                                           | Example                                          | Type     |
| ----------------------------------------------- | ------------------------------------------------ | -------- |
| [`id`](#id)                                     | cannar\_9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12\|en | `string` |
| [`dataset`](#dataset)                           | cannar                                           | `string` |
| [`country`](#country)                           | Canada                                           | `string` |
| [`country_iso`](#country_iso)                   | CAN                                              | `string` |
| [`country_iso_2`](#country_iso_2)               | CA                                               | `string` |
| [`language`](#language)                         | en                                               | `string` |
| [`address`](#address)                           | 1425                                             | `string` |
| [`line_1`](#line_1)                             | 1425 James St                                    | `string` |
| [`line_2`](#line_2)                             | PO Box 4001 STN A                                | `string` |
| [`latitude`](#latitude)                         | `48.4283`                                        | `number` |
| [`longitude`](#longitude)                       | `-123.355`                                       | `number` |
| [`loc_guid`](#loc_guid)                         | 1c3f0f4e-0d4a-4f2c-9c9d-3f9a1b2c4d5e             | `string` |
| [`addr_guid`](#addr_guid)                       | 9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12             | `string` |
| [`apt_no_label`](#apt_no_label)                 | Empty in this example                            | `string` |
| [`civic_no`](#civic_no)                         | 1425                                             | `string` |
| [`civic_no_suffix`](#civic_no_suffix)           | Empty in this example                            | `string` |
| [`official_street_name`](#official_street_name) | James                                            | `string` |
| [`official_street_type`](#official_street_type) | St                                               | `string` |
| [`official_street_dir`](#official_street_dir)   | Empty in this example                            | `string` |
| [`prov_code`](#prov_code)                       | 59                                               | `string` |
| [`csd_eng_name`](#csd_eng_name)                 | Victoria                                         | `string` |
| [`csd_fre_name`](#csd_fre_name)                 | Victoria                                         | `string` |
| [`csd_type_eng_code`](#csd_type_eng_code)       | CY                                               | `string` |
| [`csd_type_fre_code`](#csd_type_fre_code)       | V                                                | `string` |
| [`mail_street_name`](#mail_street_name)         | James                                            | `string` |
| [`mail_street_type`](#mail_street_type)         | St                                               | `string` |
| [`mail_street_dir`](#mail_street_dir)           | Empty in this example                            | `string` |
| [`mail_mun_name`](#mail_mun_name)               | Victoria                                         | `string` |
| [`mail_prov_abvn`](#mail_prov_abvn)             | BC                                               | `string` |
| [`mail_postal_code`](#mail_postal_code)         | V8X3X4                                           | `string` |
| [`bg_dls_lsd`](#bg_dls_lsd)                     | Empty in this example                            | `string` |
| [`bg_dls_qtr`](#bg_dls_qtr)                     | Empty in this example                            | `string` |
| [`bg_dls_sctn`](#bg_dls_sctn)                   | Empty in this example                            | `string` |
| [`bg_dls_twnshp`](#bg_dls_twnshp)               | Empty in this example                            | `string` |
| [`bg_dls_rng`](#bg_dls_rng)                     | Empty in this example                            | `string` |
| [`bg_dls_mrd`](#bg_dls_mrd)                     | Empty in this example                            | `string` |
| [`bg_x`](#bg_x)                                 | 3958372.7                                        | `string` |
| [`bg_y`](#bg_y)                                 | 1908456.3                                        | `string` |
| [`bu_n_civic_add`](#bu_n_civic_add)             | PO Box 4001 STN A                                | `string` |
| [`bu_use`](#bu_use)                             | 1                                                | `string` |
| [`csd_code`](#csd_code)                         | 5917034                                          | `string` |
| [`fed_code`](#fed_code)                         | 59034                                            | `string` |
| [`fed_eng_name`](#fed_eng_name)                 | Victoria                                         | `string` |
| [`fed_fre_name`](#fed_fre_name)                 | Victoria                                         | `string` |
| [`er_code`](#er_code)                           | 5910                                             | `string` |
| [`er_eng_name`](#er_eng_name)                   | Vancouver Island and Coast                       | `string` |
| [`er_fre_name`](#er_fre_name)                   | Île de Vancouver et la côte                      | `string` |
| [`reppoint_latitude`](#reppoint_latitude)       | `48.4283`                                        | `number` |
| [`reppoint_longitude`](#reppoint_longitude)     | `-123.355`                                       | `number` |

```json
{
  "id": "cannar_9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12|en",
  "dataset": "cannar",
  "country": "Canada",
  "country_iso": "CAN",
  "country_iso_2": "CA",
  "language": "en",
  "address": "1425",
  "line_1": "1425 James St",
  "line_2": "PO Box 4001 STN A",
  "latitude": 48.4283,
  "longitude": -123.355,
  "loc_guid": "1c3f0f4e-0d4a-4f2c-9c9d-3f9a1b2c4d5e",
  "addr_guid": "9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12",
  "apt_no_label": "",
  "civic_no": "1425",
  "civic_no_suffix": "",
  "official_street_name": "James",
  "official_street_type": "St",
  "official_street_dir": "",
  "prov_code": "59",
  "csd_eng_name": "Victoria",
  "csd_fre_name": "Victoria",
  "csd_type_eng_code": "CY",
  "csd_type_fre_code": "V",
  "mail_street_name": "James",
  "mail_street_type": "St",
  "mail_street_dir": "",
  "mail_mun_name": "Victoria",
  "mail_prov_abvn": "BC",
  "mail_postal_code": "V8X3X4",
  "bg_dls_lsd": "",
  "bg_dls_qtr": "",
  "bg_dls_sctn": "",
  "bg_dls_twnshp": "",
  "bg_dls_rng": "",
  "bg_dls_mrd": "",
  "bg_x": "3958372.7",
  "bg_y": "1908456.3",
  "bu_n_civic_add": "PO Box 4001 STN A",
  "bu_use": "1",
  "csd_code": "5917034",
  "fed_code": "59034",
  "fed_eng_name": "Victoria",
  "fed_fre_name": "Victoria",
  "er_code": "5910",
  "er_eng_name": "Vancouver Island and Coast",
  "er_fre_name": "Île de Vancouver et la côte",
  "reppoint_latitude": 48.4283,
  "reppoint_longitude": -123.355
}
```

Every field is documented below.

## General Information

* `id` string

  ID

  Example: `cannar_9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12|en`

* `dataset` string

  Dataset

  Example: `cannar`

  Enum: "cannar"

* `country` string

  Country

  Full country names (ISO 3166)

  Example: `Canada`

  Enum: "Canada"

* `country_iso` string

  Country ISO

  3 letter country code (ISO 3166-1)

  Example: `CAN`

  Enum: "CAN"

* `country_iso_2` string

  Country ISO 2

  2 letter country code (ISO 3166-1)

  Example: `CA`

  Enum: "CA"

* `language` string

  Language

  Language represented by 2 letter ISO Code (639-1)

  Example: `en`

  Enum: "en", "fr"

## Address Information

* `address` string

  Address

  House number, prefixed with the apartment or suite number and a hyphen where one is present. E.g. `1425` or `10-123 1/2`.

  Can be empty string `""` if not present.

  Example: `1425`

* `line_1` string

  Line 1

  First address line. House number and street.

  Can be empty string `""` if not present.

  Example: `1425 James St`

* `line_2` string

  Line 2

  Second address line. Carries the PO Box or Rural Route delivery information where present.

  Can be empty string `""` if not present.

  Example: `PO Box 4001 STN A`

* `latitude` string

  Latitude

  Example: `48.4283`

* `longitude` string

  Longitude

  Example: `-123.355`

## Geographic Coordinates

* `reppoint_latitude` string

  Representative Point Latitude

  Example: `48.4283`

* `reppoint_longitude` string

  Representative Point Longitude

  Example: `-123.355`

* `bg_x` string

  Background X Coordinate

  X coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string.

  Can be empty string `""` if not present.

  Example: `3958372.7`

* `bg_y` string

  Background Y Coordinate

  Y coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string.

  Can be empty string `""` if not present.

  Example: `1908456.3`

## Administrative and Political Divisions

* `prov_code` string

  Province Code

  Province code. E.g. `59` for British Columbia.

  Example: `59`

* `csd_eng_name` string

  Census Subdivision English Name

  Census subdivision English name.

  Can be empty string `""` if not present.

  Example: `Victoria`

* `csd_fre_name` string

  Census Subdivision French Name

  Census subdivision French name.

  Can be empty string `""` if not present.

  Example: `Victoria`

* `csd_type_eng_code` string

  Census Subdivision Type English Code

  English code indicating the type of Census Subdivision.

  Can be empty string `""` if not present.

  Example: `CY`

* `csd_type_fre_code` string

  Census Subdivision Type French Code

  French code indicating the type of Census Subdivision.

  Can be empty string `""` if not present.

  Example: `V`

* `csd_code` string

  Census Subdivision Code

  Unique identifier code for a Census Subdivision (CSD).

  Can be empty string `""` if not present.

  Example: `5917034`

* `fed_code` string

  Federal Code

  Unique identifier code for a federal electoral district.

  Can be empty string `""` if not present.

  Example: `59034`

* `fed_eng_name` string

  Federal English Name

  Name of the federal electoral district in English.

  Can be empty string `""` if not present.

  Example: `Victoria`

* `fed_fre_name` string

  Federal French Name

  Name of the federal electoral district in French.

  Can be empty string `""` if not present.

  Example: `Victoria`

* `er_code` string

  Electoral Region Code

  Unique identifier code for an economic region.

  Can be empty string `""` if not present.

  Example: `5910`

* `er_eng_name` string

  Electoral Region English Name

  Name of the economic region in English.

  Can be empty string `""` if not present.

  Example: `Vancouver Island and Coast`

* `er_fre_name` string

  Electoral Region French Name

  Name of the economic region in French.

  Can be empty string `""` if not present.

  Example: `Île de Vancouver et la côte`

## Land Survey Data

* `bg_dls_lsd` string

  Background Dominion Land Survey Legal Subdivision

  Legal Subdivision number within the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_qtr` string

  Background Dominion Land Survey Quarter

  Quarter section within a section of the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_sctn` string

  Background Dominion Land Survey Section

  Section number within a township of the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_twnshp` string

  Background Dominion Land Survey Township

  Township number within the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_rng` string

  Background Dominion Land Survey Range

  Range number within a meridian of the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_mrd` string

  Background Dominion Land Survey Meridian

  Meridian number within the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

## Building Usage

* `bu_n_civic_add` string

  Building Number Civic Address

  Additional delivery information for the mailing address, such as a PO Box or Rural Route. Upper cased, with the first `BOX` token recased to `Box` (`PO Box 377`).

  Can be empty string `""` if not present.

  Example: `PO Box 4001 STN A`

* `bu_use` string

  Building Use

  Building usage code.

  Can be empty string `""` if not present.

  Example: `1`

## Location Identifiers

* `loc_guid` string

  Location GUID

  Globally unique identifier for location.

  Example: `1c3f0f4e-0d4a-4f2c-9c9d-3f9a1b2c4d5e`

* `addr_guid` string

  Address GUID

  Globally unique identifier for address.

  Example: `9b7d2a10-5c31-4a6e-8f21-7d0c5e4b3a12`

## Official Address Components

* `apt_no_label` string

  Apartment Number Label

  Apartment or suite number.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `civic_no` string

  Civic Number

  The building number assigned to the address.

  Can be empty string `""` if not present.

  Example: `1425`

* `civic_no_suffix` string

  Civic Number Suffix

  A suffix attached to the civic number. E.g. `A` or `1/2`.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `official_street_name` string

  Official Street Name

  Official street name.

  Can be empty string `""` if not present.

  Example: `James`

* `official_street_type` string

  Official Street Type

  Official street designator. E.g. `St`, `Ave`.

  Can be empty string `""` if not present.

  Example: `St`

* `official_street_dir` string

  Official Street Direction

  Official street direction. E.g. `N`, `SE`.

  Can be empty string `""` if not present.

  Example: Empty in this example

## Mailing Address Components

* `mail_street_name` string

  Mail Street Name

  Name of the street used in the mailing address.

  Can be empty string `""` if not present.

  Example: `James`

* `mail_street_type` string

  Mail Street Type

  Designator of the street used in the mailing address.

  Can be empty string `""` if not present.

  Example: `St`

* `mail_street_dir` string

  Mail Street Direction

  Direction of the street used in the mailing address.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `mail_mun_name` string

  Mail Municipality Name

  Municipality name used in the mailing address.

  Can be empty string `""` if not present.

  Example: `Victoria`

* `mail_prov_abvn` string

  Mail Province Abbreviation

  Province abbreviation used in the mailing address.

  Can be empty string `""` if not present.

  Example: `BC`

* `mail_postal_code` string

  Mail Postal Code

  Postal code used in the mailing address. Returned as supplied by the provider, without a space between the forward sortation area and local delivery unit.

  Can be empty string `""` if not present.

  Example: `V8X3X4`

## Dominion Land Survey System

* `bg_dls_lsd` string

  Legal Subdivision

  Legal Subdivision number within the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_qtr` string

  Quarter Section

  Quarter section within a section of the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_sctn` string

  Section

  Section number within a township of the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_twnshp` string

  Township

  Township number within the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_rng` string

  Range

  Range number within a meridian of the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example

* `bg_dls_mrd` string

  Meridian

  Meridian number within the Dominion Land Survey system for the address location.

  Can be empty string `""` if not present.

  Example: Empty in this example
