AddressZen Dashboard

API Reference

OpenAPI reference for api.addresszen.com: global address autocomplete, validation and enrichment.

Download YAML Download JSON
API docs by Redocly

API Reference (4.2.0)

Support: support@addresszen.com URL: https://addresszen.com/support License: Copyright (C) IDDQD Limited - All Rights Reserved Terms of Service
More on our APIs, libraries with guides and examples

Getting Started

All API methods are either a GET, POST or OPTIONS request.

The API communicates over both HTTPS and plain HTTP using IPv4 and IPv6.

We use appropriate HTTP status codes where possible to indicate the request status. Every error body also carries a numeric code. The error codes guide lists each code and how to fix it.

OpenAPI Spec

Our OpenAPI specification is available at:

Rate Limiting

Each IP address is rate limited at 30 requests per second. Exceeding the limit returns a 503 response.

The autocomplete API has an additional rate limit.

If you expect to exceed the limit, contact us and we can move you to an endpoint with a higher limit.

Authentication

Most requests need an API key. Send it as a Bearer token in the Authorization header:

curl 'https://api.addresszen.com/v1/autocomplete/addresses?q=parkside' \
  -H 'Authorization: Bearer ak_test'

A header keeps the key out of URLs and server logs.

Two credentials exist, and they do different jobs:

Credential Looks like Authenticates Exposure
API Key ak_test Address, postcode and place lookups. Every billable request Usable in a browser. Restrict it with allowed URLs
Management Key uk_... Managing a key under /keys/{key}: usage, licensees, configs Secret. Server side only

Requests that manage a key, under /keys/{key}, take your Management Key instead: Authorization: Bearer uk_.... The API key is already in the path. The management key was previously called the user token.

To bill a request to a licensee, send the licensee key as the Bearer token: Authorization: Bearer sl_....

If you cannot set headers, for example in some browser integrations, pass the key as api_key in the query string (or the management key as user_token):

api.addresszen.com/v1/autocomplete/addresses?api_key=ak_test&q=parkside

The query string takes precedence when both are present.

The older Authorization: api_key="ak_test" form still works but is deprecated. Use Bearer in new integrations.

Versioning

This API is versioned with a simple prefix in the URL. The current version is /v1/. We will maintain backwards-compatibility by releasing breaking changes under a new version.

The following changes are backwards-compatible:

  • Adding new properties to existing API responses
  • Adding new API endpoints
  • Adding new optional request parameters to existing API endpoints
  • Changing the order of properties in existing API responses
  • Changing the autocomplete address suggestion format

Error Handling

A successful lookup returns an HTTP status code of 200 and a response code of 2000 in the body.

Any other status code means an error. These range from a benign 404 (resource not found) to more urgent problems, such as an API Key out of credit or a failed authentication.

Testing

To test the API, create an account. Each new account comes with a free test balance. Contact us if you need more for testing and integration.

The code samples in this reference use the ak_test key. You can use it too, but it is capped at 5 requests per day.

Metadata

You can annotate requests that affect your balance with arbitrary metadata. We store it with your lookup history, and you can query it later via the API or the dashboard. We call the ability to label your requests tagging.

Response Codes

The API returns two indicators to help you determine the status of each HTTP request.

The first is the HTTP Status, which is found in the status line of every HTTP response. The API will return status codes that adhere to HTTP/1.1 Specifications wherever possible.

2XX status codes indicate success while 4XX and 5XX indicate client and server errors respectively.

The second is the API response code, which can be found in the code property of the response body. This code gives a more specific reason for a failure and points you in the right direction when debugging.

Verify Address

Verifies an address against the USPS Coding Accuracy Support System (CASS) and returns it standardized and corrected.

Submit the whole address in query, or the first address line in query with either zip_code, or city and state. A freeform query is parsed into those components before the search runs.

A match returns the standardized address lines, city, state and ZIP+4, scored by fit and confidence. It also carries the CASS record behind the match: delivery point, DPV flags, carrier route, eLOT, county, congressional district, RDI, time zone and coordinates. CASS corrects what it can, so an address with the wrong city or state for its ZIP code still verifies, with the corrected values.

An address that cannot be verified returns 200 with a count of 0, a null match and empty address fields. match_information says why, e.g. Address not found or House number not valid for this street. It is for people to read and its wording may change, so test match for null rather than parsing it.

In the United States every verification the CASS engine answers draws on your balance, matched or not. A query that cannot be parsed into an address does not. Elsewhere only a match draws on your balance. A key without address verification enabled returns 401. A verification still running after 9.5 seconds aborts with 429.

Countries

Verify defaults to the United States, where it is CASS certified. Pass context with an ISO 3166-1 alpha-3 country code to verify an address elsewhere, e.g. context=GBR or context=FRA. The address datasets your key is licensed for decide which countries it can verify.

Outside the United States there is no CASS record, so match is the address in the same format Retrieve Address returns: USPS-style field names, empty strings where the country has no equivalent, and the raw dataset record in native. Check dataset to tell the two apart: it is present on every non-US match and absent from a CASS match.

The top-level fields (address_line_one, address_line_two, city, state, zip_code, country_iso_2) are populated for every country, along with confidence and fit.

Authorizations:
ApiKey
query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

tags
string
Example: tags=foo,bar

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

context
string
Example: context=usa

Identify the country of the address to verify. Defaults to United States (USA)

Request Body schema: application/json
required
query
required
string

Address input to verify.

If submitting a freeform address verification query, enter the full address. E.g. query=123 Main St, Springfield, CO, 81073

Otherwise, query can be accompanied with the following address components:

  • zip_code
  • city and state

If you supply zip_code, or city and state, omit that information from query and use it for the first address line only. E.g. query=123 Main St

zip_code
string

Specify the ZIP code of an address. The following formats are accepted: 81073-1119, 810731119, 81073.

city
string

City of an address.

state
string

State of an address. For the US, use the 2-letter state abbreviation.

Responses

Request samples

Content type
application/json
{
  • "query": "123 Main St, Springfield, CO 81073",
  • "zip_code": "81073-1119",
  • "city": "Springfield",
  • "state": "CO"
}

Response samples

Content type
application/json
{
  • "code": 2000,
  • "message": "Success",
  • "result": {
    }
}

Find Address

Returns address suggestions for a partial address, ranked by relevance. Use it to autofill an address form as the user types.

A suggestion is a display label and an id, not a full address. Retrieve the address with a second request to /autocomplete/addresses/{id}/usa. That second request is the one which decrements your lookup balance.

Autocomplete is not a free standalone resource. We rate limit, then suspend, keys that autocomplete without resolving suggestions.

Our address autocomplete JavaScript libraries add this to a form without calling the API directly.

Coverage

Each search runs in one country, selected with context. A missing or unrecognized context falls back to your account default. Results come from the datasets enabled on your key: USPS Zip+4 for the US and its territories, and the country datasets you license elsewhere. Where a key has more than one dataset for a country, dataset narrows the search.

Filters

Filters restrict results, e.g. state_code=NY searches New York only. A filter which matches no address returns an empty set. An unrecognized filter name is ignored. Neither affects your lookup balance.

Filters combine with AND logic, so state_code=CA&city=San Francisco requires both. A comma-separated value combines terms for one filter, e.g. postal_code_3=11225,11226,11238 accepts any of the three ZIP codes. Unless a parameter states otherwise, every filter takes multiple terms. The maximum is 10 filter terms.

Address bias

Bias terms carry the bias_ prefix and promote addresses rather than restricting the set, so unmatched addresses still appear, lower down. For example, bias_state_code=NY,NJ favors addresses in New York and New Jersey, bias_lonlat favors addresses near a point. Invalid bias terms have no effect. Multiple bias terms are allowed unless stated otherwise, with a combined maximum of 5.

Suggestion format

The suggestion string is subject to change. Present it to the user as it arrives rather than parsing it.

Rate limiting and cost

The default rate limit is 3,000 requests per 5 minutes, counted per API key and IP address. The X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers report the current window.

Autocomplete requests do not draw on your balance. Resolving a suggestion to a full address does.

Authorizations:
ApiKey
query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

query
string <= 150 characters
Example: query=123 main st spring

Address Query

The partial address string entered by the user to autocomplete.

dataset
Array of strings (Dataset)
Items Enum: "paf" "pafw" "pafa" "mr" "nyb" "usps" "ecaf" "ecad" "ab" "abp" "herewe" "heret" "heresa" "hereo" "herena" "heremeas" "heremea" "herem" "herei" "herehk" "hereee" "hereap" "gnaf" "kadaster" "kartverket" "sdfi" "cannar" "fodbosa" "mois" "upujp" "bev" "ban" "swt"
Example: dataset=usps

Filter by Dataset

Comma-separated list of datasets to search within.

Filters results to only include addresses from the specified datasets. Useful for keys with multiple overlapping datasets enabled (e.g. paf and abp).

context
string
Example: context=USA

Context

Limits search results, typically within a country.

limit
integer <int32> [ 1 .. 100 ]
Default: 10
Example: limit=5

Limit

Specifies the maximum number of records to retrieve.

By default the limit is 10. Requesting a larger result set adds latency.

bias_lonlat
string
Example: bias_lonlat=-2.095,57.15,100

Bias by Geolocation

Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is 50000. Uses the format bias_lonlat=[longitude],[latitude],[radius in meters]. Only one geospatial bias may be provided.

bias_ip
string
Value: "true"

Bias by Geolocation of IP

Biases search based on approximate geolocation of IP address.

Set bias_ip=true to enable.

box
string
Example: box=-2.096,57.15,-2.095,57.14

Filter by Bounding Box

Restrict search to a geospatial box determined by the "top-left" and "bottom-right" geolocations.

Supply 4 comma separated values ordered top_left_lon,top_left_lat,bottom_right_lon,bottom_right_lat. The top-left longitude must be less than the bottom-right longitude, and the top-left latitude greater than the bottom-right latitude. A box which fails either check is ignored.

Only one geospatial box can be provided.

postal_code
string
Example: postal_code=94102-1234

Filter by postal code

Restrict results to addresses with a matching full postal code. Case, spaces and hyphens are ignored. For US addresses the full postal code is the nine digit ZIP+4 (941021234); filter on postal_code_3 for a five digit ZIP. For UK addresses use postcode.

postal_code_2
string
Example: postal_code_2=941

Filter by postal code prefix

Restrict results to addresses whose postal code starts with the given segment. For US addresses this is the three digit ZIP prefix (sectional center), e.g. 941 for San Francisco.

postal_code_3
string
Example: postal_code_3=94102

Filter by short postal code

Restrict results to addresses with a matching short postal code. For US addresses this is the five digit ZIP code.

city
string
Example: city=San Francisco

Filter by city

Restrict results to addresses in the named city, town or locality. Case, spaces and accents are ignored, so San Francisco and sanfrancisco match the same addresses. For UK addresses use post_town.

state
string
Example: state=California

Filter by state

Restrict results to addresses in the named state, province or region, e.g. California. Case and spaces are ignored.

state_code
string
Example: state_code=CA

Filter by state code

Restrict results to addresses with a matching state or region code, e.g. the two letter USPS state abbreviation CA. Case is ignored.

bias_postal_code
string
Example: bias_postal_code=94102-1234

Bias by postal code

Boost addresses with a matching full postal code (nine digit ZIP+4 for US addresses). Unmatched addresses still appear, ranked lower.

bias_postal_code_2
string
Example: bias_postal_code_2=941

Bias by postal code prefix

Boost addresses whose postal code starts with the given segment (three digit ZIP prefix for US addresses).

bias_postal_code_3
string
Example: bias_postal_code_3=94102

Bias by short postal code

Boost addresses with a matching short postal code (five digit ZIP for US addresses).

bias_city
string
Example: bias_city=San Francisco

Bias by city

Boost addresses in the named city, town or locality. Case, spaces and accents are ignored. For UK addresses use bias_posttown.

bias_state
string
Example: bias_state=California

Bias by state

Boost addresses in the named state, province or region.

bias_state_code
string
Example: bias_state_code=CA

Bias by state code

Boost addresses with a matching state or region code, e.g. CA.

is_pobox
string
Enum: "true" "false"
Example: is_pobox=true

Filter by PO Box

true restricts results to PO Box addresses; false excludes them. For US addresses this is derived from the USPS record type (P).

is_business
string
Enum: "true" "false"
Example: is_business=true

Filter by business address

true restricts results to business addresses; false excludes them. For US addresses this is derived from the USPS record type (F, a firm record).

Responses

Request samples 

https://api.addresszen.com/v1/autocomplete/addresses?api_key=ak_test&query=1600 Pennsylvania

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Retrieve Address

Returns the full address for an autocomplete suggestion id.

This is the charged step of address autocomplete. A successful retrieval decrements your lookup balance. An id which resolves to no address returns 404.

Every address comes back in one US-shaped format, whatever country or dataset it came from: up to two address lines and US field names such as zip_code, state and city.

Authorizations:
ApiKey
path Parameters
address
required
string
Example: usps_V118834572|310||3191

ID of address suggestion

ID of address suggestion provided by the API to fully retrieve.

query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

licensee
string
Example: licensee=sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

filter
string
Example: filter=line_1,line_2,line_3

Restrict Result Fields

Comma separated whitelist of address elements to return.

E.g. filter=line_1,line_2,line_3 returns only the line_1, line_2 and line_3 address elements in your response.

tags
string
Example: tags=foo,bar

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

Responses

Request samples 

https://api.addresszen.com/v1/autocomplete/addresses/usps_V118834572|310||3191/usa?api_key=ak_test

Response samples

Content type
application/json
{
  • "code": 2000,
  • "message": "Success",
  • "result": {
    }
}

Find Place

Returns place suggestions for a query, ranked by relevance. Places cover countries, administrative areas, capitals and other administrative seats.

Implementing Place Autocomplete

Retrieving a full place takes two requests:

  1. Fetch suggestions from /places
  2. Fetch the place using the id on a suggestion

A query returns at most 10 suggestions. An empty query returns an empty result set. Show users the descriptive_name. The API drops suggestions that share one, so each name in a response identifies a single place.

Rate Limiting and Cost

The rate limit is 3,000 requests per 5 minutes.

/places does not decrement your lookup balance, but resolving a suggestion to a full place does. We rate limit and then suspend integrations that repeatedly call /places without resolving.

Authorizations:
ApiKey
query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

query
string

Specifies the place to query. Can be shortened to q=

country_iso
string
Example: country_iso=GBR

Filter by Country

Filter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard.

Filter by multiple countries with a comma separated list. E.g. GBR,IRL

bias_country_iso
string
Example: bias_country_iso=GBR

Bias by Country Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. Bias by multiple countries with a comma separated list. E.g. GBR,IRL

bias_lonlat
string
Example: bias_lonlat=-2.095,57.15,100

Bias by Geolocation

Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is 50000. Uses the format bias_lonlat=[longitude],[latitude],[radius in meters]. Only one geospatial bias may be provided.

bias_ip
string
Value: "true"

Bias by Geolocation of IP

Biases search based on approximate geolocation of IP address.

Set bias_ip=true to enable.

Responses

Request samples 

https://api.addresszen.com/v1/places?api_key=ak_test&query=london

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Resolve Place

Returns the full place for a place ID taken from a /places suggestion.

On top of the fields carried by the suggestion, the response adds coordinates, language and the underlying dataset record.

Each request decrements your lookup balance. An unknown ID returns 404.

Authorizations:
ApiKey
path Parameters
place
required
string

ID of place suggestion

query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

tags
string
Example: tags=foo,bar

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

Responses

Request samples 

https://api.addresszen.com/v1/places/geonames_5353?api_key=ak_test

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Keys

Monitor and manage API Keys

Availability

Returns public information on an API Key: whether it can be used right now (available), the search contexts the key is licensed for (contexts) and the context that best matches the caller's IP address (context).

The endpoint accepts API Keys (beginning ak_) and sub-licensed keys (beginning sl_), and needs no Management Key.

A key that exists but cannot be used, because it has no lookups left or has breached a limit, returns 200 with "available": false. An unknown or malformed key returns an error.

Supply a valid Management Key and the endpoint returns the key's private details instead, as GET /keys/{key}/details does. A Management Key that does not own the key is rejected.

path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "Success",
  • "code": 2000
}

Details

Returns private data on a key: remaining lookups, licensed datasets, usage limits, notification settings and the search contexts the key can serve.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/details?user_token=uk_secret

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Update Details

Updates a key's settings and returns its private details. Only the fields you send change. A key on an unlimited plan ignores changes to datasets, daily_limit and monthly_limit. Datasets set by your plan cannot be changed here: sending one with a different value returns a 400.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Request Body schema: application/json
required
name
string <= 32 characters ^(\w|\s){0,32}$

A name for the key

object (Daily Rate Limit)
object (Monthly Rate Limit)
object (API Key Individual Limit)
allowed_urls
Array of strings[ items <= 256 characters ^[^\s]+$ ]

A list of allowed URLs. An empty list disables the check. Up to 10 allowed.

A request is allowed when its Origin or Referer header matches an entry. Use one of these formats:

  • https://www.example.com allows one site. Scheme and host must match
  • *.example.com allows the domain and all its subdomains

See Allowed URLs.

redact_days
integer [ 0 .. 1095 ]
Default: 28

Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage

object (API Key Notifications)
ip_forwarding
boolean
Default: false

Accept IP addresses forwarded in the AZ-Source-IP header

object (API Key Dataset Availability)

Datasets you can switch on or off for this key. Datasets set by your plan (paf, mr, nyb, ecad, ecaf) cannot be changed here: sending one with a different value returns a 400.

Responses

Request samples

Content type
application/json
{
  • "name": "My API Key",
  • "daily_limit": {
    },
  • "monthly_limit": {
    },
  • "individual_limit": {
    },
  • "allowed_urls": [
    ],
  • "redact_days": 28,
  • "notifications": {
    },
  • "ip_forwarding": false,
  • "datasets": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Usage Stats

Reports the number of lookups a key consumed over a date range, as a total and a daily breakdown.

The range defaults to the last 21 days. start and end take UNIX timestamps in milliseconds, and end defaults to the current time. The maximum range is 90 days.

Query at most three tags at once.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

start
integer <int64> >= 0
Example: start=1418556452651

Start Timestamp

A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556452651

end
integer <int64> >= 0
Example: end=1418556492651

End Timestamp

An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556477882

tags
string
Example: tags=foo,bar

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

licensee
string
Example: licensee=sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/usage?user_token=uk_secret

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Logs (CSV)

Returns a CSV of the charged lookups made on a key, one row per request.

Requires the account Management Key. The maximum interval is 90 days. Without a start or end date the interval is the last 21 days.

The response is text/csv and downloads as an attachment. A non-200 response reverts to JSON, with the error code and message in the body.

CSV format

The CSV has no header row. Columns, in order:

  1. Timestamp (ISO 8601)
  2. IP address the request was received from
  3. Search term
  4. URL the request originated from
  5. Lookup type
  6. Tags
  7. Lookups consumed
  8. Licensee name (sublicensing keys only)
  9. Source IP address

The source IP column carries the address forwarded in the AZ-Source-IP header. We record it only for keys with IP address forwarding enabled, and only when the header holds a valid IP address. It is empty otherwise.

Data redaction

We redact personally identifiable data (PII) in your usage log weekly, covering the IP, source IP, search term and URL columns.

The default retention is 28 days. Change the period from your dashboard. Set it to 0 days to stop collecting PII altogether.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

start
integer <int64> >= 0
Example: start=1418556452651

Start Timestamp

A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556452651

end
integer <int64> >= 0
Example: end=1418556492651

End Timestamp

An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556477882

licensee
string
Example: licensee=sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/lookups?user_token=uk_secret

Response samples

Content type
text/csv
2015-02-21T16:05:22.991Z,82.85.128.18,SW12AA,https://www.example.com/,Postcode Lookup,,1,,
2015-02-21T16:05:38.298Z,82.85.128.18,10 Downing Street London,https://www.example.com/,Address Lookup,CRM,1,,
2015-02-21T16:06:49.227Z,82.85.128.18,OX44PP,https://www.example.com/,Postcode Lookup,"Website,Live",1,,203.0.113.44
2015-02-21T16:07:02.706Z,82.85.128.18,PL9 9HE,https://www.example.com/,Postcode Lookup,,2,Acme Ltd,203.0.113.44

Licensees

The Licensee resource represents an alternate legal End User of our data who may not be the same entity as the owners of the account.

Licensees underpin our sublicensing platform, which lets you license multiple external organizations or individuals to access data under one account.

Sublicensing suits platform vendors who serve multiple clients, each with their own users.

List

Returns a key's licensees, oldest first, up to 100 per request. The list omits canceled licensees. The key must be enabled for sub-licensing.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
starting_after
integer <int32>

ID of the licensee after which to list results

user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

limit
integer <int32> [ 1 .. 100 ]
Default: 10
Example: limit=5

Limit

Specifies the maximum number of records to retrieve.

By default the limit is 10. Requesting a larger result set adds latency.

query
string

Filter results by licensee name. Can be shortened to q=

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/licensees?user_token=uk_secret

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "Success",
  • "code": 2000
}

Create

Creates a licensee on a key and returns it with its generated sl_ key. The key must be enabled for sub-licensing.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Request Body schema: application/json
required
name
string

Licensee individual or organisation name

address
string

Licensee's first, second and third line address as well as post town concatenated by commas

postcode
string

Licensee's postcode

whitelist
Array of strings

A list of allowed URLs. An empty list disables the check.

A request is allowed when its Origin or Referer header matches an entry. Use one of these formats:

  • https://www.example.com allows one site. Scheme and host must match
  • *.example.com allows the domain and all its subdomains
object

Responses

Request samples

Content type
application/json
{
  • "name": "Qwerty Widgets Limited",
  • "address": "12 High Street, Manchester",
  • "postcode": "BR8 7RE",
  • "whitelist": [],
  • "daily": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Retrieve

Returns a licensee by its sl_ key. A canceled or unknown licensee returns 404.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

licensee
required
string
Example: sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Cancel

Cancels a licensee. Its key stops working and it drops out of the licensee list. Contact us to reverse it.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

licensee
required
string
Example: sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Responses

Request samples 

curl -X DELETE 'https://api.addresszen.com/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94?user_token=uk_secret'

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Update

Updates a licensee's address, postcode, allowed URLs and daily limit. Returns the updated licensee. The name is fixed at creation.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

licensee
required
string
Example: sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Request Body schema: application/json
required
name
string

Licensee individual or organisation name

address
string

Licensee's first, second and third line address as well as post town concatenated by commas

postcode
string

Licensee's postcode

whitelist
Array of strings

A list of allowed URLs. An empty list disables the check.

A request is allowed when its Origin or Referer header matches an entry. Use one of these formats:

  • https://www.example.com allows one site. Scheme and host must match
  • *.example.com allows the domain and all its subdomains
object

Responses

Request samples

Content type
application/json
{
  • "name": "Qwerty Widgets Limited",
  • "address": "12 High Street, Manchester",
  • "postcode": "BR8 7RE",
  • "whitelist": [],
  • "daily": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Regenerate Key

Regenerates a licensee's key and returns the licensee with the new key. The previous key stops working immediately, so update any integration that uses it.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

licensee
required
string
Example: sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Licensee Key

Uniquely identifies a licensee.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Responses

Request samples 

curl -X POST 'https://api.addresszen.com/v1/keys/ak_test/licensees/sl_ijoiqsxeQgXW2gkiE0X94/regenerate-key?user_token=uk_secret'

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Configs

The Config resource assigns serialized configuration data to an API Key. Retrieve the payload later to configure your integration at runtime.

Useful if you need to configure your integration remotely rather than editing code in situ.

List

Returns every configuration stored against a key, oldest first.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/configs?user_token=uk_secret

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "Success",
  • "code": 2000
}

Create

Creates a named configuration on a key and returns it.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Request Body schema: application/json
required
name
required
string [ 1 .. 32 ] characters

A unique name to identify the configuration payload

payload
required
string [ 0 .. 65536 ] characters

A serialized payload of up to 65536 characters

Responses

Request samples

Content type
application/json
{
  • "name": "woocommerce",
  • "payload": "{\n \"removeOrganisation\": false\n}\n"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Retrieve

Returns a configuration by name. This request needs no user_token, so a browser integration can read its own configuration at runtime.

path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

config
required
string
Example: checkout-form

Configuration Name

User-provided configuration object name.

Responses

Request samples 

https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Delete

Permanently deletes a configuration object.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

config
required
string
Example: checkout-form

Configuration Name

User-provided configuration object name.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Responses

Request samples 

curl -X DELETE 'https://api.addresszen.com/v1/keys/ak_test/configs/woocommerce?user_token=uk_secret'

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Update

Replaces a configuration's payload and returns the updated configuration. The name is fixed at creation.

Authorizations:
ManagementKey
path Parameters
key
required
string
Example: ak_test

API Key

The API Key. Begins ak_.

config
required
string
Example: checkout-form

Configuration Name

User-provided configuration object name.

query Parameters
user_token
string
Example: user_token=uk_B59ScW1p1HHouf1VqclEPZUx

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_. Prefer sending it in the Authorization header as Bearer uk_... instead of this query parameter. The Authorization: user_token="uk_..." header also works.

Request Body schema: application/json
required
payload
string [ 0 .. 65536 ] characters

A serialized payload of up to 65536 characters

Responses

Request samples

Content type
application/json
{
  • "payload": "{\n \"removeOrganisation\": false\n}\n"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Emails

Email Validation

Validates an email address and reports whether it is deliverable.

Requires an API Key licensed for email validation. A query over 320 characters is rejected.

A validated address decrements your lookup balance. An address the API cannot check returns unknown and costs no lookup. An address whose domain does not resolve, or publishes no MX records, returns not_deliverable and also costs no lookup. Only those two domain failures populate suggestions. Every other response returns an empty list.

Authorizations:
ApiKey
query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

query
required
string

Specifies the email address to validate

tags
string
Example: tags=foo,bar

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

Responses

Request samples 

https://api.addresszen.com/v1/emails?api_key=ak_test&query=foo@domain.com

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Phone Numbers

Phone Number Validation

Validates a phone number and returns its country, its national and international formats, and the network it was originally assigned to.

Requires an API Key licensed for phone validation.

Every query decrements your lookup balance, including a number that fails to parse and a number reported as invalid.

Authorizations:
ApiKey
query Parameters
api_key
string
Example: api_key=ak_test

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard.

query
required
string

Specifies the phone number to validate. Phone number must include a country code in an acceptable format. For instance, UK phone numbers should be prefixed with +44, 44 or 0044.

current_carrier
string
Value: "true"

When set to true, the API retrieves and populates the current network of the phone number.

This operation can be slow, depending on the network and local conditions.

tags
string
Example: tags=foo,bar

Tags

A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

Responses

Request samples 

https://api.addresszen.com/v1/phone_numbers?api_key=ak_test&query=02071128019

Response samples

Content type
application/json
{
  • "result": {
    },
  • "code": 2000,
  • "message": "Success"
}

Address

The single address format returned by every address endpoint, for every dataset, US and non-US alike. dataset identifies the source; native carries the raw dataset record.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string (Dataset)
Enum: "paf" "pafw" "pafa" "mr" "nyb" "usps" "ecaf" "ecad" "ab" "abp" "herewe" "heret" "heresa" "hereo" "herena" "heremeas" "heremea" "herem" "herei" "herehk" "hereee" "hereap" "gnaf" "kadaster" "kartverket" "sdfi" "cannar" "fodbosa" "mois" "upujp" "bev" "ban" "swt"

Indicates the provenance of an address.

country_iso
required
string (ISO Country Code (3))
Enum: "GBR" "IMN" "JEY" "GGY" "USA" "PRI" "GUM" "IRL" "VAT" "FRA" "GRL" "NLD" "LUX" "AUT" "GIB" "LIE" "FIN" "ISL" "CHE" "PRT" "BEL" "MCO" "ITA" "FRO" "NOR" "DNK" "SMR" "MLT" "AND" "SWE" "DEU" "ESP" "SJM" "BRN" "IDN" "KHM" "MMR" "MYS" "PHL" "SGP" "THA" "TLS" "VNM" "ALB" "ARM" "AZE" "BGR" "BIH" "BLR" "CYP" "CZE" "EST" "GEO" "GRC" "HRV" "HUN" "KAZ" "KGZ" "LTU" "LVA" "MDA" "MKD" "MNE" "POL" "ROU" "RUS" "SRB" "SVK" "SVN" "TUR" "UKR" "UZB" "XKX" "HKG" "BGD" "IND" "LKA" "MAC" "AGO" "ARE" "BFA" "BHR" "BWA" "CMR" "EGY" "GHA" "ISR" "JOR" "KEN" "KWT" "LBN" "LSO" "MAR" "MOZ" "MUS" "MYT" "NAM" "NGA" "OMN" "QAT" "REU" "SAU" "SEN" "SWZ" "TUN" "ZAF" "ZMB" "ZWE" "BHS" "BLZ" "BMU" "CAN" "CRI" "CYM" "DOM" "GTM" "HND" "HTI" "JAM" "MEX" "NIC" "PAN" "SLV" "VGB" "AUS" "CCK" "CXR" "FJI" "NCL" "NFK" "NZL" "PYF" "TON" "VUT" "ABW" "ARG" "BLM" "BOL" "BRA" "BRB" "CHL" "COL" "CUW" "DMA" "ECU" "GLP" "GUF" "GUY" "MAF" "MTQ" "PER" "PRY" "SUR" "TTO" "URY" "VEN" "TWN" "CHN" "JPN" "KOR" "LAO" "MNG" "PNG" "PRK" "SLB" "TJK" "TKM" "BTN" "IOT" "MDV" "NPL" "PAK" "AFG" "BDI" "BEN" "CAF" "CIV" "COD" "COG" "COM" "CPV" "DJI" "DZA" "ERI" "ESH" "ETH" "GAB" "GIN" "GMB" "GNB" "GNQ" "IRN" "IRQ" "LBR" "LBY" "MDG" "MLI" "MRT" "MWI" "NER" "RWA" "SHN" "SLE" "SOM" "SSD" "STP" "SYC" "TCD" "TGO" "TZA" "UGA" "SDN" "SYR" "YEM" "CUB" "SPM" "TCA" "COK" "KIR" "NIU" "NRU" "PCN" "TKL" "TUV" "WLF" "WSM" "AIA" "ATG" "BES" "FLK" "GRD" "KNA" "LCA" "MSR" "SGS" "SXM" "VCT" "ASM" "FSM" "MHL" "MNP" "PLW" "VIR"

3 letter country code (ISO 3166-1)

country_iso_2
required
string (ISO Country Code (2))
Enum: "GB" "IM" "JE" "GG" "US" "PR" "GU" "IE" "VA" "FR" "GL" "NL" "LU" "AT" "GI" "LI" "FI" "IS" "CH" "PT" "BE" "MC" "IT" "FO" "NO" "DK" "SM" "MT" "AD" "SE" "DE" "ES" "SJ" "BS" "BZ" "BM" "CA" "CR" "KY" "DO" "GT" "HN" "HT" "JM" "MX" "NI" "PA" "SV" "VG" "AU" "CC" "CX" "FJ" "NC" "NF" "NZ" "PF" "TO" "VU" "AW" "AR" "BL" "BO" "BR" "BB" "CL" "CO" "CW" "DM" "EC" "GP" "GD" "GF" "GY" "MF" "MQ" "PE" "PY" "SR" "TT" "UY" "VE" "TW" "BN" "ID" "KH" "MM" "MY" "PH" "SG" "TH" "TL" "VN" "AL" "AM" "AZ" "BG" "BA" "BY" "CY" "CZ" "EE" "GE" "GR" "HR" "HU" "KZ" "KG" "XK" "LT" "LV" "MD" "MK" "ME" "PL" "RO" "RU" "RS" "SK" "SI" "TR" "UA" "UZ" "HK" "BD" "IN" "LK" "MO" "AO" "AE" "BF" "BH" "BW" "CM" "EG" "GH" "IL" "JO" "KE" "KW" "LB" "LS" "MA" "MZ" "MU" "YT" "NA" "NG" "OM" "QA" "RE" "SA" "SN" "SZ" "TN" "ZA" "ZM" "ZW" "CN" "JP" "KR" "LA" "MN" "PG" "KP" "SB" "TJ" "TM" "BT" "IO" "MV" "NP" "PK" "AF" "BI" "BJ" "CF" "CI" "CD" "CG" "KM" "CV" "DJ" "DZ" "ER" "EH" "ET" "GA" "GN" "GM" "GW" "GQ" "IR" "IQ" "LR" "LY" "MG" "ML" "MR" "MW" "NE" "RW" "SH" "SL" "SO" "SS" "ST" "SC" "TD" "TG" "TZ" "UG" "SD" "SY" "YE" "CU" "PM" "TC" "CK" "KI" "NU" "NR" "PN" "TK" "TV" "WF" "WS" "AI" "AG" "BQ" "FK" "KN" "LC" "MS" "GS" "SX" "VC" "AS" "FM" "MH" "MP" "PW" "VI"

2 letter country code (ISO 3166-1)

country
required
string (Country)
Enum: "United Kingdom" "England" "Scotland" "Wales" "Northern Ireland" "Isle of Man" "Jersey" "Guernsey" "Channel Islands" "Guam" "United States" "Puerto Rico" "Ireland" "Vatican City" "France" "Greenland" "Netherlands" "Luxembourg" "Austria" "Gibraltar" "Liechtenstein" "Finland" "Iceland" "Switzerland" "Portugal" "Belgium" "Monaco" "Italy" "Faroe Islands" "Norway" "Denmark" "San Marino" "Malta" "Andorra" "Sweden" "Germany" "Spain" "Svalbard and Jan Mayen" "Bahamas" "Belize" "Bermuda" "Canada" "Costa Rica" "Cayman Islands" "Dominican Republic" "Guatemala" "Honduras" "Haiti" "Jamaica" "Mexico" "Nicaragua" "Panama" "El Salvador" "British Virgin Islands" "Australia" "Cocos (Keeling) Islands" "Christmas Island" "Fiji" "New Caledonia" "Norfolk Island" "New Zealand" "French Polynesia" "Tonga" "Vanuatu" "Aruba" "Argentina" "Saint Barthélemy" "Bolivia" "Brazil" "Barbados" "Chile" "Colombia" "Curaçao" "Dominica" "Ecuador" "Guadeloupe" "Grenada" "French Guiana" "Guyana" "Saint Martin (French part)" "Martinique" "Peru" "Paraguay" "Suriname" "Trinidad and Tobago" "Uruguay" "Venezuela" "Taiwan" "Brunei Darussalam" "Indonesia" "Cambodia" "Myanmar" "Malaysia" "Philippines" "Singapore" "Thailand" "Timor-Leste" "Vietnam" "Albania" "Armenia" "Azerbaijan" "Bulgaria" "Bosnia and Herzegovina" "Belarus" "Cyprus" "Czech Republic" "Estonia" "Georgia" "Greece" "Croatia" "Hungary" "Kazakhstan" "Kyrgyzstan" "Kosovo" "Lithuania" "Latvia" "Moldova" "North Macedonia" "Montenegro" "Poland" "Romania" "Russia" "Serbia" "Slovakia" "Slovenia" "Turkey" "Ukraine" "Uzbekistan" "Hong Kong" "Bangladesh" "India" "Sri Lanka" "Macau" "Angola" "United Arab Emirates" "Burkina Faso" "Bahrain" "Botswana" "Cameroon" "Egypt" "Ghana" "Israel" "Jordan" "Kenya" "Kuwait" "Lebanon" "Lesotho" "Morocco" "Mozambique" "Mauritius" "Mayotte" "Namibia" "Nigeria" "Oman" "Qatar" "Réunion" "Saudi Arabia" "Senegal" "Eswatini" "Tunisia" "South Africa" "Zambia" "Zimbabwe" "China" "Japan" "South Korea" "Laos" "Mongolia" "Papua New Guinea" "North Korea" "Solomon Islands" "Tajikistan" "Turkmenistan" "Bhutan" "British Indian Ocean Territory" "Maldives" "Nepal" "Pakistan" "Afghanistan" "Burundi" "Benin" "Central African Republic" "Côte d'Ivoire" "Democratic Republic of the Congo" "Republic of the Congo" "Comoros" "Cape Verde" "Djibouti" "Algeria" "Eritrea" "Western Sahara" "Ethiopia" "Gabon" "Guinea" "Gambia" "Guinea-Bissau" "Equatorial Guinea" "Iran" "Iraq" "Liberia" "Libya" "Madagascar" "Mali" "Mauritania" "Malawi" "Niger" "Rwanda" "Saint Helena" "Sierra Leone" "Somalia" "South Sudan" "São Tomé and Príncipe" "Seychelles" "Chad" "Togo" "Tanzania" "Uganda" "Sudan" "Syria" "Yemen" "Cuba" "Saint Pierre and Miquelon" "Turks and Caicos Islands" "Cook Islands" "Kiribati" "Niue" "Nauru" "Pitcairn Islands" "Tokelau" "Tuvalu" "Wallis and Futuna" "Samoa" "Anguilla" "Antigua and Barbuda" "Bonaire, Sint Eustatius and Saba" "Falkland Islands (Malvinas)" "Saint Kitts and Nevis" "Saint Lucia" "Montserrat" "South Georgia and the South Sandwich Islands" "Sint Maarten (Dutch part)" "Saint Vincent and the Grenadines" "American Samoa" "Federated States of Micronesia" "Marshall Islands" "Northern Mariana Islands" "Palau" "United States Virgin Islands"

Full country names (ISO 3166)

language
required
string (Language)
Enum: "en" "ar" "as" "az" "be" "bg" "bn" "bs" "ca" "cs" "cy" "da" "de" "el" "es" "et" "eu" "fi" "fo" "fr" "ga" "gl" "gn" "he" "hi" "hr" "hu" "hy" "id" "is" "it" "ja" "ka" "kk" "km" "kn" "ko" "lt" "lv" "mk" "mn" "ms" "mt" "my" "nl" "no" "pl" "pt" "rm" "ro" "ru" "sk" "sl" "sq" "sr" "sv" "ta" "th" "tr" "uk" "uz" "vi" "wa" "zh"

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

primary_number
required
string (Primary Number)

Building, house, rural route, contract box or PO Box number. The numeric or alphanumeric component of an address preceding the street name.

secondary_number
required
string (Secondary Number)

Number of the subunit, apartment, suite etc.

plus_4_code
required
string (Plus 4 Code)

4-digit ZIP add-on code. USPS addresses only.

line_1
required
string (First Address Line)

The primary delivery line (usually the street address) of the address.

line_2
required
string (Second Address Line)

Secondary delivery line of the address. Typically populated if the first line is the firm or building name.

last_line
required
string (Last Line)

Final line of the address, comprising city, state or region and postal code.

zip_code
required
string (ZIP Code)

Postal code identifying the delivery area. For US addresses this is the 5-digit ZIP Code.

zip_plus_4_code
required
string (ZIP + 4 Code)

Nine-digit code that identifies a small geographic delivery area serviceable by a single carrier; appears in the last line of the address on a mail piece. USPS addresses only.

update_key_number
required
string (Update Key Number)

Key that uniquely identifies the source dataset record. For USPS this is the Update Key Number: a database segment code (V1, V2, W1, W2, X1, X2, Y1, Y2, Z1 or Z2) followed by eight alphanumeric characters. It is fixed for the life of the record and is not used in address matching.

record_type_code
required
string (Record Type Code)
Enum: "G" "H" "F" "S" "P" "R" "M" ""

An alphabetic value identifying the type of USPS record backing the address.

  • G = General delivery
  • H = High-rise
  • F = Firm
  • S = Street
  • P = PO Box
  • R = Rural route/contract
  • M = Multi-carrier
carrier_route_id
required
string (Carrier Route ID)

A 4-character ID identifying the USPS postal route for the address. The first character indicates the route type:

  • "B" indicates PO Box
  • "H" indicates highway
  • "C" indicates city
  • "G" indicates general
  • "R" indicates rural
street_pre_directional_abbreviation
required
string (Street Pre-Directional Abbreviation)

A geographic direction that precedes the street name.

street_name
required
string (Street Name)

The official name of the street as assigned by the local governing authority. Contains the street name only, without directionals (EAST, WEST, etc.) or suffixes (ST, DR, BLVD, etc.). May also contain literals such as PO BOX, GENERAL DELIVERY, USS, PSC or UNIT.

street_suffix_abbreviation
required
string (Street Suffix Abbreviation)

Standard abbreviation for the trailing designator in a street address.

street_post_directional_abbreviation
required
string (Street Post Directional Abbreviation)

A geographic direction that follows the street name.

building_or_firm_name
required
string (Building or Firm Name)

The name of a company, building, apartment complex, shopping center or other distinguishing secondary address information.

address_secondary_abbreviation
required
string (Address Secondary Abbreviation)

A descriptive code identifying the type of secondary range held in the secondary number field, e.g. apartment, suite or trailer.

base_alternate_code
required
string (Base Alternate Code)
Enum: "A" "B" ""

Code specifying whether the backing USPS record is a base (preferred) or alternate record.

Base records ("B") can represent a range of addresses or an individual address, such as a firm record. Alternate records ("A") are individual delivery points. Base records are generally preferred over alternate records.

Government deliveries are only listed on alternate records, with the appropriate government building indicator set.

lacs_status_indicator
required
string (LACS Status Indicator)
Enum: "" "L"

The Locatable Address Conversion Service (LACS) indicator marks USPS records converted to the LACS system, which lets mailers convert a rural route address to a city-style address so emergency services can locate it.

  • L = LACS address: the old (usually rural-route) address that has been converted
  • Blank = Not applicable
government_building_indicator
required
string (Government Building Indicator)
Enum: "" "A" "B" "C" "D" "E" "F" "G"

An alphabetic value identifying the type of government agency at the delivery point and/or whether a firm is the only delivery at an address.

  • A = City government building, alternates only
  • B = Federal government building, alternates only
  • C = State government building, alternates only
  • D = Firm only, base and alternates
  • E = City government building and firm only, alternates only
  • F = Federal government building and firm only, alternates only
  • G = State government building and firm only, alternates only
state_abbreviation
required
string (State Abbreviation)

Abbreviated name of the state, province or region. For US addresses this is the 2-character state, territory or armed forces designation ("AA", "AE" or "AP" for APO/FPO/DPO).

state
required
string (State)

Full name of the state, province or region.

municipality_city_state_key
required
string (Municipality City State Key)

Municipality City State Key. Currently blank.

urbanization_city_state_key
required
string (Urbanization City State Key)

An index to the USPS City State file that provides the urbanization name for this delivery range.

preferred_last_line_city_state_key
required
string (Preferred Last Line City State Key)

An index to the USPS City State product record that provides the preferred last-line name for this address range.

county
required
string (County Name)

Name of the county, parish or equivalent administrative area. Blank for APO/FPO/DPO addresses.

city
required
string (City Name)

City or town name used for mailing; appears in the last line of the address.

city_abbreviation
required
string (City State Name Abbreviation)

A standard 13-character abbreviation for a city/state name. Only used for names longer than 13 characters with a city state mailing name indicator of "Y"; blank otherwise.

preferred_city
required
string (Preferred Last Line City State Name)

The default preferred or alternate preferred last-line name for a ZIP Code.

city_state_name_facility_code
required
string (City State Name Facility Code)
Enum: "B" "C" "N" "P" "S" "U" "Y" ""

The type of locale identified in the city/state name. The facility may be a USPS facility, such as a post office, station or branch, or a non-postal place name.

  • B = Branch
  • C = Community post office (CPO)
  • N = Non-postal community name, former USPS facility, or place name
  • P = Post Office
  • S = Station
  • U = Urbanization
zip_classification_code
required
string (ZIP Classification Code)
Enum: "" "M" "P" "U"

Describes the type of ZIP area a 5-digit ZIP Code serves, e.g. a single educational institution, post office boxes only or a single address with unusually high mail volume.

  • M = Military ZIP Code
  • P = ZIP Code having only Post Office Boxes
  • U = Unique ZIP Code (ZIP assigned to a single organization)
  • Blank = Standard ZIP with many addresses assigned to it
city_state_mailing_name_indicator
required
string (City State Mailing Name Indicator)

Specifies whether the city state name can be used as the last line of an address on a mail piece.

  • Y = City/state name is a USPS-approved mailing name
  • N = City/state name is not approved for mailing purposes
carrier_route_rate_sortation
required
string (Carrier Route Rate Sortation and Merged 5-Digit Indicator)

Identifies where automation Carrier Route rates are available and where the commingling of automation and non-automation mail, including Enhanced Carrier Routes and 5-digit presort, on the same pallet or in the same container is allowed.

required
Finance Number (string) or Finance Number (number) (Finance Number)

A code assigned to USPS facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data.

required
Congressional District Number (string) or Congressional District Number (number) (Congressional District Number)

A standard value identifying a geographic area within the United States served by a member of the U.S. House of Representatives. Blank for APO/FPO/DPO addresses. If there is only one member of Congress within a state, the code will be "AL" (at large).

required
County Number (string) or County Number (number) (County Number)

The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state. In Alaska it identifies a region within the state. Blank for APO/FPO/DPO addresses whose record type is "S", "H" or "F".

Royal Mail Postcode Address File Address (object) or Multiple Residence Address (object) or Not Yet Built Address (object) or PAF Alias Address (object) or Welsh PAF Address (object) or AddressBase Core Address (object) or AddressBase Premium Address (object) or USPS Address (object) or Ireland ECAD Address (object) or Ireland ECAF Address (object) or HERE Address (object) or Australia G-NAF Address (object) or Netherlands Kadaster Address (object) or Norway Kartverket Address (object) or Denmark SDFI Address (object) or Canada NAR Address (object) or Belgium FOD BOSA Address (object) or South Korea MOIS Address (object) or Japan UPU Address (object) or Austria BEV Address (object) or France BAN Address (object) or Switzerland and Liechtenstein Address (object) (Native Record)

The raw dataset record backing an address, exactly as the dataset supplies it. One schema per dataset; dataset on the record says which.

{
  • "id": "usps_V124884241|1040||0001",
  • "dataset": "usps",
  • "country": "United States",
  • "country_iso": "USA",
  • "country_iso_2": "US",
  • "language": "en",
  • "primary_number": "1040",
  • "secondary_number": "",
  • "plus_4_code": "0001",
  • "line_1": "1040 Waverly Ave",
  • "line_2": "",
  • "last_line": "Holtsville NY 00501-0001",
  • "zip_code": "00501",
  • "zip_plus_4_code": "00501-0001",
  • "update_key_number": "V124884241",
  • "record_type_code": "S",
  • "carrier_route_id": "C000",
  • "street_pre_directional_abbreviation": "",
  • "street_name": "Waverly",
  • "street_suffix_abbreviation": "Ave",
  • "street_post_directional_abbreviation": "",
  • "building_or_firm_name": "",
  • "address_secondary_abbreviation": "",
  • "base_alternate_code": "B",
  • "lacs_status_indicator": "",
  • "government_building_indicator": "",
  • "state_abbreviation": "NY",
  • "state": "New York",
  • "municipality_city_state_key": "",
  • "urbanization_city_state_key": "",
  • "preferred_last_line_city_state_key": "V13916",
  • "county": "Suffolk",
  • "city": "Holtsville",
  • "city_abbreviation": "",
  • "preferred_city": "Holtsville",
  • "city_state_name_facility_code": "P",
  • "zip_classification_code": "U",
  • "city_state_mailing_name_indicator": "Y",
  • "carrier_route_rate_sortation": "C",
  • "finance_number": 353910,
  • "congressional_district_number": 2,
  • "county_number": 103
}

Address Suggestion

Address Suggestions are simple, human readable representations of an address. This format is sufficient for a user to determine an address match in an address autocomplete interface. A second request must be made to the API to gather fully validated address.

See our Address Search APIs for more information on address autocompletion.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

suggestion
required
string

Address Suggestion to be displayed to the user

required
object (URLs)

Always an empty object ({}). Retrieve the full address with id

{
  • "id": "usps_V210079628|10||3797",
  • "suggestion": "10 Downing St, Montpelier, VT, 05602",
  • "urls": { }
}

USPS Zip+4

Raw USPS Zip+4 record.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string (USA Dataset)
Value: "usps"

Identifies the address as sourced from USPS

country
required
string (Country)
Enum: "American Samoa" "Federated States of Micronesia" "Guam" "Marshall Islands" "Northern Mariana Islands" "Palau" "Puerto Rico" "United States" "United States Virgin Islands"

Full country names (ISO 3166)

country_iso
required
string (ISO Country Code (3))
Enum: "ASM" "FSM" "GUM" "MHL" "MNP" "PLW" "PRI" "USA" "VIR"

3 letter country code (ISO 3166-1)

country_iso_2
required
string (ISO Country Code (2))
Enum: "AS" "FM" "GU" "MH" "MP" "PR" "PW" "US" "VI"

2 letter country code (ISO 3166-1)

language
required
string (Language)
Value: "en"

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

primary_number
required
string (Primary Number)

A house, rural route, contract box, or Post Office Box number. The numeric or alphanumeric component of an address preceding the street name. Often referred to as house number.

secondary_number
required
string (Secondary Number)

Number of the sub unit, apartment, suite etc

plus_4_code
required
string (Plus 4 Code)

4 digit ZIP add-on code.

line_1
required
string (First Address Line)

The primary delivery line (usually the street address) of the address.

line_2
required
string (Second Address Line)

Secondary delivery line of the address. Typically populated if the first line is the firm or building name.

last_line
required
string (Last Line)

Last line of the address comprising of city, state, zip code and zip+4

zip_code
required
string (ZIP Code) <= 5 characters

A 5-digit code that identifies a specific geographic delivery area. ZIP Codes can represent an area within a state, or a single building or company that has a very high mail volume.

zip_plus_4_code
required
string (ZIP + 4 Code) <= 10 characters

Nine-digit code that identifies a small geographic delivery area that is serviceable by a single carrier; appears in the last line of the address on a mail piece.

update_key_number
required
string (Update Key Number) <= 10 characters

Field that contains a number that uniquely identifies a record; used to identify the base record to which an add or delete transaction is being directed. The Update Key Number field is used only when applying transactions to the base file; it is not used in address matching and remains fixed for the life of the record. The field is alphanumeric and consists of the database segment code (V1, V2, W1, W2, X1, X2, Y1, Y2, Z1, or Z2) and eight characters containing an alphanumeric value ranging from 00000001 to AAAAAAAA.

record_type_code
required
string (Record Type Code) <= 1 characters
Enum: "G" "H" "F" "S" "P" "R" "M" ""

An alphabetic value that identifies the type of data in the record. - G = General delivery (5-Digit ZIP, ZIP + 4, and Carrier Route products) - H = High-rise (ZIP + 4 only) - F = Firm (ZIP + 4 only) - S = Street (5-Digit ZIP, ZIP + 4, and Carrier Route products) - P = PO Box (5-Digit ZIP, ZIP + 4, and Carrier Route products) - R = Rural route/contract (5-Digit ZIP, ZIP + 4, and Carrier Route products) - M = Multi-carrier (Carrier Route product only)

carrier_route_id
required
string (Carrier Route ID) <= 4 characters

A 4 character ID identifying the postal route for the address. The first character indicates the route type. Specifically:

  • "B" indicates PO Box
  • "H" indicates highway
  • "C" indicates city
  • "G" indicates general
  • "R" indicates rural
street_pre_directional_abbreviation
required
string (Street Pre-Directional Abbreviation) <= 2 characters

A geographic direction that precedes the street name.

street_name
required
string (Street Name) <= 28 characters

The official name of a street as assigned by a local governing authority. The Street Name field contains only the street name and does not include directionals (EAST, WEST, etc.) or suffixes (ST, DR, BLVD, etc.). This element may also contain literals, such as PO BOX, GENERAL DELIVERY, USS, PSC, or UNIT.

street_suffix_abbreviation
required
string (Street Suffix Abbreviation) <= 4 characters

Code that is the standard USPS abbreviation for the trailing designator in a street address.

street_post_directional_abbreviation
required
string (Street Post Directional Abbreviation) <= 2 characters

A geographic direction that follows the street name.

building_or_firm_name
required
string (Building or Firm Name) <= 40 characters

The name of a company, building, apartment complex, shopping center, or other distinguishing secondary address information. This field is normally used with firm and highrise records but may also contain literals such as “Postmaster” or “United States Postal Service.”

address_secondary_abbreviation
required
string (Address Secondary Abbreviation) <= 4 characters

A descriptive code used to identify the type of address secondary range information in the Address Secondary Range field. This code may be useful in address matching, e.g., the secondary address numbers may indicate apartment, suite, or trailer numbers.

base_alternate_code
required
string (Base Alternate Code) <= 1 characters
Enum: "A" "B" ""

Code that specifies whether a record is a base (preferred) or alternate record. Base records (represented as "B") can represent a range of addresses or an individual address, such as a firm record, while alternate records (represented as "A") are individual delivery points. Base records are generally preferred over alternate records. Government deliveries will only be listed on alternate records with the appropriate government building indicator (federal, state, or city) set.

lacs_status_indicator
required
string (LACS Status Indicator) <= 1 characters
Enum: "" "L"

The Locatable Address Conversion Service (LACS) indicator describes records that have been converted to the LACS system (a product/system in a different USPS® product line that allows mailers to identify and convert a rural route address to a city-style address). Rural route and some city addresses are being modified to city-style addresses so that emergency services (e.g., ambulances, police) can find these addresses more efficiently.

  • L = LACS address: The old (usually rural-route) address that has been converted for the LACS system.
  • Blank = Not applicable
government_building_indicator
required
string (Government Building Indicator) <= 1 characters
Enum: "" "A" "B" "C" "D" "E" "F" "G"

An alphabetic value that identifies the type of government agency at the delivery point and/or whether a firm is the only delivery at an address. For this purpose, "address" is defined as the complete delivery line (e.g., complete street address and, if included as part of the firm record, the secondary abbreviation and/or address secondary number).

  • A = City government building - alternates only
  • B = Federal government building - alternates only
  • C = State government building - alternates only
  • D = Firm only - base and alternates
  • E = City government building and firm only - alternates only
  • F = Federal government building and firm only - alternates only
  • G = State government building and firm only - alternates only
state_abbreviation
required
string (State Abbreviation) <= 2 characters

A 2-character abbreviation for the name of a state, U.S. territory, or armed forces ZIP Code designation. If APO/FPO/DPO, then the state abbreviation will be “AA,” “AE,” or “AP.”

state
required
string (State)

Full name of a state, U.S. territory, or armed forces ZIP Code designation.

municipality_city_state_key
required
string (Municipality City State Key) <= 6 characters

Municipality City State Key. Currently blank.

urbanization_city_state_key
required
string (Urbanization City State Key) <= 6 characters

An index to the City State file that provides the urbanization name for this delivery range.

preferred_last_line_city_state_key
required
string (Preferred Last Line City State Key) <= 6 characters

In the Carrier Route, Five-Digit ZIP Code, Delivery Statistics, and ZIP + 4 products, an index to the City State product record that provides the preferred last-line name for this address range. In the City State product, the preferred last line city/state key contains the key value of a City State product record that has the default preferred or alternate preferred last-line key for a given ZIP Code.

county
required
string (County Name)

The name of the county or parish in which the 5-digit ZIP Code resides. If APO/FPO/DPO, then the county name will be blank.

city
required
string (City Name)

A valid city name for mailing purposes; appears in the last line of an address on a mail piece.

city_abbreviation
required
string (City State Name Abbreviation)

A standard 13-character abbreviation for a city/state name. This field is only used for names that are greater than 13 characters in length and have a city/state mailing name indicator of "Y." If the field is longer than 13 characters and the city/state mailing name indicator is "N," the field will be blank.

preferred_city
required
string (Preferred Last Line City State Name)

Field that contains the default preferred or alternate preferred last-line name for a ZIP Code.

city_state_name_facility_code
required
string (City State Name Facility Code) <= 1 characters
Enum: "B" "C" "N" "P" "S" "U" "Y" ""

The type of locale identified in the city/state name. The facility may be a USPS facility, such as a post office, station, or branch, or it may be a non-postal place name. City/state name facility codes include the following:

  • B = Branch
  • C = Community post office (CPO)
  • N = Non-postal community name, former USPS facility, or place name
  • P = Post Office
  • S = Station
  • U = Urbanization
zip_classification_code
required
string (ZIP Classification Code) <= 1 characters
Enum: "" "M" "P" "U"

A field that describes the type of ZIP area that a 5-digit ZIP Code serves, e.g., a single educational institution, post office boxes only, or a single address that has unusually high mail volume or many different addresses. - M = Military ZIP Code - P = ZIP Code having only Post Office Boxes - U = Unique ZIP Code (ZIP assigned to a single organization) - Blank = Standard ZIP with many addresses assigned to it

city_state_mailing_name_indicator
required
string (City State Mailing Name Indicator) <= 1 characters

Specifies whether or not the city state name can be used as a last line of address on a mail piece.

  • "Y = City/state name is a USPS-approved mailing name."
  • "N = City/state name is not approved for mailing purposes."
carrier_route_rate_sortation
required
string (Carrier Route Rate Sortation and Merged 5-Digit Indicator) <= 1 characters

Identifies where automation Carrier Route rates are available and where the commingling of automation and non-automation mail, including Enhanced Carrier Routes and 5-digit presort, on the same pallet or in the same container is allowed.

required
Finance Number (string) or Finance Number (number) (Finance Number)

A code assigned to Postal Service facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data.

required
Congressional District Number (string) or Congressional District Number (number) (Congressional District Number)

A standard value identifying a geographic area within the United States served by a member of the U.S. House of Representatives. If Army/Air Force (APO), Fleet Post Office (FPO), or Diplomatic/Defense Post Office (DPO), this field will be blank. If there is only one member of Congress within a state, the code will be "AL" (at large).

required
County Number (string) or County Number (number) (County Number)

The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state. In Alaska, it identifies a region within the state. If APO/FPO/DPO, and the record type is “S,” “H,” or “F,” the county number will be blank.

{
  • "id": "usps_V124884241|1040||0001",
  • "dataset": "usps",
  • "country": "United States",
  • "country_iso": "USA",
  • "country_iso_2": "US",
  • "language": "en",
  • "primary_number": "1040",
  • "secondary_number": "",
  • "plus_4_code": "0001",
  • "line_1": "1040 Waverly Ave",
  • "line_2": "",
  • "last_line": "Holtsville NY 00501-0001",
  • "zip_code": "00501",
  • "zip_plus_4_code": "00501-0001",
  • "update_key_number": "V124884241",
  • "record_type_code": "S",
  • "carrier_route_id": "C000",
  • "street_pre_directional_abbreviation": "",
  • "street_name": "Waverly",
  • "street_suffix_abbreviation": "Ave",
  • "street_post_directional_abbreviation": "",
  • "building_or_firm_name": "",
  • "address_secondary_abbreviation": "",
  • "base_alternate_code": "B",
  • "lacs_status_indicator": "",
  • "government_building_indicator": "",
  • "state_abbreviation": "NY",
  • "state": "New York",
  • "municipality_city_state_key": "",
  • "urbanization_city_state_key": "",
  • "preferred_last_line_city_state_key": "V13916",
  • "county": "Suffolk",
  • "city": "Holtsville",
  • "city_abbreviation": "",
  • "preferred_city": "Holtsville",
  • "city_state_name_facility_code": "P",
  • "zip_classification_code": "U",
  • "city_state_mailing_name_indicator": "Y",
  • "carrier_route_rate_sortation": "C",
  • "finance_number": 353910,
  • "congressional_district_number": 2,
  • "county_number": 103
}

IE Eircode ECAF

Standard Republic of Ireland Address format as reported by the Eircode ECAF file.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "ecaf"

Source of address

country_iso
required
string
Value: "IRL"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "IE"

2 letter country code (ISO 3166-1)

country
required
string
Value: "Ireland"

Full country names (ISO 3166)

language
required
string
Enum: "en" "ga"

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

line_1
required
string [ 0 .. 200 ] characters

Address Line 1

line_2
required
string [ 0 .. 200 ] characters

Address Line 2

line_3
required
string [ 0 .. 200 ] characters

Address Line 3

line_4
required
string [ 0 .. 200 ] characters

Address Line 4

line_5
required
string [ 0 .. 200 ] characters

Address Line 5

line_6
required
string [ 0 .. 200 ] characters

Address Line 6

line_7
required
string [ 0 .. 200 ] characters

Address Line 7

line_8
required
string [ 0 .. 200 ] characters

Address Line 8

line_9
required
string [ 0 .. 200 ] characters

Address Line 9

department
required
string [ 0 .. 60 ] characters

The department or division within an organisation, e.g. Accounts Department. If the department element exists, then the organisation must also exist.

organisation
required
string [ 0 .. 60 ] characters

Organisation name, e.g. Oak Tree Limited.

sub_building_name
required
string [ 0 .. 60 ] characters

The sub-building refers to an apartment, flat or unit within a building, e.g. Flat 1.

building_name
required
string [ 0 .. 60 ] characters

The name given to the building, e.g. Rose Cottage. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group.

building_number
required
string [ 0 .. 40 ] characters

A number associated with the whole building. The building number may have a numeric and an alphanumeric component, which are concatenated e.g. 2A, or alternatively will have a simple building number or a complex building number. The building number always relates to the whole building and not a sub-unit within it. A complex building number may be one of the following:

  • Dual. Two numbers separated by '/' e.g. 63/64 = 63, 64
  • Sequence. An odd or even sequence of numbers with lower and upper bound separated by an underscore '_' e.g. 1_5 = 1,3,5 and 2_6 = 2,4,6
  • Range. A range of consecutive numbers with lower and upper bound separated by a dash '-' e.g. 63-66 = 63, 64, 65, 66 The building number never appears on a line by itself and can prepend Building Group, Primary Thoroughfare or Primary Locality.
building_group
required
string [ 0 .. 60 ] characters

A building group is a collection of buildings with a collective name, located on or near the same thoroughfare, e.g. Marrian Terrace.

primary_thoroughfare
required
string [ 0 .. 40 ] characters

The name of the thoroughfare on which premises are located, e.g. Griffith Road. It may appear on a line by itself or be appended to either a sub building or building number.

Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address.

secondary_thoroughfare
required
string [ 0 .. 40 ] characters

It is never present without a primary thoroughfare. The primary thoroughfare is dependent on the secondary thoroughfare and appears before the secondary thoroughfare in any address.

Secondary thoroughfare are generally used to assist locating a primary thoroughfare.

primary_locality
required
string [ 0 .. 40 ] characters

First locality elements which can refer to areas, districts, industrial estates, towns, etc.

The primary locality refers to the specific place the address is.

In urban areas, the primary locality can be required to distinguish between two thoroughfares of the same name in the same district or town. Industrial estates with named thoroughfares are also held as localities. In rural areas the primary locality is generally a townland name.

secondary_locality
required
string [ 0 .. 40 ] characters

Never present without a primary locality. The secondary locality has a wider geographic scope than the primary locality.

It is the secondary locality therefore which differentiates addresses with the same primary locality name within the same county.

Secondary localities are more likely to be required for rural addresses.

Second locality elements which can refer to areas, districts, industrial estates, towns, etc

The secondary locality helps identify where the primary locality is located.

tertiary_locality
required
string [ 0 .. 40 ] characters

Also known as the Post Town.

The name of the post town associated with the premises for postal delivery purposes. This includes Dublin Postal Districts "Dublin 1" to "Dublin 24".

The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner:

"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience."

post_county
required
string [ 0 .. 30 ] characters

One of the 26 Counties in the Republic of Ireland. These counties are sub-national divisions used for the purposes of administrative, geographical and political demarcation. Post County is the County associated with the Post Town, not the geographic county in which the building is located. The Post County is normally used as part of the Postal Address with some exceptions e.g. Dublin Postal Districts where the Post County is not used and some Post Towns (e.g. Tipperary, Kildare, etc.) that have the same name as the Post County.

eircode
required
string [ 0 .. 60 ] characters

The seven character Eircode has an A65 F4E2 format. The Eircode is a mandatory address element. The last line of a Postal Address will contain the Eircode, displayed with a space. e.g. A65 F4E2.

The Eircode is always the last line of a Postal Address generated within the state, e.g. if an address has four lines then the Eircode will be on its own on Address Line 5. For inbound international mail the country name IRELAND should be appended as the last line of the Postal Address.

address_reference
required
string [ 0 .. 16 ] characters

The address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

ecaf_id
required
string [ 0 .. 10 ] characters

The unique identifier in the ECAF is the ecaf_id. This unique identifier allows each address in the ECAF to be uniquely identified. It can also be used as index once the data has been imported into a relational database. This is a numeric field that can store values from 0 to 2,147,483,647. It is represented as a number up to 10 digits long. All other fields in ECAF are alphanumeric.

{
  • "id": "ecaf_1700000000|en",
  • "dataset": "ecaf",
  • "country_iso": "IRL",
  • "country_iso_2": "IE",
  • "country": "Ireland",
  • "language": "en",
  • "line_1": "Apartment 4",
  • "line_2": "The Mall",
  • "line_3": "Riverside Way",
  • "line_4": "Midleton",
  • "line_5": "Co. Cork",
  • "line_6": "P25 PR28",
  • "line_7": "",
  • "line_8": "",
  • "line_9": "",
  • "ecaf_id": "1700000000",
  • "department": "",
  • "organisation": "",
  • "sub_building_name": "Apartment 4",
  • "building_name": "",
  • "building_number": "",
  • "building_group": "The Mall",
  • "primary_thoroughfare": "Riverside Way",
  • "secondary_thoroughfare": "",
  • "primary_locality": "Midleton",
  • "secondary_locality": "",
  • "tertiary_locality": "",
  • "post_county": "Cork",
  • "eircode": "P25 PR28",
  • "address_reference": "4065432740654331",
  • "longitude": "",
  • "latitude": ""
}

IE Eircode ECAD

ECAF file including additional data for each address.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "ecad"

Source of address

country_iso
required
string
Value: "IRL"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "IE"

2 letter country code (ISO 3166-1)

country
required
string
Value: "Ireland"

Full country names (ISO 3166)

language
required
string
Enum: "en" "ga"

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

line_1
required
string [ 0 .. 200 ] characters

Address Line 1

line_2
required
string [ 0 .. 200 ] characters

Address Line 2

line_3
required
string [ 0 .. 200 ] characters

Address Line 3

line_4
required
string [ 0 .. 200 ] characters

Address Line 4

line_5
required
string [ 0 .. 200 ] characters

Address Line 5

line_6
required
string [ 0 .. 200 ] characters

Address Line 6

line_7
required
string [ 0 .. 200 ] characters

Address Line 7

line_8
required
string [ 0 .. 200 ] characters

Address Line 8

line_9
required
string [ 0 .. 200 ] characters

Address Line 9

department
required
string [ 0 .. 60 ] characters

The department or division within an organisation, e.g. Accounts Department. If the department element exists, then the organisation must also exist.

organisation
required
string [ 0 .. 60 ] characters

Organisation name, e.g. Oak Tree Limited.

sub_building_name
required
string [ 0 .. 60 ] characters

The sub-building refers to an apartment, flat or unit within a building, e.g. Flat 1.

building_name
required
string [ 0 .. 60 ] characters

The name given to the building, e.g. Rose Cottage. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group.

building_number
required
string [ 0 .. 40 ] characters

A number associated with the whole building. The building number may have a numeric and an alphanumeric component, which are concatenated e.g. 2A, or alternatively will have a simple building number or a complex building number. The building number always relates to the whole building and not a sub-unit within it. A complex building number may be one of the following:

  • Dual. Two numbers separated by '/' e.g. 63/64 = 63, 64
  • Sequence. An odd or even sequence of numbers with lower and upper bound separated by an underscore '_' e.g. 1_5 = 1,3,5 and 2_6 = 2,4,6
  • Range. A range of consecutive numbers with lower and upper bound separated by a dash '-' e.g. 63-66 = 63, 64, 65, 66 The building number never appears on a line by itself and can prepend Building Group, Primary Thoroughfare or Primary Locality.
building_group
required
string [ 0 .. 60 ] characters

A building group is a collection of buildings with a collective name, located on or near the same thoroughfare, e.g. Marrian Terrace.

primary_thoroughfare
required
string [ 0 .. 40 ] characters

The name of the thoroughfare on which premises are located, e.g. Griffith Road. It may appear on a line by itself or be appended to either a sub building or building number.

Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address.

secondary_thoroughfare
required
string [ 0 .. 40 ] characters

It is never present without a primary thoroughfare. The primary thoroughfare is dependent on the secondary thoroughfare and appears before the secondary thoroughfare in any address.

Secondary thoroughfare are generally used to assist locating a primary thoroughfare.

primary_locality
required
string [ 0 .. 40 ] characters

First locality elements which can refer to areas, districts, industrial estates, towns, etc.

The primary locality refers to the specific place the address is.

In urban areas, the primary locality can be required to distinguish between two thoroughfares of the same name in the same district or town. Industrial estates with named thoroughfares are also held as localities. In rural areas the primary locality is generally a townland name.

secondary_locality
required
string [ 0 .. 40 ] characters

Never present without a primary locality. The secondary locality has a wider geographic scope than the primary locality.

It is the secondary locality therefore which differentiates addresses with the same primary locality name within the same county.

Secondary localities are more likely to be required for rural addresses.

Second locality elements which can refer to areas, districts, industrial estates, towns, etc

The secondary locality helps identify where the primary locality is located.

tertiary_locality
required
string [ 0 .. 40 ] characters

Also known as the Post Town.

The name of the post town associated with the premises for postal delivery purposes. This includes Dublin Postal Districts "Dublin 1" to "Dublin 24".

The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner:

"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience."

post_county
required
string [ 0 .. 30 ] characters

One of the 26 Counties in the Republic of Ireland. These counties are sub-national divisions used for the purposes of administrative, geographical and political demarcation. Post County is the County associated with the Post Town, not the geographic county in which the building is located. The Post County is normally used as part of the Postal Address with some exceptions e.g. Dublin Postal Districts where the Post County is not used and some Post Towns (e.g. Tipperary, Kildare, etc.) that have the same name as the Post County.

eircode
required
string [ 0 .. 60 ] characters

The seven character Eircode has an A65 F4E2 format. The Eircode is a mandatory address element. The last line of a Postal Address will contain the Eircode, displayed with a space. e.g. A65 F4E2.

The Eircode is always the last line of a Postal Address generated within the state, e.g. if an address has four lines then the Eircode will be on its own on Address Line 5. For inbound international mail the country name IRELAND should be appended as the last line of the Postal Address.

address_reference
required
string [ 0 .. 16 ] characters

The address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

ecad_id
required
string [ 1 .. 10 ] characters

Unique ECAD identifier for the postal address. Up to 10 digits.

organisation_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the organisation. Empty string if the address has no organisation.

address_point_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the address point.

building_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the building.

building_group_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the building group. Empty string if the address has no building group.

primary_thoroughfare_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the primary thoroughfare.

secondary_thoroughfare_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the secondary thoroughfare. Empty string if the address has no secondary thoroughfare.

primary_locality_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the primary locality. Empty string if the address has no primary locality.

secondary_locality_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the secondary locality. Empty string if the address has no secondary locality.

post_town
required
string >= 0 characters

The name of the post town associated with the premises for postal delivery purposes. Returned in the language given by language, and mirrors tertiary_locality for this dataset.

The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner:

"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as post towns, chosen because of their accessibility and convenience."

post_town_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the post town.

post_county_id
required
string [ 0 .. 10 ] characters

GeoDirectory identifier for the post county. Empty string if the address has no post county.

nua
required
boolean

NUA means "non-unique address".

The NUA field contains true when the address is a non-unique address, and false when it is a unique address.

Ireland has a very high level of non-unique addresses (NUA), i.e. the address does not contain a unique building number or name. Approximately 35% of all Irish addresses are non-unique which equates to 600,000 addresses.

The typical example of NUA addressing is where every address in a townland is the same. The way that post is delivered is by local knowledge of postal delivery personnel of which addressee lives in which house.

N.B. For a NUA address, it is impossible to match to a unique record in the ECAD and assign an Eircode.

gaeltacht
required
boolean

Gaeltacht refers to a district where the Irish government recognises that the Irish language is the predominant language.

Returns true if address is in a Gaeltacht area and false if not.

address_type
required
string >= 0 characters

Addresses points can assume one of the following values:

  • Residential Address Point. This type of address point has one residential addresses associated with it.
  • Non-Residential Address Point. This type of address point has one or more non-residential address (business, club or other organisation) associated with it.
  • Mixed Address Point. This is a special case where the residential and non residential addresses in the building are essentially the same address. The typical example is a farm house on an active farm. It is important to note that this is a special case. In general a building with both residential and non-residential addresses (e.g. an apartment over a shop) will receive two address points, one commercial and one residential, and hence two Eircodes.

Buildings can contain multiple address points of type Residential and/or Non-Residential.

building_address_type
required
string >= 0 characters

The building type can assume one of the following values:

  • Single Occupancy Residential Building. This type of building contains one residential address.
  • Multi Occupancy Residential Building. This type of building contains multiple residential addresses.
  • Single Occupancy Non-Residential Building. This type of building contains one non-residential address (business, club or other organisation).
  • Multi Occupancy Non-Residential Building. This type of building contains multiple non-residential addresses (business, club or other organisation).
  • Multi Occupancy Mixed Use Building. This type of building contains multiple residential and non- residential addresses.

Buildings can also have a more specific address types such as a Hospital, School, Shopping Centre, etc.

building_group_address_type
required
string >= 0 characters

The building group type can be:

  • Residential Building Group. This type of building group contains buildings with residential addresses only.
  • Non-Residential Building Group This type of building group contains buildings with non-residential addresses (business, club or other organisation) only.
  • Mixed Building Group. This type of building group contains buildings with residential and non-residential addresses. Can also have a more specific address type such as a Hospital, School, Shopping Centre, etc.

Building groups can also have a more specific address type such as a Hospital, School, Shopping Centre, etc.

primary_locality_address_type
required
string >= 0 characters

The locality type can be:

  • Rural Locality. This is generally a townland.
  • Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc.
  • Shopping District. Shopping Centre.
  • Housing Estate. Residential Housing Estate.
  • Village. Based on Census 2011 population < 1,500.
  • Town. Based on Census 2011 population > 1,500.
  • Urban Area. Wholly within a village/town/city e.g. Rathmines.
  • Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland.

Where the locality is also the post town, the type can be:

  • Village. Based on Census 2011 population < 1,500
  • Town. Based on Census 2011 population > 1,500
  • Postal District. Dublin 1 to 24
  • City. Dublin, Cork, Limerick, Galway or Waterford
secondary_locality_address_type
required
string >= 0 characters

The locality type can be:

  • Rural Locality. This is generally a townland.
  • Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc.
  • Shopping District. Shopping Centre.
  • Housing Estate. Residential Housing Estate.
  • Village. Based on Census 2011 population < 1,500.
  • Town. Based on Census 2011 population > 1,500.
  • Urban Area. Wholly within a village/town/city e.g. Rathmines.
  • Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland.

Where the locality is also the post town, the type can be:

  • Village. Based on Census 2011 population < 1,500
  • Town. Based on Census 2011 population > 1,500
  • Postal District. Dublin 1 to 24
  • City. Dublin, Cork, Limerick, Galway or Waterford
building_type
required
string >= 0 characters

Describes the type of building, e.g. detached, semi-detached, bungalow.

holiday_home
required
string
Enum: "Y" "N" ""

A Yes/No field, indicating whether or not the building is a holiday home. Empty string if unknown.

under_construction
required
string
Enum: "Y" "N" ""

A Yes/No field, indicating whether or not the building is under construction. Empty string if unknown.

building_use
required
string
Enum: "R" "C" "B" "U" ""

Can be one of:

  • R Residential
  • C Commercial
  • B Both
  • U Unknown

Empty string if the building carries no use information.

vacant
required
string
Enum: "Y" "N" ""

A Yes/No field, indicating whether the building is vacant. Empty string if unknown.

org_vacant
required
string
Enum: "Y" "N" ""

A Yes/No field, indicating whether the organisation is vacant. Empty string if unknown or the address has no organisation.

nace_code
required
string >= 0 characters

The NACE Code for the Category.

nace_category
required
string >= 0 characters

Name of the NACE Category

local_authority
required
string >= 0 characters

Name of local authority

ded_id
required
string >= 0 characters

Unique Identifier for the Electoral Division, from the 2017 data.

Electoral Divisions are legally defined administrative areas in Ireland. There are 3,441 Electoral Divisions, each a sub-division of a County.

Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.

small_area_id
required
string >= 0 characters

Unique Identifier for the Small Area, from the 2017 data.

Small Area boundaries are sub-divisions of Electoral Divisions. A normal Small Area comprises approximately 80-120 dwellings, created by the National Institute of Regional and Spatial Analysis (NIRSA) on behalf of Ordnance Survey Ireland (OSi) in consultation with the Central Statistics Office (CSO).

Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.

townland_id
required
string >= 0 characters

Unique Identifier for the townland, from the 2017 data.

A townland is a small geographical division of land commonly used in Ireland, and the building block for higher-level Electoral Divisions. Townland names may not be unique within a County.

Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.

gaeltacht_id
required
string >= 0 characters

Unique Identifier for the Gaeltacht area, from the 2017 data. There are 7 Gaeltacht areas. Empty string if the address is not in a Gaeltacht.

Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.

postaim_presort_61
required
string >= 0 characters

An Post sorting information.

postaim_presort_152
required
string >= 0 characters

An Post sorting information.

publicity_post_zone
required
string >= 0 characters

An Post publicity post zone information.

{
  • "id": "ecad_1700000000|en",
  • "dataset": "ecad",
  • "ecad_id": "1700000000",
  • "country_iso": "IRL",
  • "country_iso_2": "IE",
  • "country": "Ireland",
  • "language": "en",
  • "line_1": "Apartment 4",
  • "line_2": "The Mall",
  • "line_3": "Riverside Way",
  • "line_4": "Midleton",
  • "line_5": "Co. Cork",
  • "line_6": "P25 PR28",
  • "line_7": "",
  • "line_8": "",
  • "line_9": "",
  • "department": "",
  • "organisation": "",
  • "sub_building_name": "Apartment 4",
  • "building_name": "",
  • "building_number": "",
  • "building_group": "The Mall",
  • "primary_thoroughfare": "Riverside Way",
  • "secondary_thoroughfare": "",
  • "primary_locality": "",
  • "secondary_locality": "",
  • "tertiary_locality": "Midleton",
  • "post_county": "Cork",
  • "eircode": "P25 PR28",
  • "address_reference": "4065432740654331",
  • "organisation_id": "",
  • "address_point_id": "1700000000",
  • "building_id": "1401909875",
  • "building_group_id": "1300011097",
  • "primary_thoroughfare_id": "1200004534",
  • "secondary_thoroughfare_id": "",
  • "primary_locality_id": "",
  • "secondary_locality_id": "",
  • "post_town": "Midleton",
  • "post_town_id": "1100000075",
  • "post_county_id": "1001000000",
  • "nua": false,
  • "gaeltacht": false,
  • "address_type": "Residential Address Point",
  • "building_address_type": "Multi Occupancy Mixed Building",
  • "building_group_address_type": "Apartment Complex",
  • "primary_locality_address_type": "",
  • "secondary_locality_address_type": "",
  • "building_type": "Semi-Detached",
  • "holiday_home": "N",
  • "under_construction": "N",
  • "building_use": "B",
  • "vacant": "N",
  • "org_vacant": "",
  • "nace_code": "",
  • "nace_category": "",
  • "local_authority": "",
  • "ded_id": "",
  • "small_area_id": "",
  • "townland_id": "",
  • "gaeltacht_id": "",
  • "postaim_presort_61": "Portlaoise Hub",
  • "postaim_presort_152": "Midleton",
  • "publicity_post_zone": "19",
  • "longitude": "",
  • "latitude": ""
}

AT BEV

Standard Austrian Address format as reported by the BEV (Bundesamt für Eich- und Vermessungswesen) address register.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "bev"
country
required
string
Value: "Austria"

Full country names (ISO 3166)

country_iso
required
string
Value: "AUT"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "AT"

2 letter country code (ISO 3166-1)

language
required
string
Value: "de"

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

address
required
string

Complete house number: hnr_adr_zusammen combined with hnr_geb_zusammen.

Can be empty string "" if not present.

line_1
required
string

First address line. The building or farmstead name (hofname) where one is present, otherwise the street line (street name plus address).

Can be empty string "" if not present.

line_2
required
string

Second address line. The street line (street name plus address) where line_1 holds the building name.

Empty string "" where the address has no building name.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

adrcd
required
string

Unique identifier of the address

kgnr
required
string

Comma-separated cadastral numbers (Katastralgemeindenummer) of the land parcels associated with the address

gkz
required
string

Municipality unique identifier

okz
required
string

Locality unique identifier

plz
required
string

Postal code

skz
required
string

Street unique identifier

zaehlsprengel
required
string

Census district unique identifier

hausnrtext
required
string

Text before house number

Can be empty string "" if not present.

hausnrzahl1
required
integer

House number part 1

hausnrbuchstabe1
required
string

House letter part 1

Can be empty string "" if not present.

hausnrverbindung1
required
string

House number connector 1. - indicates hausnrzahl1 to hausnrzahl2 is a range.

Can be empty string "" if not present.

required
string or integer
hausnrbuchstabe2
required
string

House letter part 2

Can be empty string "" if not present.

hausnrbereich
required
string

House number range scheme (even, odd, all or not specified), as German source text

hnr_adr_zusammen
required
string

Complete house number of the address (combination of house number parts and letters)

Can be empty string "" if not present.

gnradresse
required
integer

Parcel number used as an address when no house number is present. 0 where unused.

hofname
required
string

Name of building or building complex (e.g. farmstead), title cased

Can be empty string "" if not present.

rw
required
string

Easting / X coordinate in the coordinate reference system given by epsg

hw
required
string

Northing / Y coordinate in the coordinate reference system given by epsg

epsg
required
integer

Coordinate reference system identifier for rw and hw

quelladresse
required
string

Coordinate accuracy level (building level, parcel level, etc.)

bestimmungsart
required
string

Coordinate determination method (DKM, surveying office, municipality, etc.)

subcd
required
string

Subcode to distinguish multiple buildings at the same address

objektnummer
required
string

Object number of the building

objfunktkennziffer
required
string

Comma-separated building function codes for the building (e.g. 01 pharmacy, 04 fire department, 08 school, 99 no function assigned)

Can be empty string "" if not present.

hauptadresse
required
integer

1 where this is the primary address for the associated building, 0 otherwise

hausnrverbindung2
required
string

House number connector 2

Can be empty string "" if not present.

required
string or integer
hausnrbuchstabe3
required
string

House letter part 3

Can be empty string "" if not present.

hausnrverbindung3
required
string

House number connector 3

Can be empty string "" if not present.

required
string or integer
hausnrbuchstabe4
required
string

House letter part 4

Can be empty string "" if not present.

hausnrgebaeudebez
required
string

Building description

Can be empty string "" if not present.

hnr_geb_zusammen
required
string

Complete building designation (combination of house number and building designation)

Can be empty string "" if not present.

eigenschaft
required
string

Code indicating the primary use or function of the building (e.g. 01 one apartment, 02 two or more apartments, 05 office building)

gemeindename
required
string

Name of the municipality

ortsname
required
string

Name of the locality

strassenname
required
string

Name of the street

strassennamenzusatz
required
string

Street type (e.g. "Allee", "Strasse")

Can be empty string "" if not present.

szusadrbest
required
integer

Indicates whether the street type is included in the street name

zustellort
required
string

Postal town name

zustellort_id
required
string

Postal town identifier

zaehlsprengelname
required
string

Name of the census district

{
  • "id": "bev_5000090|001",
  • "dataset": "bev",
  • "country": "Austria",
  • "country_iso": "AUT",
  • "country_iso_2": "AT",
  • "language": "de",
  • "address": "41",
  • "line_1": "Poltenweg 41",
  • "line_2": "",
  • "latitude": 47.240128940538256,
  • "longitude": 11.401418155046553,
  • "adrcd": "5000090",
  • "kgnr": "81134",
  • "gkz": "70101",
  • "okz": "16406",
  • "plz": "6080",
  • "skz": "001319",
  • "zaehlsprengel": "70101700",
  • "hausnrtext": "",
  • "hausnrzahl1": 41,
  • "hausnrbuchstabe1": "",
  • "hausnrverbindung1": "",
  • "hausnrzahl2": "",
  • "hausnrbuchstabe2": "",
  • "hausnrbereich": "keine Angabe",
  • "hnr_adr_zusammen": "41",
  • "gnradresse": 0,
  • "hofname": "",
  • "rw": "80893.30",
  • "hw": "234024.51",
  • "epsg": 31254,
  • "quelladresse": "G",
  • "bestimmungsart": "Z",
  • "subcd": "001",
  • "objektnummer": "1330150",
  • "objfunktkennziffer": "99",
  • "hauptadresse": 1,
  • "hausnrverbindung2": "",
  • "hausnrzahl3": "",
  • "hausnrbuchstabe3": "",
  • "hausnrverbindung3": "",
  • "hausnrzahl4": "",
  • "hausnrbuchstabe4": "",
  • "hausnrgebaeudebez": "",
  • "hnr_geb_zusammen": "",
  • "eigenschaft": "02",
  • "gemeindename": "Innsbruck",
  • "ortsname": "Vill",
  • "strassenname": "Poltenweg",
  • "strassennamenzusatz": "",
  • "szusadrbest": 0,
  • "zustellort": "Innsbruck",
  • "zustellort_id": "15215",
  • "zaehlsprengelname": "70101 700"
}

CH Swisstopo

Standard Swiss and Liechtenstein Address format from the Swisstopo official directories of buildings, streets and localities.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "swt"
country
required
string
Enum: "Switzerland" "Liechtenstein"

Full country names (ISO 3166)

country_iso
required
string
Enum: "CHE" "LIE"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Enum: "CH" "LI"

2 letter country code (ISO 3166-1)

language
required
string
Enum: "de" "fr" "it" "rm"

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

canton
required
string

Canton name, in the language of the address (e.g. "Basel-Stadt", "Grigioni", "Grischun"). For Liechtenstein addresses this is the district.

Can be empty string "" if not present.

address
required
string

House number. Same value as adr_number.

Can be empty string "" if not present.

line_1
required
string

First address line. The building name where present, otherwise the street name and house number.

Can be empty string "" if not present.

line_2
required
string

Second address line. The street name and house number where line_1 holds a building name.

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

adr_egaid
required
integer

Federal building address identifier (Eidgenössischer Gebäudeadressidentifikator).

str_esid
required
integer

Federal street identifier (Eidgenössischer Strassenidentifikator). Joins the address to the street directory.

bdg_egid
required
integer

Federal building identifier (Eidgenössischer Gebäudeidentifikator).

adr_edid
required
integer

Entrance identifier within the building.

stn_label
required
string

Street name label. For French and Italian addresses the leading street type is lowercased (e.g. "rue de la Gare").

adr_number
required
string

House/address number (e.g. "12", "12A").

Can be empty string "" if not present.

bdg_category
required
string

Building category from the Federal Building and Dwelling Register (GWR), e.g. "residential", "non_residential".

bdg_name
required
string

Building name.

Can be empty string "" if not present.

zip_label
required
string

Postal code and locality label (e.g. "8001 Zürich").

com_fosnr
required
integer

Federal municipality number assigned by the Federal Statistical Office (FSO/BFS).

com_name
required
string

Municipality name.

com_canton
required
string

Canton abbreviation (e.g. "ZH", "BE").

Can be empty string "" if not present.

adr_status
required
string

Address status from the GWR, e.g. "real", "projected".

adr_official
required
boolean

Whether the address is an official address.

adr_modified
required
string

Date the address record was last modified, formatted DD.MM.YYYY.

adr_easting
required
string

Easting coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.

adr_northing
required
string

Northing coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.

str_type
required
string

Street type, e.g. "Street", "Area".

str_status
required
string

Street status, e.g. "real", "projected".

str_official
required
boolean

Whether the street name is official.

str_modified
required
string

Date the street record was last modified, formatted DD.MM.YYYY.

str_easting
required
string

Easting coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.

str_northing
required
string

Northing coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.

ortschaftsname
required
string

Locality name from the Official Directory of Towns and Cities (Amtliches Ortschaftenverzeichnis).

Can be empty string "" if the address does not match a locality record.

plz4
required
string

4-digit Swiss postal code, zero padded.

Can be empty string "" if the address does not match a locality record.

zusatzziffer
required
string or null

2-digit supplementary code distinguishing localities that share a 4-digit postal code.

null if the address does not match a locality record.

zip_id
required
integer or null

Unique identifier for the postal code record.

null if the address does not match a locality record.

gemeindename
required
string or null

Municipality name (Gemeindename) from the locality directory.

null if the address does not match a locality record.

bfs_nr
required
integer or null

Federal municipality number assigned by the Federal Statistical Office (BFS-Nr).

null if the address does not match a locality record.

kantonskürzel
required
string

Canton abbreviation from the locality directory (e.g. "ZH", "GE").

Can be empty string "" if not present.

sprache
required
string or null

Language of the address, mirroring language.

validity
required
string or null

Date the postal code record became valid, formatted YYYY-MM-DD.

{
  • "id": "swt_102410972|de",
  • "dataset": "swt",
  • "country": "Switzerland",
  • "country_iso": "CHE",
  • "country_iso_2": "CH",
  • "language": "de",
  • "canton": "Basel-Stadt",
  • "address": "15.1",
  • "line_1": "Brohegasse 15.1",
  • "line_2": "",
  • "latitude": 47.571268381201655,
  • "longitude": 7.663107983521497,
  • "adr_egaid": 102410972,
  • "str_esid": 10025136,
  • "bdg_egid": 243057973,
  • "adr_edid": 0,
  • "stn_label": "Brohegasse",
  • "adr_number": "15.1",
  • "bdg_category": "non_residential",
  • "bdg_name": "",
  • "zip_label": "4126 Bettingen",
  • "com_fosnr": 2702,
  • "com_name": "Bettingen",
  • "com_canton": "BS",
  • "adr_status": "real",
  • "adr_official": false,
  • "adr_modified": "23.07.2024",
  • "adr_easting": "2616891.820",
  • "adr_northing": "1268975.560",
  • "str_type": "Street",
  • "str_status": "real",
  • "str_official": true,
  • "str_modified": "23.07.2024",
  • "str_easting": "2616922.086",
  • "str_northing": "1268999.001",
  • "ortschaftsname": "Bettingen",
  • "plz4": "4126",
  • "zusatzziffer": "00",
  • "zip_id": 2531,
  • "gemeindename": "Bettingen",
  • "bfs_nr": 2702,
  • "kantonskürzel": "BS",
  • "sprache": "de",
  • "validity": "2008-07-01"
}

AU G-NAF

Standard Australian Address format from Geoscape's Geocoded National Address File (G-NAF).

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "gnaf"
country
required
string
Enum: "Australia" "Cocos (Keeling) Islands" "Christmas Island" "Norfolk Island"

Full country names (ISO 3166)

country_iso
required
string
Enum: "AUS" "CCK" "CXR" "NFK"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Enum: "AU" "CC" "CX" "NF"

2 letter country code (ISO 3166-1)

line_1
required
string

First address line. The building name where one is recorded, otherwise the street line.

Can be empty string "" if not present.

line_2
required
string

Second address line. The street line where line_1 carries a building name.

Can be empty string "" if not present.

language
required
string
Value: "en"

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

address
required
string

Address / House Number uniquely identifying the address along the specified street. For a ranged address this is the number matched from the query, not the whole range.

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

address_detail_pid
required
string

The Persistent Identifier is unique to the real world feature this record represents.

date_created
required
string <date-time>

ISO 8601 date-time this record was created.

date_last_modified
required
string

ISO 8601 date-time this record was last modified (not retired/recreated in line with ICSM standard).

Empty string "" if the record has never been modified.

date_retired
required
string

ISO 8601 date-time this record was retired.

Empty string "" if the record is current.

building_name
required
string

Combines both building/property name fields. Field length: up to 200 alphanumeric characters (AS4590:2006 5.7).

lot_number_prefix
required
string

Lot number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).

lot_number
required
string

Lot number. Field length: up to five alphanumeric characters (AS4590:2006 5.8.1).

lot_number_suffix
required
string

Lot number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).

flat_type_code
required
string

Specification of the type of a separately identifiable portion within a building/complex. Field Length: up to seven upper case alpha characters (AS4590:2006 5.5.1.1).

flat_number_prefix
required
string

Flat/unit number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).

required
string or integer
flat_number_suffix
required
string

Flat/unit number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).

level_type_code
required
string

Level type. Field length: up to four alphanumeric characters (AS4590:2006 5.5.2.1).

level_number_prefix
required
string

Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).

required
string or integer
level_number_suffix
required
string

Level number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).

number_first_prefix
required
string

Prefix for the first (or only) number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.1).

required
string or integer
number_first_suffix
required
string

Suffix for the first (or only) number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.1).

number_last_prefix
required
string

Prefix for the last number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.2).

required
string or integer
number_last_suffix
required
string

Suffix for the last number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.2).

street_locality_pid
required
string

Identifier of the street locality this address sits on. Not mandatory - some G-NAF records do not require a street (e.g. a remote rural property).

alias_principal
required
string

A = Alias record, P = Principal record.

postcode
required
string

Postcodes are optional as prescribed by AS4819 and AS4590:2006 5.13.

private_street
required
string

Private street information. This is not broken up into name/type/suffix. Field length: up to 75 alphanumeric characters. This is not currently populated.

legal_parcel_id
required
string

Generic parcel id field derived from the Geoscape Australia's Cadastre parcel where available.

required
string or integer
level_geocoded_code
required
integer

Binary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc.

primary_secondary
required
string

Indicator that identifies if the address is P (Primary) or S (secondary).

alias_type_code
required
string

Comma separated alias types for this address (e.g. "Synonym"), one per alias record.

geocode_type_code
required
string

Unique abbreviation for the geocode type of the default geocode.

required
string or number
required
string or number
address_change_type_code
required
string

The code indicating the type of change, for example, LOC-STN for locality name and street name change.

mb_2016_match_code
required
string

Code for the 2016 mesh block match e.g. 1.

mb_2021_match_code
required
string

Code for the 2021 mesh block match e.g. 1.

address_type
required
string

Address type (e.g. "Postal", "Physical").

address_site_name
required
string

Address site name. Field length: 200 alphanumeric characters.

geocode_site_name
required
string

Comma separated identifiers relating to each geocoded site (e.g. "Transformer 75658"), one per site geocode record.

site_geocode_type_code
required
string

Comma separated abbreviations for each site geocode feature (e.g. "PRCL") (SAWG 7.4.1), one per site geocode record.

reliability_code
required
string

Comma separated spatial precision of each site geocode, expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode).

site_boundary_extent
required
string

Comma separated measurements (metres) of each site geocode from other geocodes associated with the same address persistent identifier.

site_planimetric_accuracy
required
string

Comma separated planimetric accuracy of each site geocode.

elevation
required
string

Comma separated elevation of each site geocode. This field is not currently populated.

site_longitude
required
string

Comma separated longitude of each site geocode (GDA2020).

site_latitude
required
string

Comma separated latitude of each site geocode (GDA2020).

required
string or integer
site_geocode_priority_order
required
string

Comma separated priority order of each site geocode type, 1 (most precise) to 29 (least precise), one per site geocode record.

locality_name
required
string

The name of the locality or suburb.

primary_postcode
required
string

Required to differentiate localities of the same name within a state.

locality_class_code
required
string

Describes the class of locality (e.g. Gazetted, topographic feature etc.). Lookup to locality class.

required
string or integer
locality_alias_name
required
string

Comma separated alias names for the locality or suburb.

locality_alias_postcode
required
string

Comma separated postcodes, one per locality alias.

locality_alias_type_code
required
string

Comma separated alias type codes, one per locality alias.

required
string or integer
required
string or number
required
string or number
mb_2016_code
required
string

The 2016 mesh block code.

mb_2021_code
required
string

The 2021 mesh block code.

ps_join_type_code
required
string

Comma separated join type codes, one per primary/secondary link on this address. Each is 1 OR 2 when the root address:-

Code 1: Automatically generated when the primary and secondary addresses share the same street number, street name (and type) and locality name components.

Code 2: Manually generated where the primary and secondary addresses MAY or MAY NOT share the same street number, street name (and type) and locality name components

state_name
required
string

The state or territory name, title cased. E.g. Tasmania.

state_abbreviation
required
string

The state or territory abbreviation.

street_class_code
required
string

Defines whether this street represents a confirmed or unconfirmed street.

street_name
required
string

Street name. e.g. "Barney".

street_type_code
required
string

The street type code. e.g. "Street".

street_suffix_code
required
string

The street suffix code. e.g. "West".

required
string or integer
required
string or integer
street_locality_alias_street_name
required
string

Comma separated street alias names. e.g. "Poplar".

street_locality_alias_street_type_code
required
string

Comma separated street type codes, one per street alias. e.g. "Place".

street_locality_alias_street_suffix_code
required
string

Comma separated street suffix codes, one per street alias. e.g. "West".

street_locality_alias_type_code
required
string

Comma separated alias type codes, one per street alias.

required
string or integer
required
string or integer
required
string or number
required
string or number
street_type_name
required
string

Abbreviation of the street type. e.g. "St".

street_locality_alias_street_type_name
required
string

Comma separated abbreviations of the street type, one per street alias. e.g. "St".

{
  • "id": "gnaf_GAQLD157509281|99",
  • "dataset": "gnaf",
  • "country": "Australia",
  • "country_iso": "AUS",
  • "country_iso_2": "AU",
  • "line_1": "Flat 3 99 Barney St",
  • "line_2": "",
  • "language": "en",
  • "address": "99",
  • "latitude": -23.85175973,
  • "longitude": 151.27280546,
  • "address_detail_pid": "GAQLD157509281",
  • "date_created": "2015-07-22T00:00:00.000Z",
  • "date_last_modified": "2021-07-07T00:00:00.000Z",
  • "date_retired": "",
  • "building_name": "",
  • "lot_number_prefix": "",
  • "lot_number": "1",
  • "lot_number_suffix": "",
  • "flat_type_code": "Flat",
  • "flat_number_prefix": "",
  • "flat_number": 3,
  • "flat_number_suffix": "",
  • "level_type_code": "",
  • "level_number_prefix": "",
  • "level_number": "",
  • "level_number_suffix": "",
  • "number_first_prefix": "",
  • "number_first": 99,
  • "number_first_suffix": "",
  • "number_last_prefix": "",
  • "number_last": "",
  • "number_last_suffix": "",
  • "street_locality_pid": "QLD106251",
  • "alias_principal": "P",
  • "postcode": "4680",
  • "private_street": "",
  • "legal_parcel_id": "1/RP611454",
  • "confidence": 2,
  • "level_geocoded_code": 7,
  • "primary_secondary": "S",
  • "alias_type_code": "",
  • "geocode_type_code": "PC",
  • "default_latitude": -23.85175973,
  • "default_longitude": 151.27280546,
  • "address_change_type_code": "",
  • "mb_2016_match_code": "1",
  • "mb_2021_match_code": "1",
  • "address_type": "UN",
  • "address_site_name": "",
  • "geocode_site_name": "",
  • "site_geocode_type_code": "PC",
  • "reliability_code": "2",
  • "site_boundary_extent": "",
  • "site_planimetric_accuracy": "",
  • "elevation": "",
  • "site_longitude": "151.27280546",
  • "site_latitude": "-23.85175973",
  • "geocode_type_priority_order": 14,
  • "site_geocode_priority_order": "14",
  • "locality_name": "Barney Point",
  • "primary_postcode": "",
  • "locality_class_code": "G",
  • "locality_gnaf_reliability_code": 5,
  • "locality_alias_name": "South Gladstone,Gladstone Harbour,Gladstone City,Gladstone",
  • "locality_alias_postcode": ",,,",
  • "locality_alias_type_code": "SYN,SYN,SYN,SYN",
  • "locality_planimetric_accuracy": "",
  • "locality_latitude": -23.84320223,
  • "locality_longitude": 151.26897733,
  • "mb_2016_code": "30563058200",
  • "mb_2021_code": "30563058200",
  • "ps_join_type_code": "1",
  • "state_name": "Queensland",
  • "state_abbreviation": "QLD",
  • "street_class_code": "C",
  • "street_name": "Barney",
  • "street_type_code": "Street",
  • "street_suffix_code": "",
  • "gnaf_street_confidence": 3,
  • "street_locality_gnaf_reliability_code": 4,
  • "street_locality_alias_street_name": "",
  • "street_locality_alias_street_type_code": "",
  • "street_locality_alias_street_suffix_code": "",
  • "street_locality_alias_type_code": "",
  • "street_locality_boundary_extent": 576,
  • "street_locality_planimetric_accuracy": "",
  • "street_locality_latitude": -23.85114069,
  • "street_locality_longitude": 151.27296937,
  • "street_type_name": "St",
  • "street_locality_alias_street_type_name": ""
}

BE BeST

Standard Belgian Address format from the federal BeST address dataset (FOD BOSA).

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "fodbosa"

Dataset the address originates from.

country
required
string
Value: "Belgium"

Full country names (ISO 3166)

country_iso
required
string
Value: "BEL"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "BE"

2 letter country code (ISO 3166-1)

language
required
string
Enum: "de" "fr" "nl"

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

address
required
string

House number, duplicated from house_number for consistency with other datasets. It does not identify the address on its own: boxes on the same number differ only by box_number.

Can be empty string "" if not present.

line_1
required
string

First address line. Street name, house number and, where present, box number, rendered in the address language.

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

epsg_31370_x
required
string

X coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system.

epsg_31370_y
required
string

Y coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system.

epsg_4326_lat
required
string

Latitude of the address in the WGS84 (EPSG:4326) coordinate system. String form of latitude.

epsg_4326_lon
required
string

Longitude of the address in the WGS84 (EPSG:4326) coordinate system. String form of longitude.

address_id
required
string

Address local identifier assigned by the data supplier.

Not unique on its own - the three regional files each number from scratch, so the same identifier can appear once per region. Use id, or (address_id, street_id, municipality_id), to identify an address.

box_number
required
string

Box or apartment number.

Can be empty string "" if not present.

house_number
required
string

House number.

Can be empty string "" if not present.

municipality_id
required
string

Municipality local identifier (NIS code) assigned by the data supplier.

municipality_name_de
required
string

Municipality name in German.

Can be empty string "" if not present.

municipality_name_fr
required
string

Municipality name in French.

Can be empty string "" if not present.

municipality_name_nl
required
string

Municipality name in Dutch.

Can be empty string "" if not present.

postcode
required
string

Postal code. 4 digits, first digit non-zero.

postname_fr
required
string

Post town name in French.

Can be empty string "" if not present. Brussels Capital Region addresses carry no post names - use municipality_name_fr instead.

postname_nl
required
string

Post town name in Dutch.

Can be empty string "" if not present. Brussels Capital Region addresses carry no post names - use municipality_name_nl instead.

street_id
required
string

Street local identifier assigned by the data supplier.

streetname_de
required
string

Street name in German.

Can be empty string "" if not present.

streetname_fr
required
string

Street name in French.

Can be empty string "" if not present.

streetname_nl
required
string

Street name in Dutch.

Can be empty string "" if not present.

region_code
required
string

ISO 3166-2 code of the region in which the address is located. One of BE-BRU (Brussels Capital Region), BE-VLG (Flanders) or BE-WAL (Wallonia).

status
required
string

Address lifecycle status assigned by the data supplier. Only current addresses are indexed and served, so this is always current. The supplier's remaining codes (proposed, reserved, retired, rejected) are filtered out.

{
  • "id": "fodbosa_1000000|3048|21007|fr",
  • "dataset": "fodbosa",
  • "country": "Belgium",
  • "country_iso": "BEL",
  • "country_iso_2": "BE",
  • "language": "fr",
  • "address": "5",
  • "line_1": "rue Rodenbach 5 - boîte bt08",
  • "latitude": 50.82029,
  • "longitude": 4.34422,
  • "epsg_31370_x": "148270.73200",
  • "epsg_31370_y": "167761.35000",
  • "epsg_4326_lat": "50.82029",
  • "epsg_4326_lon": "4.34422",
  • "address_id": "1000000",
  • "box_number": "bt08",
  • "house_number": "5",
  • "municipality_id": "21007",
  • "municipality_name_de": "",
  • "municipality_name_fr": "Forest",
  • "municipality_name_nl": "Vorst",
  • "postcode": "1190",
  • "postname_fr": "",
  • "postname_nl": "",
  • "street_id": "3048",
  • "streetname_de": "",
  • "streetname_fr": "Rue Rodenbach",
  • "streetname_nl": "Rodenbachstraat",
  • "region_code": "BE-BRU",
  • "status": "current"
}

CA National Address Register

Standard Canadian Address format from the National Address Register.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "cannar"
country
required
string
Value: "Canada"

Full country names (ISO 3166)

country_iso
required
string
Value: "CAN"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "CA"

2 letter country code (ISO 3166-1)

language
required
string
Enum: "en" "fr"

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

address
required
string

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.

line_1
required
string

First address line. House number and street.

Can be empty string "" if not present.

line_2
required
string

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

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

loc_guid
required
string

Globally unique identifier for location.

addr_guid
required
string

Globally unique identifier for address.

apt_no_label
required
string

Apartment or suite number.

Can be empty string "" if not present.

civic_no
required
string

The building number assigned to the address.

Can be empty string "" if not present.

civic_no_suffix
required
string

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

Can be empty string "" if not present.

official_street_name
required
string

Official street name.

Can be empty string "" if not present.

official_street_type
required
string

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

Can be empty string "" if not present.

official_street_dir
required
string

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

Can be empty string "" if not present.

prov_code
required
string

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

csd_eng_name
required
string

Census subdivision English name.

Can be empty string "" if not present.

csd_fre_name
required
string

Census subdivision French name.

Can be empty string "" if not present.

csd_type_eng_code
required
string

English code indicating the type of Census Subdivision.

Can be empty string "" if not present.

csd_type_fre_code
required
string

French code indicating the type of Census Subdivision.

Can be empty string "" if not present.

mail_street_name
required
string

Name of the street used in the mailing address.

Can be empty string "" if not present.

mail_street_type
required
string

Designator of the street used in the mailing address.

Can be empty string "" if not present.

mail_street_dir
required
string

Direction of the street used in the mailing address.

Can be empty string "" if not present.

mail_mun_name
required
string

Municipality name used in the mailing address.

Can be empty string "" if not present.

mail_prov_abvn
required
string

Province abbreviation used in the mailing address.

Can be empty string "" if not present.

mail_postal_code
required
string

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.

bg_dls_lsd
required
string

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

Can be empty string "" if not present.

bg_dls_qtr
required
string

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

Can be empty string "" if not present.

bg_dls_sctn
required
string

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

Can be empty string "" if not present.

bg_dls_twnshp
required
string

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

Can be empty string "" if not present.

bg_dls_rng
required
string

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

Can be empty string "" if not present.

bg_dls_mrd
required
string

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

Can be empty string "" if not present.

bg_x
required
string

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

Can be empty string "" if not present.

bg_y
required
string

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

Can be empty string "" if not present.

bu_n_civic_add
required
string

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.

bu_use
required
string

Building usage code.

Can be empty string "" if not present.

csd_code
required
string

Unique identifier code for a Census Subdivision (CSD).

Can be empty string "" if not present.

fed_code
required
string

Unique identifier code for a federal electoral district.

Can be empty string "" if not present.

fed_eng_name
required
string

Name of the federal electoral district in English.

Can be empty string "" if not present.

fed_fre_name
required
string

Name of the federal electoral district in French.

Can be empty string "" if not present.

er_code
required
string

Unique identifier code for an economic region.

Can be empty string "" if not present.

er_eng_name
required
string

Name of the economic region in English.

Can be empty string "" if not present.

er_fre_name
required
string

Name of the economic region in French.

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

{
  • "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
}

DK SDFI

Standard Danish Address format from the Danish Agency for Data Supply and Infrastructure (SDFI).

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "sdfi"
country
required
string
Value: "Denmark"

Full country names (ISO 3166)

country_iso
required
string
Value: "DNK"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "DK"

2 letter country code (ISO 3166-1)

address
required
string

House number uniquely identifying the address along the street. Same value as husnr.

Can be empty string "" if not present.

line_1
required
string

First address line: street name and house number, followed by floor and door for a unit address.

Can be empty string "" if not present.

line_2
required
string

Second address line: the supplementary city name (supplerendebynavn) where present.

Can be empty string "" if not present.

language
required
any
Value: "da"

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

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

adresse_id
required
string

Unique address identifier assigned by the data supplier.

kvhx
required
string

Unique composite key for the address, containing codes for the municipality, road section, house number, floor and door.

kvh
required
string

Composite key for the address, containing codes for the municipality, road section and house number.

Can be empty string "" if not present.

adgangsadresse
required
boolean

Indicates whether the address is an access address.

status
required
string

1 = final address, 3 = provisional address.

darstatus
required
string

Status of the address indicated by the status code in Danmarks Adresseregister (DAR): 2 = provisional, 3 = valid, 4 = retired, 5 = suspended.

oprettet
required
string

Date and time of address creation in Danmarks Adresseregister (DAR).

Can be empty string "" if not present.

ændret
required
string

Date and time of the last change to the address in Danmarks Adresseregister (DAR).

Can be empty string "" if not present.

ikrafttrædelse
required
string

Date and time at which the address became valid.

Can be empty string "" if not present.

nedlagt
required
string

Date and time from which the address is retired or suspended (may be in the future).

Can be empty string "" if not present.

vejkode
required
string

Four digit street identifier.

vejnavn
required
string

Street name.

adresseringsvejnavn
required
string

A possibly shortened version of the street name of no more than 20 characters, used where there is no space for the full street name.

husnr
required
string

House number.

etage
required
string

Floor designation.

Can be empty string "" if not present.

dør
required
string

Door designation.

Can be empty string "" if not present.

supplerendebynavn_dagi_id
required
string

Unique identifier in Danmarks Administrative Geografiske Inddeling (DAGI) of the supplementary town or city name.

Can be empty string "" if not present.

supplerendebynavn
required
string

Supplementary city name.

Can be empty string "" if not present.

postnr
required
string

Postal code.

postnrnavn
required
string

The city or district name associated with the postal code.

stormodtagerpostnr
required
string

Bulk recipient postal code (company postal code) which is associated with the address.

Can be empty string "" if not present.

stormodtagerpostnrnavn
required
string

The city or district name associated with the bulk recipient postal code.

Can be empty string "" if not present.

betegnelse
required
string

Full text of postal address.

adressepunktændringsdato
required
string

Date and time of the last change to the address point.

Can be empty string "" if not present.

etrs89koordinat_øst
required
string

Easting coordinate for the address in the ETRS89 system.

etrs89koordinat_nord
required
string

Northing coordinate for the address in the ETRS89 system.

required
string or number

Latitude of the address in the WGS84 system.

Can be empty string "" if not present.

required
string or number

Longitude of the address in the WGS84 system.

Can be empty string "" if not present.

højde
required
string

Height in metres from the mean water level in the seas on Denmark's coasts to ground level at the address, calculated according to the Danish Vertical Reference 1990 (DVR90).

Can be empty string "" if not present.

nøjagtighed
required
string

Code indicating the accuracy of the address point. A = accurate to within 2 metres, B = accurate to within 100 metres, U = no address point.

kilde
required
string

Code indicating the source of the address point.

Can be empty string "" if not present.

tekniskstandard
required
string

Technical classification code for the location of an address point.

tekstretning
required
string

Orientation for an address in gons, where a full circle is divided into 400 gons.

ddkn_m100
required
string

Identifier of the 100m cell in which the address is located in Det Danske Kvadratnet (DDKN).

ddkn_km1
required
string

Identifier of the 1km cell in which the address is located in Det Danske Kvadratnet (DDKN).

ddkn_km10
required
string

Identifier of the 10km cell in which the address is located in Det Danske Kvadratnet (DDKN).

kommunekode
required
string

Four digit identifier of the municipality in which the address is located.

kommunenavn
required
string

Name of the municipality in which the address is located.

landsdelsnuts3
required
string

NUTS 3 code of the province in which the address is located.

landsdelsnavn
required
string

Name of the province in which the address is located.

regionskode
required
string

Four digit identifier of the region in which the address is located.

regionsnavn
required
string

Name of the region in which the address is located.

afstemningsområdenummer
required
string

Identifier of the polling district in which the address is located.

afstemningsområdenavn
required
string

Unique name of the polling district in which the address is located.

menighedsrådsafstemningsområdenummer
required
string

Identifier of the parish council polling district in which the address is located.

Can be empty string "" if not present.

menighedsrådsafstemningsområdenavn
required
string

Name of the parish council polling district in which the address is located.

Can be empty string "" if not present.

opstillingskredskode
required
string

Identifier of the local electoral district in which the address is located.

opstillingskredsnavn
required
string

Name of the local electoral district in which the address is located.

storkredsnummer
required
string

Identifier of the regional electoral district in which the address is located.

storkredsnavn
required
string

Name of the regional electoral district in which the address is located.

valglandsdelsbogstav
required
string

Letter identifier of the national electoral district in which the address is located: A, B or C.

valglandsdelsnavn
required
string

Name of the national electoral district in which the address is located.

sognekode
required
string

Identifier of the parish in which the address is located.

sognenavn
required
string

Name of the parish in which the address is located.

politikredskode
required
string

Identifier of the police district in which the address is located.

politikredsnavn
required
string

Name of the police district in which the address is located.

retskredskode
required
string

Four digit identifier of the judicial district in which the address is located.

retskredsnavn
required
string

Name of the judicial district in which the address is located.

jordstykke_ejerlavkode
required
string

Identifier of a cadastral unit with a single owner.

Can be empty string "" if not present.

jordstykke_ejerlavnavn
required
string

Name of a cadastral unit with a single owner.

Can be empty string "" if not present.

jordstykke_matrikelnr
required
string

Cadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters.

Can be empty string "" if not present.

jordstykke_esrejendomsnr
required
string

Identifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters.

Can be empty string "" if not present.

ejerlavkode
required
string

Identifier of a cadastral unit with a single owner (deprecated).

Can be empty string "" if not present.

ejerlavnavn
required
string

Name of a cadastral unit with a single owner (deprecated).

Can be empty string "" if not present.

matrikelnr
required
string

Cadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters.

Can be empty string "" if not present.

esrejendomsnr
required
string

Identifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters.

Can be empty string "" if not present.

zone
required
string

Status of the address zone: Byzone, Sommerhusområde or Landzone.

brofast
required
boolean

Indicates whether the address is connected by a bridge.

adgangsadresseid
required
string

Identifier of the access address associated with the address.

Can be empty string "" if not present.

adgangspunktid
required
string

Identifier of the access point for the address.

navngivenvej_id
required
string

Identifier of the named road on which the access address is located.

adgangsadresse_status
required
string

Status of the access address associated with the address: 1 = final address, 3 = provisional address.

Can be empty string "" if not present.

adgangsadresse_darstatus
required
string

Status of the access address indicated by the status code in Danmarks Adresseregister (DAR): 2 = provisional, 3 = valid, 4 = retired, 5 = suspended.

Can be empty string "" if not present.

adgangsadresse_oprettet
required
string

Date and time of the creation of the access address associated with the address.

Can be empty string "" if not present.

adgangsadresse_ændret
required
string

Date and time of the last change to the access address associated with the address.

Can be empty string "" if not present.

adgangsadresse_ikrafttrædelse
required
string

Date and time at which the access address became valid.

Can be empty string "" if not present.

adgangsadresse_nedlagt
required
string

Date and time from which the access address is retired or suspended (may be in the future).

Can be empty string "" if not present.

vejpunkt_id
required
string

Unique identifier of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.

vejpunkt_ændret
required
string

Date and time of the last change in Danmarks Adresseregister (DAR) to the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.

Can be empty string "" if not present.

vejpunkt_kilde
required
string

Source of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.

vejpunkt_nøjagtighed
required
string

Accuracy of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address: A = exact, B = approximate.

vejpunkt_tekniskstandard
required
string

Technical classification code for the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.

vejpunkt_x
required
string

Longitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.

vejpunkt_y
required
string

Latitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.

{
  • "id": "sdfi_0a3f50a5-1d3e-32b8-e044-0003ba298018",
  • "dataset": "sdfi",
  • "country": "Denmark",
  • "country_iso": "DNK",
  • "country_iso_2": "DK",
  • "address": "3",
  • "line_1": "Bakkevej 3, 2. tv",
  • "line_2": "Pindstrup",
  • "language": "da",
  • "latitude": 56.3086,
  • "longitude": 10.4917,
  • "adresse_id": "0a3f50a5-1d3e-32b8-e044-0003ba298018",
  • "kvhx": "07060092___3__2__tv",
  • "kvh": "07060092___3",
  • "adgangsadresse": false,
  • "status": "1",
  • "darstatus": "3",
  • "oprettet": "2000-02-05T20:34:00.000Z",
  • "ændret": "2018-11-02T12:15:00.000Z",
  • "ikrafttrædelse": "2000-02-05T00:00:00.000Z",
  • "nedlagt": "",
  • "vejkode": "0092",
  • "vejnavn": "Bakkevej",
  • "adresseringsvejnavn": "Bakkevej",
  • "husnr": "3",
  • "etage": "2",
  • "dør": "tv",
  • "supplerendebynavn_dagi_id": "580362",
  • "supplerendebynavn": "Pindstrup",
  • "postnr": "8550",
  • "postnrnavn": "Ryomgård",
  • "stormodtagerpostnr": "",
  • "stormodtagerpostnrnavn": "",
  • "betegnelse": "Bakkevej 3, 2. tv, Pindstrup, 8550 Ryomgård",
  • "adressepunktændringsdato": "2010-05-12T00:00:00.000Z",
  • "etrs89koordinat_øst": "592180.45",
  • "etrs89koordinat_nord": "6256980.12",
  • "wgs84koordinat_bredde": 56.3086,
  • "wgs84koordinat_længde": 10.4917,
  • "højde": "40.5",
  • "nøjagtighed": "A",
  • "kilde": "5",
  • "tekniskstandard": "TN",
  • "tekstretning": "200.00",
  • "ddkn_m100": "100m_62569_5921",
  • "ddkn_km1": "1km_6256_592",
  • "ddkn_km10": "10km_625_59",
  • "kommunekode": "0706",
  • "kommunenavn": "Syddjurs",
  • "landsdelsnuts3": "DK042",
  • "landsdelsnavn": "Østjylland",
  • "regionskode": "1082",
  • "regionsnavn": "Region Midtjylland",
  • "afstemningsområdenummer": "05",
  • "afstemningsområdenavn": "Pindstrup",
  • "menighedsrådsafstemningsområdenummer": "",
  • "menighedsrådsafstemningsområdenavn": "",
  • "opstillingskredskode": "0058",
  • "opstillingskredsnavn": "Djurs",
  • "storkredsnummer": "10",
  • "storkredsnavn": "Østjyllands",
  • "valglandsdelsbogstav": "C",
  • "valglandsdelsnavn": "Midtjylland-Nordjylland",
  • "sognekode": "8271",
  • "sognenavn": "Marie Magdalene",
  • "politikredskode": "1461",
  • "politikredsnavn": "Østjyllands Politi",
  • "retskredskode": "1174",
  • "retskredsnavn": "Retten i Randers",
  • "jordstykke_ejerlavkode": "1230651",
  • "jordstykke_ejerlavnavn": "Pindstrup By, Marie Magdalene",
  • "jordstykke_matrikelnr": "7ab",
  • "jordstykke_esrejendomsnr": "",
  • "ejerlavkode": "1230651",
  • "ejerlavnavn": "Pindstrup By, Marie Magdalene",
  • "matrikelnr": "7ab",
  • "esrejendomsnr": "",
  • "zone": "Byzone",
  • "brofast": true,
  • "adgangsadresseid": "0a3f508e-1c2b-32b8-e044-0003ba298018",
  • "adgangspunktid": "0a3f7001-3b2c-32b8-e044-0003ba298018",
  • "navngivenvej_id": "0a3f7002-4c3d-32b8-e044-0003ba298018",
  • "adgangsadresse_status": "1",
  • "adgangsadresse_darstatus": "3",
  • "adgangsadresse_oprettet": "2000-02-05T20:34:00.000Z",
  • "adgangsadresse_ændret": "2018-11-02T12:15:00.000Z",
  • "adgangsadresse_ikrafttrædelse": "2000-02-05T00:00:00.000Z",
  • "adgangsadresse_nedlagt": "",
  • "vejpunkt_id": "0a3f7003-5d4e-32b8-e044-0003ba298018",
  • "vejpunkt_ændret": "2019-03-14T09:20:00.000Z",
  • "vejpunkt_kilde": "Ekstern",
  • "vejpunkt_nøjagtighed": "A",
  • "vejpunkt_tekniskstandard": "V0",
  • "vejpunkt_x": "10.49141",
  • "vejpunkt_y": "56.30833"
}

FR BAN

Standard French Address format from the Base Adresse Nationale (BAN).

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "ban"
country
required
string
Value: "France"

Full country names (ISO 3166)

country_iso
required
string
Value: "FRA"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "FR"

2 letter country code (ISO 3166-1)

language
required
string
Value: "fr"

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

address
required
string

The house number of the address (numero), without any suffix.

Can be empty string "" if not present.

line_1
required
string or null

First address line (house number, suffix, and street name).

Can be null if not present.

line_2
required
string or null

Second address line (postcode and municipality name).

Can be null if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

id_fantoir
required
string or null

FANTOIR street identifier

numero
required
integer or null

House number

rep
required
string or null

House number suffix / répétition (bis, ter, quater, etc.)

nom_voie
required
string

Street name

code_postal
required
string or null

5-digit postal code

code_insee
required
string

INSEE commune code (2-digit département + 3-digit commune)

nom_commune
required
string

Municipality name

code_insee_ancienne_commune
required
string or null

INSEE code of the pre-fusion commune (for merged municipalities)

nom_ancienne_commune
required
string or null

Name of the pre-fusion commune (for merged municipalities)

x
required
string or null

Lambert 93 easting coordinate

y
required
string or null

Lambert 93 northing coordinate

lon
required
string or null

Longitude (WGS84) as returned from source data

lat
required
string or null

Latitude (WGS84) as returned from source data

type_position
required
string or null

Positional accuracy type (entrée, bâtiment, parcelle, délivrance postale, etc.)

alias
required
string or null

Address alias

nom_ld
required
string or null

Lieu-dit (named place) label

libelle_acheminement
required
string or null

Postal routing label

nom_afnor
required
string or null

AFNOR-normalised street name

source_position
required
string or null

Source of position data (commune, IGN, etc.)

source_nom_voie
required
string or null

Source of street name data

certification_commune
required
boolean or null

Whether the municipality has certified this address

cad_parcelles
required
string or null

Cadastral parcel reference(s)

{
  • "id": "ban_01002_w4ld4h_00006",
  • "dataset": "ban",
  • "country": "France",
  • "country_iso": "FRA",
  • "country_iso_2": "FR",
  • "language": "fr",
  • "address": "6",
  • "line_1": "6 place du Pese Lait",
  • "line_2": "01640 L'Abergement-de-Varey",
  • "latitude": 46.005447,
  • "longitude": 5.425179,
  • "id_fantoir": null,
  • "numero": 6,
  • "rep": null,
  • "nom_voie": "Place du Pese Lait",
  • "code_postal": "01640",
  • "code_insee": "01002",
  • "nom_commune": "L'Abergement-de-Varey",
  • "code_insee_ancienne_commune": null,
  • "nom_ancienne_commune": null,
  • "x": "887643.67",
  • "y": "6547960.53",
  • "lon": "5.425179",
  • "lat": "46.005447",
  • "type_position": "entrée",
  • "alias": null,
  • "nom_ld": null,
  • "libelle_acheminement": "ABERGEMENT-DE-VAREY (L )",
  • "nom_afnor": "PLACE DU PESE LAIT",
  • "source_position": "commune",
  • "source_nom_voie": "commune",
  • "certification_commune": true,
  • "cad_parcelles": "01002000AE0005"
}

JP UPU

Standard Japanese Address format from the Japan UPU address file.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "upujp"

Indicates the provenance of an address

country
required
string
Value: "Japan"

Full country names (ISO 3166)

country_iso
required
string
Value: "JPN"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "JP"

2 letter country code (ISO 3166-1)

language
required
string
Enum: "ja" "en"

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

script
required
string
Enum: "Hani" "Hira" "Latn"

ISO 15924 script of the address elements.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

address
required
string

Address / House Number uniquely identifying the address along the specified street.

Can be empty string "" if not present.

line_1
required
string

The block or house number alone, identical to address. There is no line_2 or line_3; build the rest of the address from prefecture, city, district, neighbourhood and building_name.

Can be empty string "" if not present.

building_name
required
string

Preferred building name.

Can be empty string "" if not present.

neighbourhood
required
string

Preferred neighbourhood name.

Can be empty string "" if not present.

district
required
string

Preferred district name.

Can be empty string "" if not present.

city
required
string

Preferred city name.

Can be empty string "" if not present.

prefecture
required
string

Preferred prefecture name.

Can be empty string "" if not present.

postcode
required
string

Preferred postal code.

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

org_id
required
string

The unique identifier of an organisation.

Can be empty string "" if not present.

required
string or number

Indicates the type of organisation.

Can be empty string "" if not present.

required
string or number

Indicates the sub-type of the organisation.

Can be empty string "" if not present.

org_loc_id
required
string

Locality identifier for the organisation.

Can be empty string "" if not present.

org_dis_id
required
string

District identifier for the organisation.

Can be empty string "" if not present.

org_nei_id
required
string

Neighbourhood identifier for the organisation.

Can be empty string "" if not present.

org_org_id
required
string

Associated organisation identifier for the organisation.

Can be empty string "" if not present.

org_name
required
string

Name of the organisation.

Can be empty string "" if not present.

org_name_trans
required
string

Translated name of the organisation in Latin script.

Can be empty string "" if not present.

org_loc_sfx
required
string

Suffix of the locality for the organisation.

Can be empty string "" if not present.

org_loc_sfx_trans
required
string

Translated suffix of the locality for the organisation in Latin script.

Can be empty string "" if not present.

org_adr
required
string

Address of the organisation.

Can be empty string "" if not present.

org_adr_trans
required
string

Translated address of the organisation in Latin script.

Can be empty string "" if not present.

required
string or number

Indicates whether the organisation has a post office box.

Can be empty string "" if not present.

org_po_start
required
string

Post office box number or start of the post office box range associated with the organisation.

Can be empty string "" if not present.

org_po_end
required
string

End of the post office box range associated with the organisation.

Can be empty string "" if not present.

org_dsc
required
string

Additional information about the organisation.

Can be empty string "" if not present.

org_dsc_trans
required
string

Translated additional information about the organisation in Latin script.

Can be empty string "" if not present.

org_pcode
required
string

Postal code for the organisation.

Can be empty string "" if not present.

org_pcode_fin
required
string

Final postal code for the organisation.

Can be empty string "" if not present.

org_script
required
string

Script used for the organisation name.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

org_language
required
string

Language used for the organisation name.

Can be empty string "" if not present.

str_id
required
string

Identifier of the street (not unique).

Can be empty string "" if not present.

str_key
required
string

Permanent identifier of the street.

Can be empty string "" if not present.

str_loc_id
required
string

Locality identifier for the street.

Can be empty string "" if not present.

str_dis_id
required
string

District identifier for the street.

Can be empty string "" if not present.

str_nei_id
required
string

Neighbourhood identifier for the street.

Can be empty string "" if not present.

str_org_id
required
string

Associated organisation identifier for the street.

Can be empty string "" if not present.

str_pfx
required
string

Prefix of the street name.

Can be empty string "" if not present.

str_pfx_trans
required
string

Translated prefix of the street name in Latin script.

Can be empty string "" if not present.

str_qlf_pre
required
string

Preceding qualifier of the street name.

Can be empty string "" if not present.

str_qlf_pre_trans
required
string

Translated preceding qualifier of the street name in Latin script.

Can be empty string "" if not present.

str_qlf_suc
required
string

Succeeding qualifier of the street name.

Can be empty string "" if not present.

str_qlf_suc_trans
required
string

Translated succeeding qualifier of the street name in Latin script.

Can be empty string "" if not present.

str_name
required
string

Name of the street.

Can be empty string "" if not present.

str_name_trans
required
string

Translated name of the street in Latin script.

Can be empty string "" if not present.

str_loc_sfx
required
string

Suffix of the locality for the street.

Can be empty string "" if not present.

str_loc_sfx_trans
required
string

Translated suffix of the locality for the street in Latin script.

Can be empty string "" if not present.

str_type
required
string

Type of the street.

Can be empty string "" if not present.

str_type_trans
required
string

Translated type of the street in Latin script.

Can be empty string "" if not present.

str_type_abv
required
string

Abbreviation of the street type.

Can be empty string "" if not present.

str_type_abv_trans
required
string

Translated abbreviation of the street type in Latin script.

Can be empty string "" if not present.

str_adr_num_key
required
string

Permanent identifier of the address.

Can be empty string "" if not present.

required
string or number

Lowest address number on the street.

Can be empty string "" if not present.

str_from_unit
required
string

Lowest unit number on the street.

Can be empty string "" if not present.

str_from_alph
required
string

Extension of the lowest address number on the street.

Can be empty string "" if not present.

required
string or number

Highest address number on the street.

Can be empty string "" if not present.

str_to_unit
required
string

Highest unit number on the street.

Can be empty string "" if not present.

str_to_alph
required
string

Extension of the highest address number on the street.

Can be empty string "" if not present.

required
string or number

Indicates whether the address range for this street contains even numbers, odd numbers, or both.

Can be empty string "" if not present.

str_dsc
required
string

Additional information about the street.

Can be empty string "" if not present.

str_dsc_trans
required
string

Translated additional information about the street in Latin script.

Can be empty string "" if not present.

str_blg_id
required
string

Identifier of the building for the street.

Can be empty string "" if not present.

str_blg_name
required
string

Name of the building for the street.

Can be empty string "" if not present.

str_blg_name_trans
required
string

Translated name of the building for the street in Latin script.

Can be empty string "" if not present.

str_blg_type
required
string

Type of the building for the street.

Can be empty string "" if not present.

str_blg_type_trans
required
string

Translated type of the building for the street in Latin script.

Can be empty string "" if not present.

str_blg_dsc
required
string

Additional information about the building for the street.

Can be empty string "" if not present.

str_blg_dsc_trans
required
string

Translated additional information about the building for the street in Latin script.

Can be empty string "" if not present.

str_ref_str_id
required
string

Identifier of the associated street.

Can be empty string "" if not present.

str_pcode
required
string

Postal code for the street.

Can be empty string "" if not present.

str_script
required
string

Script used for the street name.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

str_language
required
string

Language used for the street name.

Can be empty string "" if not present.

sub_dis_id
required
string

Unique identifier of the district.

Can be empty string "" if not present.

sub_dis_key
required
string

Permanent identifier of the district.

Can be empty string "" if not present.

sub_loc_id
required
string

Locality identifier for the subdivision.

Can be empty string "" if not present.

sub_loc_sfx
required
string

Suffix of the locality for the subdivision.

Can be empty string "" if not present.

sub_loc_sfx_trans
required
string

Translated suffix of the locality for the subdivision in Latin script.

Can be empty string "" if not present.

sub_dis_name
required
string

Name of the district.

Can be empty string "" if not present.

sub_dis_name_trans
required
string

Translated name of the district in Latin script.

Can be empty string "" if not present.

sub_dis_sfx
required
string

Suffix of the district.

Can be empty string "" if not present.

sub_dis_sfx_trans
required
string

Translated suffix of the district in Latin script.

Can be empty string "" if not present.

sub_dis_dsc
required
string

Additional information about the district.

Can be empty string "" if not present.

sub_dis_dsc_trans
required
string

Translated additional information about the district in Latin script.

Can be empty string "" if not present.

sub_dis_pcode
required
string

Postal code for the district.

Can be empty string "" if not present.

sub_dis_pcode_fin
required
string

Final postal code for the district.

Can be empty string "" if not present.

sub_nei_id
required
string

Identifier of the neighbourhood.

Can be empty string "" if not present.

sub_nei_key
required
string

Permanent identifier of the neighbourhood.

Can be empty string "" if not present.

sub_nei_name
required
string

Name of the neighbourhood.

Can be empty string "" if not present.

sub_nei_name_trans
required
string

Translated name of the neighbourhood in Latin script.

Can be empty string "" if not present.

sub_nei_sfx
required
string

Suffix of the neighbourhood.

Can be empty string "" if not present.

sub_nei_sfx_trans
required
string

Translated suffix of the neighbourhood in Latin script.

Can be empty string "" if not present.

sub_nei_zone_from
required
string

Start of the range of zone numbers to which the neighbourhood postal code corresponds.

Can be empty string "" if not present.

sub_nei_zone_to
required
string

End of the range of zone numbers to which the neighbourhood postal code corresponds.

Can be empty string "" if not present.

sub_nei_dsc
required
string

Additional information about the neighbourhood.

Can be empty string "" if not present.

sub_nei_dsc_trans
required
string

Translated additional information about the neighbourhood in Latin script.

Can be empty string "" if not present.

sub_nei_pcode
required
string

Postal code for the neighbourhood.

Can be empty string "" if not present.

sub_script
required
string

Script used for the subdivision names.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

sub_language
required
string

Language used for the subdivision names.

Can be empty string "" if not present.

loc_id
required
string

Unique identifier of the locality.

Can be empty string "" if not present.

loc_key
required
string

Permanent identifier of the locality.

Can be empty string "" if not present.

loc_adm1_id
required
string

Identifier of administrative division 1.

Can be empty string "" if not present.

loc_adm1_key
required
string

Permanent identifier of administrative division 1.

Can be empty string "" if not present.

loc_adm1_name
required
string

Name of administrative division 1.

Can be empty string "" if not present.

loc_adm1_name_trans
required
string

Translated name of administrative division 1 in Latin script.

Can be empty string "" if not present.

loc_adm1_sfx
required
string

Suffix of administrative division 1.

Can be empty string "" if not present.

loc_adm1_sfx_trans
required
string

Translated suffix of administrative division 1 in Latin script.

Can be empty string "" if not present.

loc_adm1_abv
required
string

Abbreviation of administrative division 1.

Can be empty string "" if not present.

loc_adm1_abv_trans
required
string

Translated abbreviation of administrative division 1 in Latin script.

Can be empty string "" if not present.

loc_adm2_id
required
string

Identifier of administrative division 2.

Can be empty string "" if not present.

loc_adm2_key
required
string

Permanent identifier of administrative division 2.

Can be empty string "" if not present.

loc_adm2_name
required
string

Name of administrative division 2.

Can be empty string "" if not present.

loc_adm2_name_trans
required
string

Translated name of administrative division 2 in Latin script.

Can be empty string "" if not present.

loc_adm2_sfx
required
string

Suffix of administrative division 2.

Can be empty string "" if not present.

loc_adm2_sfx_trans
required
string

Translated suffix of administrative division 2 in Latin script.

Can be empty string "" if not present.

loc_adm2_abv
required
string

Abbreviation of administrative division 2.

Can be empty string "" if not present.

loc_adm2_abv_trans
required
string

Translated abbreviation of administrative division 2 in Latin script.

Can be empty string "" if not present.

loc_adm3_id
required
string

Identifier of administrative division 3.

Can be empty string "" if not present.

loc_adm3_key
required
string

Permanent identifier of administrative division 3.

Can be empty string "" if not present.

loc_adm3_name
required
string

Name of administrative division 3.

Can be empty string "" if not present.

loc_adm3_name_trans
required
string

Translated name of administrative division 3 in Latin script.

Can be empty string "" if not present.

loc_adm3_sfx
required
string

Suffix of administrative division 3.

Can be empty string "" if not present.

loc_adm3_sfx_trans
required
string

Translated suffix of administrative division 3 in Latin script.

Can be empty string "" if not present.

loc_adm3_abv
required
string

Abbreviation of administrative division 3.

Can be empty string "" if not present.

loc_adm3_abv_trans
required
string

Translated abbreviation of administrative division 3 in Latin script.

Can be empty string "" if not present.

loc_name
required
string

Name of the locality.

Can be empty string "" if not present.

loc_name_trans
required
string

Translated name of the locality in Latin script.

Can be empty string "" if not present.

loc_sfx
required
string

Suffix of the locality.

Can be empty string "" if not present.

loc_sfx_trans
required
string

Translated suffix of the locality in Latin script.

Can be empty string "" if not present.

loc_pcode
required
string

Postal code of the locality.

Can be empty string "" if not present.

loc_pcode_fin
required
string

Final postal code of the locality.

Can be empty string "" if not present.

loc_dsc
required
string

Additional information about the locality.

Can be empty string "" if not present.

loc_dsc_trans
required
string

Translated additional information about the locality in Latin script.

Can be empty string "" if not present.

loc_script
required
string

Script used for the locality names.

Hani = Kanji, Hira = Hiragana, Latn = Latin.

Can be empty string "" if not present.

loc_language
required
string

Language used for the locality names.

Can be empty string "" if not present.

{
  • "id": "upujp_2ry6tOmv4gOAWU2v5CVxBw|12-2",
  • "dataset": "upujp",
  • "country": "Japan",
  • "country_iso": "JPN",
  • "country_iso_2": "JP",
  • "language": "ja",
  • "script": "Hani",
  • "address": "12-2",
  • "line_1": "12-2",
  • "building_name": "",
  • "neighbourhood": "神楽六条十三丁目",
  • "district": "",
  • "city": "旭川市",
  • "prefecture": "北海道",
  • "postcode": "070-8006",
  • "latitude": "",
  • "longitude": "",
  • "org_id": "",
  • "org_type_ind": "",
  • "org_sub_type_ind": "",
  • "org_loc_id": "",
  • "org_dis_id": "",
  • "org_nei_id": "",
  • "org_org_id": "",
  • "org_name": "",
  • "org_name_trans": "",
  • "org_loc_sfx": "",
  • "org_loc_sfx_trans": "",
  • "org_adr": "",
  • "org_adr_trans": "",
  • "org_po_ind": "",
  • "org_po_start": "",
  • "org_po_end": "",
  • "org_dsc": "",
  • "org_dsc_trans": "",
  • "org_pcode": "",
  • "org_pcode_fin": "",
  • "org_script": "",
  • "org_language": "",
  • "str_id": "0",
  • "str_key": "",
  • "str_loc_id": "914161",
  • "str_dis_id": "",
  • "str_nei_id": "194855",
  • "str_org_id": "",
  • "str_pfx": "",
  • "str_pfx_trans": "",
  • "str_qlf_pre": "",
  • "str_qlf_pre_trans": "",
  • "str_qlf_suc": "",
  • "str_qlf_suc_trans": "",
  • "str_name": "",
  • "str_name_trans": "",
  • "str_loc_sfx": "",
  • "str_loc_sfx_trans": "",
  • "str_type": "",
  • "str_type_trans": "",
  • "str_type_abv": "",
  • "str_type_abv_trans": "",
  • "str_adr_num_key": "",
  • "str_from_num": 2,
  • "str_from_unit": "12",
  • "str_from_alph": "",
  • "str_to_num": 2,
  • "str_to_unit": "12",
  • "str_to_alph": "",
  • "str_evenodd": 6,
  • "str_dsc": "",
  • "str_dsc_trans": "",
  • "str_blg_id": "49928324",
  • "str_blg_name": "",
  • "str_blg_name_trans": "",
  • "str_blg_type": "番",
  • "str_blg_type_trans": "BAN",
  • "str_blg_dsc": "",
  • "str_blg_dsc_trans": "",
  • "str_ref_str_id": "",
  • "str_pcode": "070-8006",
  • "str_script": "",
  • "str_language": "",
  • "sub_dis_id": "",
  • "sub_dis_key": "",
  • "sub_loc_id": "914161",
  • "sub_loc_sfx": "",
  • "sub_loc_sfx_trans": "",
  • "sub_dis_name": "",
  • "sub_dis_name_trans": "",
  • "sub_dis_sfx": "",
  • "sub_dis_sfx_trans": "",
  • "sub_dis_dsc": "",
  • "sub_dis_dsc_trans": "",
  • "sub_dis_pcode": "",
  • "sub_dis_pcode_fin": "",
  • "sub_nei_id": "194855",
  • "sub_nei_key": "",
  • "sub_nei_name": "神楽六条十三丁目",
  • "sub_nei_name_trans": "KAGURA 6JO 13-CHOME",
  • "sub_nei_sfx": "",
  • "sub_nei_sfx_trans": "G",
  • "sub_nei_zone_from": "",
  • "sub_nei_zone_to": "",
  • "sub_nei_dsc": "",
  • "sub_nei_dsc_trans": "",
  • "sub_nei_pcode": "070-8006",
  • "sub_script": "Hani",
  • "sub_language": "ja",
  • "loc_id": "914161",
  • "loc_key": "3265925806",
  • "loc_adm1_id": "12010",
  • "loc_adm1_key": "JP.HK",
  • "loc_adm1_name": "北海道",
  • "loc_adm1_name_trans": "HOKKAIDO",
  • "loc_adm1_sfx": "",
  • "loc_adm1_sfx_trans": "",
  • "loc_adm1_abv": "",
  • "loc_adm1_abv_trans": "",
  • "loc_adm2_id": "",
  • "loc_adm2_key": "",
  • "loc_adm2_name": "",
  • "loc_adm2_name_trans": "",
  • "loc_adm2_sfx": "",
  • "loc_adm2_sfx_trans": "",
  • "loc_adm2_abv": "",
  • "loc_adm2_abv_trans": "",
  • "loc_adm3_id": "",
  • "loc_adm3_key": "",
  • "loc_adm3_name": "",
  • "loc_adm3_name_trans": "",
  • "loc_adm3_sfx": "",
  • "loc_adm3_sfx_trans": "",
  • "loc_adm3_abv": "",
  • "loc_adm3_abv_trans": "",
  • "loc_name": "旭川市",
  • "loc_name_trans": "ASAHIKAWA",
  • "loc_sfx": "",
  • "loc_sfx_trans": "-SHI",
  • "loc_pcode": "070-0000",
  • "loc_pcode_fin": "",
  • "loc_dsc": "",
  • "loc_dsc_trans": "",
  • "loc_script": "Hani",
  • "loc_language": "ja"
}

KR MOIS

Standard South Korean Address format from the Korean Ministry of the Interior and Safety (MOIS).

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "mois"

Dataset the address originates from.

country
required
string
Value: "South Korea"

Full country names (ISO 3166)

country_iso
required
string
Value: "KOR"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "KR"

2 letter country code (ISO 3166-1)

language
required
string
Value: "ko"

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

address
required
string

Jibeon (land lot) number: 지번본번_번지 and 지번부번_호 joined by a hyphen.

Can be empty string "" if not present.

line_1
required
string

First address line.

Can be empty string "" if not present.

line_2
required
string

Second address line.

Can be empty string "" if not present.

city
required
string

Preferred city name.

Can be empty string "" if not present.

province
required
string

Preferred province name.

Can be empty string "" if not present.

법정읍면동명
required
string

Legal town name.

Can be empty string "" if not present.

법정동코드
required
string

Legal district code.

Can be empty string "" if not present.

법정리명
required
string

Legal name.

Can be empty string "" if not present.

비고1
required
string

Note 1.

Can be empty string "" if not present.

비고2
required
string

Note 2.

Can be empty string "" if not present.

변동전도로명주소
required
string

Changed street name address.

Can be empty string "" if not present.

변경이력정보
required
string

Change history information.

Can be empty string "" if not present.

변경이력사유
required
string

Change history reason.

Can be empty string "" if not present.

변경전_도로명주소
required
string

Previous road name address.

Can be empty string "" if not present.

변경사유
required
string

Change reason.

Can be empty string "" if not present.

변경사유코드
required
string

Change reason code.

Can be empty string "" if not present.

층일련번호
required
string

Floor serial number.

Can be empty string "" if not present.

층명칭
required
string

Floor name.

Can be empty string "" if not present.

대표지번여부
required
string

Is representative address.

Can be empty string "" if not present.

대표여부
required
string

Is representative.

Can be empty string "" if not present.

다량배달처명
required
string

Bulk delivery location name.

Can be empty string "" if not present.

동일련번호
required
string

Building serial number.

Can be empty string "" if not present.

동명칭
required
string

Building name.

Can be empty string "" if not present.

도로명
required
string

Road name.

Can be empty string "" if not present.

도로명_로마자
required
string

Romanised road name.

Can be empty string "" if not present.

도로명번호
required
string

Road name number.

Can be empty string "" if not present.

도로명코드
required
string

Road name code.

Can be empty string "" if not present.

도로명코드_고시일자
required
string

Road name code creation date.

Can be empty string "" if not present.

도로명코드_말소일자
required
string

Road name code deletion date.

Can be empty string "" if not present.

읍면동구분
required
string

Town classification.

Can be empty string "" if not present.

읍면동일련번호
required
string

Town serial number.

Can be empty string "" if not present.

읍면동코드
required
string

Town code.

Can be empty string "" if not present.

읍면동명
required
string

Town name.

Can be empty string "" if not present.

읍면동명_로마자
required
string

Romanised town name.

Can be empty string "" if not present.

건축물대장_건물명
required
string

Building name in building register.

Can be empty string "" if not present.

건물본번
required
string

Building number.

Can be empty string "" if not present.

건물부번
required
string

Building sub-number.

Can be empty string "" if not present.

건물관리번호
required
string

Building management number.

Can be empty string "" if not present.

기초구역번호
required
string

Basic area number.

Can be empty string "" if not present.

공동주택여부
required
string

Is apartment.

Can be empty string "" if not present.

고시일자
required
string

Creation date.

Can be empty string "" if not present.

관리번호
required
string

Management number.

Can be empty string "" if not present.

행정동코드
required
string

Administrative district code.

Can be empty string "" if not present.

행정동명
required
string

Administrative district name.

Can be empty string "" if not present.

호일련번호
required
string

Unit serial number.

Can be empty string "" if not present.

호명칭
required
string

Unit name.

Can be empty string "" if not present.

호접미사일련번호
required
string

Unit suffix serial number.

Can be empty string "" if not present.

호접미사명칭
required
string

Unit suffix name.

Can be empty string "" if not present.

이동사유코드
required
string

Movement reason code.

Can be empty string "" if not present.

일련번호
required
string

Serial number.

Can be empty string "" if not present.

지번일련번호
required
string

Address serial number.

Can be empty string "" if not present.

지번본번_번지
required
string

Jibeon (land lot) main number.

Can be empty string "" if not present.

지번부번_호
required
string

Jibeon (land lot) sub-number.

Can be empty string "" if not present.

지하구분
required
string

Is basement.

Can be empty string "" if not present.

지하여부
required
string

Level (ground level, underground, aerial).

Can be empty string "" if not present.

산여부
required
string

Is mountain.

Can be empty string "" if not present.

상위도로명
required
string

Upper road name.

Can be empty string "" if not present.

상위도로명번호
required
string

Upper road name number.

Can be empty string "" if not present.

상세건물명
required
string

Detailed building name.

Can be empty string "" if not present.

상세주소_부여여부
required
string

Whether detailed address assigned.

Can be empty string "" if not present.

상세주소여부
required
string

Whether detailed address exists.

Can be empty string "" if not present.

사용여부
required
string

In use.

Can be empty string "" if not present.

시도명
required
string

City name.

Can be empty string "" if not present.

시도명_로마자
required
string

Romanised city name.

Can be empty string "" if not present.

시군구_건물명
required
string

District (sigungu) building name, as recorded in the address DB (주소DB).

Can be empty string "" if not present.

시군구코드
required
string

District code.

Can be empty string "" if not present.

시군구명
required
string

District name.

Can be empty string "" if not present.

시군구명_로마자
required
string

Romanised district name.

Can be empty string "" if not present.

시군구용_건물명
required
string

District (sigungu) building name, as recorded in the building and PO box DBs (건물DB, 사서함주소DB).

Can be empty string "" if not present.

우편일련번호
required
string

Postal sequence number.

Can be empty string "" if not present.

우편번호
required
string

Postal code.

Can be empty string "" if not present.

우편번호_일련번호
required
string

Postal code serial number.

Can be empty string "" if not present.

영문_법정리명
required
string

English legal name.

Can be empty string "" if not present.

영문읍면동명
required
string

English town name.

Can be empty string "" if not present.

영문_법정읍면동명
required
string

English legal town name.

Can be empty string "" if not present.

영문도로명
required
string

English road name.

Can be empty string "" if not present.

영문시도명
required
string

English city name.

Can be empty string "" if not present.

영문시군구명
required
string

English district name.

Can be empty string "" if not present.

{
  • "id": "mois_hM9Ur94A6Wxd8rFfQWHjKQ",
  • "dataset": "mois",
  • "country": "South Korea",
  • "country_iso": "KOR",
  • "country_iso_2": "KR",
  • "language": "ko",
  • "address": "108-21",
  • "line_1": "종로구 청운동 자하문로 108-21",
  • "line_2": "청운빌딩 100동 1호",
  • "city": "서울특별시",
  • "province": "서울특별시",
  • "법정읍면동명": "청운동",
  • "법정동코드": "1111010100",
  • "법정리명": "",
  • "비고1": "",
  • "비고2": "",
  • "변동전도로명주소": "",
  • "변경이력정보": "",
  • "변경이력사유": "",
  • "변경전_도로명주소": "",
  • "변경사유": "",
  • "변경사유코드": "",
  • "층일련번호": "",
  • "층명칭": "",
  • "대표지번여부": "",
  • "대표여부": "",
  • "다량배달처명": "",
  • "동일련번호": "",
  • "동명칭": "",
  • "도로명": "자하문로",
  • "도로명_로마자": "",
  • "도로명번호": "3100012",
  • "도로명코드": "111103100012",
  • "도로명코드_고시일자": "20100702",
  • "도로명코드_말소일자": "",
  • "읍면동구분": "1",
  • "읍면동일련번호": "01",
  • "읍면동코드": "101",
  • "읍면동명": "청운동",
  • "읍면동명_로마자": "",
  • "건축물대장_건물명": "",
  • "건물본번": "100",
  • "건물부번": "1",
  • "건물관리번호": "1111010100101080021031434",
  • "기초구역번호": "03047",
  • "공동주택여부": "0",
  • "고시일자": "",
  • "관리번호": "",
  • "행정동코드": "1111051500",
  • "행정동명": "청운효자동",
  • "호일련번호": "",
  • "호명칭": "",
  • "호접미사일련번호": "",
  • "호접미사명칭": "",
  • "이동사유코드": "",
  • "일련번호": "",
  • "지번일련번호": "",
  • "지번본번_번지": "108",
  • "지번부번_호": "21",
  • "지하구분": "",
  • "지하여부": "0",
  • "산여부": "0",
  • "상위도로명": "",
  • "상위도로명번호": "",
  • "상세건물명": "",
  • "상세주소_부여여부": "",
  • "상세주소여부": "0",
  • "사용여부": "0",
  • "시도명": "서울특별시",
  • "시도명_로마자": "",
  • "시군구_건물명": "",
  • "시군구코드": "11110",
  • "시군구명": "종로구",
  • "시군구명_로마자": "",
  • "시군구용_건물명": "청운빌딩",
  • "우편일련번호": "",
  • "우편번호": "03047",
  • "우편번호_일련번호": "",
  • "영문_법정리명": "",
  • "영문읍면동명": "Cheongun-dong",
  • "영문_법정읍면동명": "",
  • "영문도로명": "Jahamun-ro",
  • "영문시도명": "Seoul",
  • "영문시군구명": "Jongno-gu"
}

NL Kadaster

Standard Dutch Address format from Kadaster BAG 2.0.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "kadaster"

Dataset the address originates from.

country
required
string
Value: "Netherlands"

Full country names (ISO 3166)

country_iso
required
string
Value: "NLD"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Value: "NL"

2 letter country code (ISO 3166-1)

line_1
required
string

First address line: street name followed by house number.

Empty string "" if not available.

language
required
string
Value: "nl"

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

address
required
string

House number, uniquely identifying the address along the specified street. Combines huisnummer, huisletter and huisnummertoevoeging.

Empty string "" if not available.

identificatie
required
string

The unique identifier of a BAG verblijfsobject.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

gebruiksdoel
required
string

The purpose of use of the verblijfsobject. E.g. woonfunctie (residential), kantoorfunctie (office), winkelfunctie (retail).

oppervlakte
required
integer

The floor area of the verblijfsobject in square metres.

status
required
string

Verblijfsobject status. E.g. Verblijfsobject in gebruik (in use).

geconstateerd
required
boolean

Indicates that a verblijfsobject has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.

documentdatum
required
string <date-time>

Date on which the verblijfsobject source document was created.

documentnummer
required
string

The unique identifier of the verblijfsobject source document.

required
string or integer
begin_geldigheid
required
string

The time at which a version of a verblijfsobject is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.

Empty string "" if not available.

eind_geldigheid
required
string

The time at which a version of a verblijfsobject is no longer valid in reality. ISO 8601 timestamp.

Empty string "" if not available.

tijdstip_registratie
required
string

The time at which a version of a verblijfsobject is registered by the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

eind_registratie
required
string

The time at which a version of a verblijfsobject is no longer valid according to the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

tijdstip_registratie_lv
required
string

The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

tijdstip_eind_registratie_lv
required
string

The time at which a version of a verblijfsobject is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_identificatie
required
string

The unique identifier of a BAG nummeraanduidingen object.

Empty string "" if not available.

nummeraanduidingen_huisnummer
required
string

The house number assigned to a nummeraanduiding object by or on behalf of the municipal council.

Empty string "" if not available.

nummeraanduidingen_huisnummertoevoeging
required
string

A further addition to a house number, or to a combination of house number and house letter, granted by or on behalf of the municipal council with regard to a nummeraanduiding object.

Empty string "" if not available.

nummeraanduidingen_huisletter
required
string

An addition to a house number in the form of an alphanumeric character assigned by or on behalf of the municipal council with regard to a nummeraanduiding object.

Empty string "" if not available.

nummeraanduidingen_postcode
required
string

A code determined by PostNL associated with a specific combination of a street name and a house number. Normalised to 1234 AB.

Empty string "" if not available.

nummeraanduidingen_type_adresseerbaar_object
required
string

The nature of the nummeraanduiding object. Currently always Verblijfsobject.

Empty string "" if not available.

nummeraanduidingen_status
required
string

The status of the nummeraanduiding object. E.g. Naamgeving uitgegeven (name issued), Naamgeving ingetrokken (name withdrawn).

Empty string "" if not available.

nummeraanduidingen_geconstateerd
required
boolean

Indicates that a nummeraanduidingen object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.

nummeraanduidingen_documentdatum
required
string

Date on which the nummeraanduidingen object source document was created. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_documentnummer
required
string

The unique identifier of the nummeraanduidingen object source document.

Empty string "" if not available.

required
string or integer
nummeraanduidingen_begin_geldigheid
required
string

The time at which a version of a nummeraanduidingen object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_eind_geldigheid
required
string

The time at which a version of a nummeraanduidingen object is no longer valid in reality. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_tijdstip_registratie
required
string

The time at which a version of a nummeraanduidingen object is registered by the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_eind_registratie
required
string

The time at which a version of a nummeraanduidingen object is no longer valid according to the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_tijdstip_registratie_lv
required
string

The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

nummeraanduidingen_tijdstip_eind_registratie_lv
required
string

The time at which a version of a nummeraanduidingen object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

pand_identificatie
required
string

The unique identifier of a BAG pand object.

Empty string "" if not available.

required
string or integer
pand_status
required
string

The status of the pand object. E.g. Pand in gebruik (building in use).

Empty string "" if not available.

pand_geconstateerd
required
boolean

Indicates that a pand object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.

pand_documentdatum
required
string

Date on which the pand object source document was created. ISO 8601 timestamp.

Empty string "" if not available.

pand_documentnummer
required
string

The unique identifier of the pand object source document.

Empty string "" if not available.

required
string or integer
pand_begin_geldigheid
required
string

The time at which a version of a pand object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.

Empty string "" if not available.

pand_eind_geldigheid
required
string

The time at which a version of a pand object is no longer valid in reality. ISO 8601 timestamp.

Empty string "" if not available.

pand_tijdstip_registratie
required
string

The time at which a version of a pand object is registered by the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

pand_eind_registratie
required
string

The time at which a version of a pand object is no longer valid according to the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

pand_tijdstip_registratie_lv
required
string

The time at which a version of a pand object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

pand_tijdstip_eind_registratie_lv
required
string

The time at which a version of a pand object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_identificatie
required
string

The unique identifier of a BAG openbare ruimte object.

Empty string "" if not available.

openbare_ruimte_naam
required
string

The name assigned to an openbare ruimte object by or on behalf of the municipal council. Usually the street name.

Empty string "" if not available.

openbare_ruimte_type
required
string

The nature of the openbare ruimte object. E.g. Weg (road), Water, Spoorbaan (railway).

Empty string "" if not available.

openbare_ruimte_status
required
string

The status of the openbare ruimte object. E.g. Naamgeving uitgegeven (name issued).

Empty string "" if not available.

openbare_ruimte_geconstateerd
required
boolean

Indicates that an openbare ruimte object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.

openbare_ruimte_documentdatum
required
string

Date on which the openbare ruimte object source document was created. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_documentnummer
required
string

The unique identifier of the openbare ruimte object source document.

Empty string "" if not available.

required
string or integer
openbare_ruimte_begin_geldigheid
required
string

The time at which a version of an openbare ruimte object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_eind_geldigheid
required
string

The time at which a version of an openbare ruimte object is no longer valid in reality. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_tijdstip_registratie
required
string

The time at which a version of an openbare ruimte object is registered by the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_eind_registratie
required
string

The time at which a version of an openbare ruimte object is no longer valid according to the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_tijdstip_registratie_lv
required
string

The time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_tijdstip_eind_registratie_lv
required
string

The time at which a version of an openbare ruimte object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

openbare_ruimte_verkorte_naam
required
string

An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters.

Empty string "" if not available.

woonplaats_identificatie
required
string

The unique identifier of a BAG woonplaats object.

Empty string "" if not available.

woonplaats_naam
required
string

The name assigned to a woonplaats object by or on behalf of the municipal council. The town or city name.

Empty string "" if not available.

woonplaats_status
required
string

The status of the woonplaats object. E.g. Woonplaats aangewezen (place of residence designated).

Empty string "" if not available.

woonplaats_geconstateerd
required
boolean

Indicates that a woonplaats object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.

woonplaats_documentdatum
required
string

Date on which the woonplaats object source document was created. ISO 8601 timestamp.

Empty string "" if not available.

woonplaats_documentnummer
required
string

The unique identifier of the woonplaats object source document.

Empty string "" if not available.

required
string or integer
woonplaats_begin_geldigheid
required
string

The time at which a version of a woonplaats object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.

Empty string "" if not available.

woonplaats_eind_geldigheid
required
string

The time at which a version of a woonplaats object is no longer valid in reality. ISO 8601 timestamp.

Empty string "" if not available.

woonplaats_tijdstip_registratie
required
string

The time at which a version of a woonplaats object is registered by the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

woonplaats_eind_registratie
required
string

The time at which a version of a woonplaats object is no longer valid according to the bronhouder. ISO 8601 timestamp.

Empty string "" if not available.

woonplaats_tijdstip_registratie_lv
required
string

The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

woonplaats_tijdstip_eind_registratie_lv
required
string

The time at which a version of a woonplaats object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.

Empty string "" if not available.

provincie
required
string
Enum: "Drenthe" "Flevoland" "Friesland" "Gelderland" "Groningen" "Limburg" "Noord-Brabant" "Noord-Holland" "Overijssel" "Utrecht" "Zeeland" "Zuid-Holland" ""

Province the address falls in, derived from the postcode.

Empty string "" if not available.

{
  • "id": "kadaster_1742010000016637|1742200000045935",
  • "dataset": "kadaster",
  • "country": "Netherlands",
  • "country_iso": "NLD",
  • "country_iso_2": "NL",
  • "line_1": "Oude Veemarkt 25",
  • "language": "nl",
  • "address": "25",
  • "identificatie": "1742010000016637",
  • "latitude": 52.309501578434144,
  • "longitude": 6.524052774641579,
  • "gebruiksdoel": "bijeenkomstfunctie",
  • "oppervlakte": 532,
  • "status": "Verblijfsobject in gebruik",
  • "geconstateerd": false,
  • "documentdatum": "2023-11-09T00:00:00.000Z",
  • "documentnummer": "D2023167157",
  • "voorkomenidentificatie": 2,
  • "begin_geldigheid": "2023-11-09T00:00:00.000Z",
  • "eind_geldigheid": "",
  • "tijdstip_registratie": "2023-11-09T14:42:11.635Z",
  • "eind_registratie": "",
  • "tijdstip_registratie_lv": "2023-11-09T14:55:36.476Z",
  • "tijdstip_eind_registratie_lv": "",
  • "nummeraanduidingen_identificatie": "1742200000045935",
  • "nummeraanduidingen_huisnummer": "25",
  • "nummeraanduidingen_huisnummertoevoeging": "",
  • "nummeraanduidingen_huisletter": "",
  • "nummeraanduidingen_postcode": "7461 GJ",
  • "nummeraanduidingen_type_adresseerbaar_object": "Verblijfsobject",
  • "nummeraanduidingen_status": "Naamgeving uitgegeven",
  • "nummeraanduidingen_geconstateerd": false,
  • "nummeraanduidingen_documentdatum": "2009-05-13T00:00:00.000Z",
  • "nummeraanduidingen_documentnummer": "D2009021777",
  • "nummeraanduidingen_voorkomenidentificatie": 1,
  • "nummeraanduidingen_begin_geldigheid": "2009-05-13T00:00:00.000Z",
  • "nummeraanduidingen_eind_geldigheid": "",
  • "nummeraanduidingen_tijdstip_registratie": "2010-10-22T16:46:11.000Z",
  • "nummeraanduidingen_eind_registratie": "",
  • "nummeraanduidingen_tijdstip_registratie_lv": "2010-10-25T10:37:53.434Z",
  • "nummeraanduidingen_tijdstip_eind_registratie_lv": "",
  • "pand_identificatie": "1742100000015838",
  • "pand_oorspronkelijk_bouwjaar": 1920,
  • "pand_status": "Pand in gebruik",
  • "pand_geconstateerd": false,
  • "pand_documentdatum": "1920-05-18T00:00:00.000Z",
  • "pand_documentnummer": "2475-000V",
  • "pand_voorkomenidentificatie": 1,
  • "pand_begin_geldigheid": "1920-05-18T00:00:00.000Z",
  • "pand_eind_geldigheid": "",
  • "pand_tijdstip_registratie": "2010-10-22T16:04:09.000Z",
  • "pand_eind_registratie": "",
  • "pand_tijdstip_registratie_lv": "2010-10-25T10:34:22.804Z",
  • "pand_tijdstip_eind_registratie_lv": "",
  • "openbare_ruimte_identificatie": "1742300000000446",
  • "openbare_ruimte_naam": "Oude Veemarkt",
  • "openbare_ruimte_type": "Weg",
  • "openbare_ruimte_status": "Naamgeving uitgegeven",
  • "openbare_ruimte_geconstateerd": false,
  • "openbare_ruimte_documentdatum": "1994-11-22T00:00:00.000Z",
  • "openbare_ruimte_documentnummer": "RSN_STR_1937-2000",
  • "openbare_ruimte_voorkomenidentificatie": 1,
  • "openbare_ruimte_begin_geldigheid": "1994-11-22T00:00:00.000Z",
  • "openbare_ruimte_eind_geldigheid": "",
  • "openbare_ruimte_tijdstip_registratie": "2010-10-22T15:40:31.000Z",
  • "openbare_ruimte_eind_registratie": "",
  • "openbare_ruimte_tijdstip_registratie_lv": "2010-10-25T10:32:44.940Z",
  • "openbare_ruimte_tijdstip_eind_registratie_lv": "",
  • "openbare_ruimte_verkorte_naam": "",
  • "woonplaats_identificatie": "1566",
  • "woonplaats_naam": "Rijssen",
  • "woonplaats_status": "Woonplaats aangewezen",
  • "woonplaats_geconstateerd": false,
  • "woonplaats_documentdatum": "2008-12-15T00:00:00.000Z",
  • "woonplaats_documentnummer": "Raad 15-12-2008/17",
  • "woonplaats_voorkomenidentificatie": 1,
  • "woonplaats_begin_geldigheid": "2008-12-15T00:00:00.000Z",
  • "woonplaats_eind_geldigheid": "",
  • "woonplaats_tijdstip_registratie": "2010-10-22T15:40:19.000Z",
  • "woonplaats_eind_registratie": "",
  • "woonplaats_tijdstip_registratie_lv": "2010-10-25T10:32:43.439Z",
  • "woonplaats_tijdstip_eind_registratie_lv": "",
  • "provincie": "Overijssel"
}

NO Kartverket

Standard Norwegian Address format from the Norwegian Mapping Authority (Kartverket).

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

dataset
required
string
Value: "kartverket"
country
required
string
Enum: "Norway" "Svalbard and Jan Mayen"

Full country names (ISO 3166)

country_iso
required
string
Enum: "NOR" "SJM"

3 letter country code (ISO 3166-1)

country_iso_2
required
string
Enum: "NO" "SJ"

2 letter country code (ISO 3166-1)

line_1
required
string

First address line. adressetilleggsnavn where present, otherwise the official address text without it.

Can be empty string "" if not present.

line_2
required
string

Second address line. The official address text without adressetilleggsnavn, where line 1 carries that name.

Can be empty string "" if not present.

language
required
string
Value: "no"

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

address
required
string

Number uniquely identifying the address within its street or farm. nummer and bokstav for a vegadresse, otherwise the cadastral gardsnummer/bruksnummer. Any bruksenhetsnummer_tekst is appended after a hyphen.

Can be empty string "" if not present.

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

lokal_id
required
string

Local identifier assigned by the data supplier.

Can be empty string "" if not present.

kommunenummer
required
string

Kommune (municipality) number.

kommunenavn
required
string

Kommune (municipality) name.

adressetype
required
string

vegadresse = street address, matrikkeladresse = land registry address

adressetilleggsnavn
required
string

A local place name used in a road address.

Can be empty string "" if not present.

adressetilleggsnavn_kilde
required
string

Code for adressetilleggsnavn origin.

Can be empty string "" if not present.

required
string or integer
adressenavn
required
string

Name of street, road, path, place or area entered in the land register.

Can be empty string "" if not present.

required
string or integer
bokstav
required
string

A subsequent letter that may be used in addition to a number.

Can be empty string "" if not present.

gardsnummer
required
integer

The number of a farm unit in the land register, unique within each municipality.

bruksnummer
required
integer

A unique identification number automatically assigned to each individual unit within a farm.

required
string or integer
required
string or integer
required
string or integer
adresse_tekst
required
string

Official address text without bruksenhetsnummer, unique within a kommune.

Can be empty string "" if not present.

adresse_tekst_uten_adressetilleggsnavn
required
string

Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune.

Can be empty string "" if not present.

bruksenhet_id
required
string

Local identifier for a unit within a building.

Can be empty string "" if not present.

bruksenhetsnummer_tekst
required
string

Unit number, e.g. an apartment in a multi-dwelling building.

Can be empty string "" if not present.

offisiell_adresse_tekst
required
string

Official address text with bruksenhetsnummer, unique within a kommune.

Can be empty string "" if not present.

offisiell_adresse_tekst_uten_adressetilleggsnavn
required
string

Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune.

Can be empty string "" if not present.

epsg_kode
required
integer

EPSG code of the coordinate reference system used by nord and oest. 25833 = EUREF89 UTM zone 33.

nord
required
string

Northward (northing) coordinate of address, in the coordinate reference system given by epsg_kode.

oest
required
string

Eastward (easting) coordinate of address, in the coordinate reference system given by epsg_kode.

postnummer
required
string

Postal code.

poststed
required
string

Name of postal town according to Posten.

grunnkretsnummer
required
string

Identifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delområdenummer and the last two indicate the grunnkrets.

Can be empty string "" if not present.

grunnkretsnavn
required
string

Official grunnkrets name from Statistics Norway (SSB).

Can be empty string "" if not present.

soknenummer
required
string

Unique 8 digit identifier of a parish.

Can be empty string "" if not present.

soknenavn
required
string

Parish name.

Can be empty string "" if not present.

organisasjonsnummer
required
string

Unique identifier of organisation in the Brønnøysund Register.

Can be empty string "" if not present.

tettstednummer
required
string

4 digit code for tettsted (urban settlement).

Can be empty string "" if not present.

tettstednavn
required
string

Name of tettsted (urban settlement).

Can be empty string "" if not present.

required
string or integer
valgkretsnavn
required
string

Name of constituency.

Can be empty string "" if not present.

oppdateringsdato
required
string <date-time>

Date of last change to the object data.

datauttaksdato
required
string <date-time>

Date of extraction from database.

adresse_id
required
string

Address local identifier assigned by the data supplier.

uuid_adresse
required
string <uuid>

Address identifier realised as UUID managed by the cadastral system.

uuid_bruksenhet
required
string

Unit of usage identifier realised as UUID managed by the cadastral system.

Can be empty string "" if not present.

atkomst_id
required
string

Local identifier for means of access to a property.

Can be empty string "" if not present.

uuid_atkomst
required
string

Identifier of the means of access to a property realised as UUID in the cadastral system.

Can be empty string "" if not present.

atkomst_nord
required
string

Northward coordinate of the means of access to a property.

Can be empty string "" if not present.

atkomst_oest
required
string

Eastward coordinate of the means of access to a property.

Can be empty string "" if not present.

sommeratkomst_id
required
string

Local identifier for means of access to a property in summer.

Can be empty string "" if not present.

uuid_sommeratkomst
required
string

Identifier of the means of access to a property in summer realised as UUID in the cadastral system.

Can be empty string "" if not present.

sommeratkomst_nord
required
string

Northward coordinate of the means of access to a property in summer.

Can be empty string "" if not present.

sommeratkomst_oest
required
string

Eastward coordinate of the means of access to a property in summer.

Can be empty string "" if not present.

vinteratkomst_id
required
string

Local identifier for means of access to a property in winter.

Can be empty string "" if not present.

uuid_vinteratkomst
required
string

Identifier of the means of access to a property in winter realised as UUID in the cadastral system.

Can be empty string "" if not present.

vinteratkomst_nord
required
string

Northward coordinate of the means of access to a property in winter.

Can be empty string "" if not present.

vinteratkomst_oest
required
string

Eastward coordinate of the means of access to a property in winter.

Can be empty string "" if not present.

fylke
required
string

Name of county. Derived from kommunenummer.

Can be empty string "" if not present.

landsdel
required
string

Name of region. Derived from fylke.

Can be empty string "" if not present.

{
  • "id": "kartverket_12204178!",
  • "dataset": "kartverket",
  • "country": "Norway",
  • "country_iso": "NOR",
  • "country_iso_2": "NO",
  • "line_1": "Skollerud",
  • "line_2": "278/177",
  • "language": "no",
  • "address": "278/177",
  • "latitude": 60.31858180575511,
  • "longitude": 10.03680377688277,
  • "lokal_id": "12204178",
  • "kommunenummer": "3305",
  • "kommunenavn": "Ringerike",
  • "adressetype": "matrikkeladresse",
  • "adressetilleggsnavn": "Skollerud",
  • "adressetilleggsnavn_kilde": "matrikkeladressenavn",
  • "adressekode": "",
  • "adressenavn": "",
  • "nummer": "",
  • "bokstav": "",
  • "gardsnummer": 278,
  • "bruksnummer": 177,
  • "festenummer": "",
  • "seksjonsnummer": "",
  • "undernummer": "",
  • "adresse_tekst": "Skollerud, 278/177",
  • "adresse_tekst_uten_adressetilleggsnavn": "278/177",
  • "bruksenhet_id": "",
  • "bruksenhetsnummer_tekst": "",
  • "offisiell_adresse_tekst": "",
  • "offisiell_adresse_tekst_uten_adressetilleggsnavn": "",
  • "epsg_kode": 25833,
  • "nord": "6697211.61",
  • "oest": "226005.30",
  • "postnummer": "3516",
  • "poststed": "Hønefoss",
  • "grunnkretsnummer": "33050801",
  • "grunnkretsnavn": "Skollerud",
  • "soknenummer": "04070402",
  • "soknenavn": "Hval",
  • "organisasjonsnummer": "976989880",
  • "tettstednummer": "",
  • "tettstednavn": "",
  • "valgkretsnummer": 11,
  • "valgkretsnavn": "Hallingby",
  • "oppdateringsdato": "2024-01-01T00:00:00.000Z",
  • "datauttaksdato": "2024-04-15T07:59:32.000Z",
  • "adresse_id": "12204178",
  • "uuid_adresse": "3db4e8f2-fc63-5abe-9e0d-f53045166412",
  • "uuid_bruksenhet": "",
  • "atkomst_id": "",
  • "uuid_atkomst": "",
  • "atkomst_nord": "",
  • "atkomst_oest": "",
  • "sommeratkomst_id": "",
  • "uuid_sommeratkomst": "",
  • "sommeratkomst_nord": "",
  • "sommeratkomst_oest": "",
  • "vinteratkomst_id": "",
  • "uuid_vinteratkomst": "",
  • "vinteratkomst_nord": "",
  • "vinteratkomst_oest": "",
  • "fylke": "Buskerud",
  • "landsdel": "Østlandet"
}

HERE

Address from the global HERE dataset, covering regions not served by a national address file.

id
required
string (Address Identifier)

Globally unique internally generated identifier for an address

country_iso
required
string

Three character country code based on ISO Standard 3166.

dataset
required
string
Enum: "herewe" "heret" "heresa" "hereo" "herena" "heremeas" "heremea" "herem" "herei" "herehk" "hereee" "hereap"

HERE regional dataset the address was sourced from.

language
required
string = 2 characters

ISO 639-1 language code of the record, mapped down from HERE's three-letter code. Taken from the address point, the road for a range, the point of interest or the administrative place for a locality.

line_1
required
string [ 0 .. 150 ] characters

First address line.

Can be empty string "" if not present.

line_2
required
string [ 0 .. 150 ] characters

Second address line.

Can be empty string "" if not present.

line_3
required
string [ 0 .. 150 ] characters

Third address line. Always the empty string "" for HERE records, which produce at most two lines.

line_4
required
string [ 0 .. 150 ] characters

Fourth address line. Always the empty string "" for HERE records, which produce at most two lines.

line_5
required
string [ 0 .. 150 ] characters

Fifth address line. Always the empty string "" for HERE records, which produce at most two lines.

address
required
string [ 0 .. 150 ] characters

Address / House Number uniquely identifying the address along the specified road link.

Can be empty string "" if not present.

required
string or number
required
string or number
building_name
required
string [ 0 .. 150 ] characters

Name of the Building to which the Point Address is associated.

Can be empty string "" if not present.

required
string or number
required
string or number
street_name
required
string [ 0 .. 100 ] characters

The full spelling of the street name, including Prefix, Base Name, Suffix, Street Type, and Direction on Sign.

Can be empty string "" if not present.

postal_code
required
string [ 0 .. 15 ] characters

Full postal code; could be numeric or alphanumeric postal code.

Can be empty string "" if not present.

order1_name
required
string

Identifies the highest administrative level in which a country can be subdivided.

Can be empty string "" if not present.

order2_name
required
string

Identifies an intermediate administrative level of a country and is a sub-division of an Order-1 area. Only countries with a five (or more) level administrative hierarchy have Order-2 administrative levels defined. This feature can be used for destination selection and map display.

Can be empty string "" if not present.

order8_name
required
string

Identifies the lowest level of the country's administrative hierarchy that is present country-wide. (No gaps exist in the coverage.)

Can be empty string "" if not present.

builtup_name
required
string

Identifies the lowest administrative level for a country. This level does not cover the entire country, (as opposed to the Order-8 Area level which does cover the entire country). This feature should be used in conjunction with Zone and Order-8 Area for destination selection. The Built-up Area polygon, as published in RDF_CARTO, can also be used for map display.

Can be empty string "" if not present.

poi_name
required
string

Name of the point of interest. Populated for point of interest records only.

Can be empty string "" if not present.

building_unit_name
required
string

Name of the Building associated with a Micro Point Address.

Can be empty string "" if not present.

level_name
required
string

Name of floor or level within a building associated with a Micro Point Address.

Can be empty string "" if not present.

unit_name
required
string

Name of the unit (suite, etc) associated with a Micro Point Address.

Can be empty string "" if not present.

suppl_address_info
required
string

Additional address or building information.

Can be empty string "" if not present.

building_grp_name
required
string

Name of the group of buildings with which the address is associated.

Can be empty string "" if not present.

{
  • "id": "herewe_ap|365553439|it",
  • "dataset": "herewe",
  • "country_iso": "ITA",
  • "line_1": "16 Via Giuseppe Garibaldi",
  • "line_2": "",
  • "line_3": "",
  • "line_4": "",
  • "line_5": "",
  • "language": "it",
  • "address": "16",
  • "building_name": "",
  • "delivery_latitude": 45.28441,
  • "delivery_longitude": 12.00825,
  • "latitude": 45.28441,
  • "longitude": 12.00825,
  • "street_name": "Via Giuseppe Garibaldi",
  • "postal_code": "35020",
  • "order1_name": "Veneto",
  • "order2_name": "Padova",
  • "order8_name": "Brugine",
  • "builtup_name": "",
  • "poi_name": "",
  • "building_unit_name": "",
  • "level_name": "",
  • "unit_name": "",
  • "suppl_address_info": "",
  • "building_grp_name": ""
}

GeoNames Place

GeoNames place record

id
required
string

Unique place ID

dataset
required
string
Value: "geonames"

Indicates the provenance of a place

geonameid
required
integer <int32>

Unique identifier for GeoNames place

name
required
string [ 0 .. 200 ] characters

Place name (UTF8)

asciiname
required
string [ 0 .. 200 ] characters

Place name (ASCII). Empty string if not available

alternatenames
required
Array of strings

List of alternate names for the place

language
required
string (Language)
Enum: "en" "ar" "as" "az" "be" "bg" "bn" "bs" "ca" "cs" "cy" "da" "de" "el" "es" "et" "eu" "fi" "fo" "fr" "ga" "gl" "gn" "he" "hi" "hr" "hu" "hy" "id" "is" "it" "ja" "ka" "kk" "km" "kn" "ko" "lt" "lv" "mk" "mn" "ms" "mt" "my" "nl" "no" "pl" "pt" "rm" "ro" "ru" "sk" "sl" "sq" "sr" "sv" "ta" "th" "tr" "uk" "uz" "vi" "wa" "zh"

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

required
Latitude (string) or Latitude (number) (Latitude)

The latitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. 51.5083983.

Returns an empty string if no location data is available.

required
Longitude (string) or Longitude (number) (Longitude)

The longitude of the address or postcode (WGS84).

Can be a positive or negative decimal. E.g. -0.1283983

Returns an empty string if no location data is available.

feature_class
required
string
Enum: "A" "P"

GeoNames single letter feature class (http://www.geonames.org/export/codes.html). Only two are indexed

  • A Country, state, region
  • P City, village
feature_code
required
string [ 0 .. 10 ] characters

Full GeoNames feature code (http://www.geonames.org/export/codes.html)

country_code
required
string [ 0 .. 2 ] characters

2 letter ISO country code. Empty string if not available

country_iso
required
string [ 0 .. 3 ] characters

3 letter ISO country code derived from country_code. Empty string if the country cannot be resolved

cc2
required
Array of strings[ items = 2 characters ]

List of other country codes mapping to this place

admin1_name
required
string

Name of first administrative area. Empty string if not available

admin1_geonameid
required
integer or null <int32>

GeoName ID for first administrative area

admin1_code
required
string [ 0 .. 20 ] characters

Fipscode (subject to change to iso code)

admin2_name
required
string

Name of second administrative area. Empty string if not available

admin2_geonameid
required
integer or null <int32>

GeoName ID for second administrative area

admin2_code
required
string [ 0 .. 101 ] characters

Code for the second administrative division

admin3_code
required
string [ 0 .. 122 ] characters

Code for third level administrative division

admin4_code
required
string [ 0 .. 143 ] characters

Code for fourth level administrative division

population
required
string

Population at place. Represented as a string as it can be larger than a 32 bit integer

elevation
required
integer or null <int32>

Elevation in metres. null if not available

dem
required
integer or null <int32>

Digital elevation model (srtm3 or gtopo30), average elevation in metres

timezone
required
string [ 0 .. 40 ] characters

The IANA timezone ID. Empty string if not available

modification_date
required
string <date-time>

Date the GeoNames record was last modified

{
  • "id": "geonames_7296662",
  • "dataset": "geonames",
  • "geonameid": 7296662,
  • "name": "Strumpshaw",
  • "asciiname": "Strumpshaw",
  • "alternatenames": [ ],
  • "language": "en",
  • "latitude": 52.60599,
  • "longitude": 1.47572,
  • "feature_class": "A",
  • "feature_code": "ADM4",
  • "country_code": "GB",
  • "country_iso": "GBR",
  • "cc2": [ ],
  • "admin1_name": "England",
  • "admin1_geonameid": 6269131,
  • "admin1_code": "ENG",
  • "admin2_name": "Norfolk",
  • "admin2_geonameid": 2641455,
  • "admin2_code": "I9",
  • "admin3_code": "33UC",
  • "admin4_code": "33UC056",
  • "population": "0",
  • "elevation": null,
  • "dem": 25,
  • "timezone": "Europe/London",
  • "modification_date": "2010-05-25T00:00:00.000Z"
}