Skip to main content

Address API

The Address API is used for validating and querying addresses, as well as getting suggestions in scenarios where the complete address is not known. It currently supports Norwegian addresses (street, place, post office box and postal place addresses). Addresses validated by this API are guaranteed to be valid, and it is therefore recommended to validate addresses that are used as input to Booking and Checkout related APIs.

Authentication

To make API requests, you will need an API key from Mybring. Steps for getting a key and description of headers can be found on the general API Getting Started / Authentication page.

Rate limiting

Clients exceeding 40 requests per second will be throttled, and the response will contain http status code 429. If you have a use case requiring rates above the limit, please contact developer-booking@bring.com for assistance.

Formats

REST XML/JSON over HTTP.

Returned format is controlled by the Accept header. Supported values are application/json and application/xml. Default returned format is JSON.

Endpoints

https://api.bring.com/address/
Usage Method Endpoint
Get addresses matching query GET /api/{country-code}/addresses
Get address GET /api/{country-code}/addresses/{id}
Get street GET /api/{country-code}/streets/{id}
Get available street numbers GET /api/{country-code}/streets/{id}/numbers
Get street or place suggestions GET /api/{country-code}/suggestions
Validate provided address GET /api/{country-code}/validation

Get addresses matching query

get
                              /api/{country-code}/addresses
                            

Fetches addresses matching provided filters.

Request

header parameters

X-Mybring-API-Uid
Required
Mybring login ID
string
X-Mybring-API-Key
Required
Your user's API key
string
Accept
Desired output media type
string
Enum:
application/jsonapplication/xml
Default:
"application/json"

path parameters

country-code
Required
Country code
string
Value:
no

query parameters

street_or_place
Street or place name. Required when querying for street and place address types
string
Example:
street_or_place=kolåsveien
address_type
Required
Address type
string
Enum:
streetplacepostal_placepo_box
po_box_number
Post office box number
integer
Example:
po_box_number=1
po_box_facility
Post office box facility name
string
Example:
po_box_facility=Sentrum
postal_code
Postal code
string
Example:
postal_code=1555
city
City
string
Example:
city=Son
street_number
Street number
integer
Example:
street_number=9
letter
House letter
string
Example:
letter=B
page
Page number for paginated results
integer
limit
Number of results per page. Default 10. Max 10.
integer

Responses

200 OK
Required
array
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
Required
array
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
204 Address not found
400 Bad Request
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
429 Too Many Requests
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
500 Internal Server Error
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string

Response examples

{
  "addresses": [
    {
      "address_id": "1817301",
      "city": "Son",
      "county": "Viken",
      "house_number": 9,
      "municipality": "Vestby",
      "postal_code": "1555",
      "street_name": "Kolåsveien",
      "type": "STREET"
    },
    {
      "address_id": "1817302",
      "city": "Son",
      "county": "Viken",
      "house_number": 10,
      "municipality": "Vestby",
      "postal_code": "1555",
      "street_name": "Kolåsveien",
      "type": "STREET"
    }
  ],
  "navigation": {
    "self": "https://api.bring.com/address/api/no/addresses?street_or_place=kol%C3%A5sveien&address_type=street&postal_code=1555&city=Son&page=1",
    "total_hits": 2
  }
}

Get address

get
                              /api/{country-code}/addresses/{id}
                            

Fetches details for provided address id

Request

header parameters

X-Mybring-API-Uid
Required
Mybring login ID
any
X-Mybring-API-Key
Required
Your user's API key
any
Accept
Desired output media type
string
Enum:
application/jsonapplication/xml
Default:
"application/json"

path parameters

country-code
Required
Country code
string
Value:
no
id
Required
Id of address to fetch
any
Example:
2264429

Responses

200 OK
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
400 Bad Request
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
404 Address not found
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
429 Too Many Requests
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
500 Internal Server Error
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string

Response examples

{
  "address_id": "3419922",
  "city": "Sulitjelma",
  "county": "Nordland",
  "municipality": "Fauske",
  "place": "Stormo",
  "postal_code": "8230",
  "type": "PLACE"
}

Get street

get
                              /api/{country-code}/streets/{id}
                            

Fetches details for provided street id

Request

header parameters

X-Mybring-API-Uid
Required
Mybring login ID
string
X-Mybring-API-Key
Required
Your user's API key
string
Accept
Desired output media type
string
Enum:
application/jsonapplication/xml
Default:
"application/json"

path parameters

country-code
Required
Country code
string
Value:
no
id
Required
Id of street to fetch
string
Example:
NO-0301-11704

Responses

200 OK
city
string
county
string
id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
name
Street or place name
string
postal_code
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
city
string
county
string
id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
name
Street or place name
string
postal_code
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
400 Bad Request
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
404 Street not found
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
429 Too Many Requests
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
500 Internal Server Error
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string

Response examples

{
  "city": "Sulitjelma",
  "county": "Nordland",
  "id": "3419922",
  "name": "Stormo",
  "postal_code": "8230",
  "type": "PLACE"
}

Get available street numbers

get
                              /api/{country-code}/streets/{id}/numbers
                            

Returns a list of available street numbers for provided street id.

Request

header parameters

X-Mybring-API-Uid
Required
Mybring login ID
string
X-Mybring-API-Key
Required
Your user's API key
string
Accept
Desired output media type
string
Enum:
application/jsonapplication/xml
Default:
"application/json"

path parameters

country-code
Required
Country code
string
Value:
no
id
Required
Street id
string
Example:
NO-3019-04900

query parameters

page
Page number for paginated results
integer
limit
Number of results per page. Default 20. Max 20.
integer

Responses

200 OK
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
street_name
Street name
string
Required
array
address_id
Unique address id
string
formatted_number
House number (and letter) combined
string
letter
House letter
string
number
House number
integer <int32>
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
street_name
Street name
string
Required
array
address_id
Unique address id
string
formatted_number
House number (and letter) combined
string
letter
House letter
string
number
House number
integer <int32>
400 Bad Request
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
404 Not Found
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
429 Too Many Requests
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
500 Internal Server Error
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string

Response examples

{
  "navigation": {
    "self": "https://api.bring.com/address/api/no/streets/NO-3019-04900/numbers&page=1",
    "total_hits": 4
  },
  "street_name": "Kolåsveien",
  "street_numbers": [
    {
      "address_id": "1817301",
      "formatted_number": "1",
      "number": 1
    },
    {
      "address_id": "1817302",
      "formatted_number": "1A",
      "letter": "A",
      "number": 1
    },
    {
      "address_id": "1817303",
      "formatted_number": "1B",
      "letter": "B",
      "number": 1
    },
    {
      "address_id": "1817304",
      "formatted_number": "2",
      "number": 2
    }
  ]
}

Get street or place suggestions

get
                              /api/{country-code}/suggestions
                            

Returns a list of streets and places matching input query. The following address types are supported: - Street address - Place Depending on the returned suggestion type, the id will differ. Returned suggestions are identified by either an street_id or an address_id. Suggestions of type STREET are identified with street_id which is an unique identifier for a street. To obtain an address_id you will need street number as well. Suggestions of type PLACE are identified with address_id, which are unique addresses and does not support street numbers.

Request

header parameters

X-Mybring-API-Uid
Required
Mybring login ID
string
X-Mybring-API-Key
Required
Your user's API key
string
Accept
Desired output media type
string
Enum:
application/jsonapplication/xml
Default:
"application/json"

path parameters

country-code
Required
Country code
string
Value:
no

query parameters

q
Required
Street or place name to filter for
string
Examples:

Partial street or place name

Will return all matching streets or places containing this name

q=kolås

Street or place name

Will return all matching streets or places with this name

q=kolåsveien

Street or place name with city

If city is known you may supply it (prefixed by ,) to narrow the search

q=kolås, son

Street or place name with postal code

If postal code is known you may supply it (prefixed by ,) to narrow the search

q=kolås, 1555
page
Page number for paginated results
integer
limit
Number of results per page. Default 10. Max 10.
integer

Responses

200 OK
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
Required
array
city
string
county
string
id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
name
Street or place name
string
postal_code
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
Required
array
city
string
county
string
id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
name
Street or place name
string
postal_code
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
400 Bad Request
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
429 Too Many Requests
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
500 Internal Server Error
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string

Response examples

{
  "navigation": {
    "self": "https://api.bring.com/address/api/no/suggestions?page=1",
    "total_hits": 2
  },
  "streets_and_places": [
    {
      "city": "Oslo",
      "county": "Oslo",
      "id": "NO-0301-11704",
      "name": "Falsens gate",
      "postal_code": "0556",
      "type": "STREET"
    },
    {
      "city": "Sulitjelma",
      "county": "Nordland",
      "id": "3419922",
      "name": "Stormo",
      "postal_code": "8230",
      "type": "PLACE"
    }
  ]
}

Validate provided address

get
                              /api/{country-code}/validation
                            

Will attempt to find a matching address. If no exact match is found, a list of possible reasons are returned along with close matching alternative suggestions (if found).

Request

header parameters

X-Mybring-API-Uid
Required
Mybring login ID
string
X-Mybring-API-Key
Required
Your user's API key
string
Accept
Desired output media type
string
Enum:
application/jsonapplication/xml
Default:
"application/json"

path parameters

country-code
Required
Country code
string
Value:
no

query parameters

street_or_place
Street or place name. Required when querying for street and place address types
string
Example:
street_or_place=kolåsveien
address_type
Required
Address type
string
Enum:
streetplacepostal_placepo_box
po_box_number
Post office box number
integer
Example:
po_box_number=1
po_box_facility
Post office box facility name
string
Example:
po_box_facility=Sentrum
postal_code
Required
Postal code
string
Example:
postal_code=1555
city
City. Required for postal place addresses
string
Example:
city=Son
street_number
Street number. Required for street addresses
integer
Example:
street_number=9
letter
House letter
string
Example:
letter=B

Responses

200 OK
object
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
Possible reasons why provided address was not found
array
code
Validation error code
string
Enum:
HOUSE_NUMBER_DOES_NOT_EXIST
HOUSE_LETTER_DOES_NOT_EXIST
STREET_NAME_DOES_NOT_EXIST
PLACE_DOES_NOT_EXIST
ADDRESS_NOT_FOUND
INCORRECT_CITY
PO_BOX_NUMBER_DOES_NOT_EXIST
PO_BOX_FACILITY_DOES_NOT_EXIST
description
Validation error description
string
Alternate address suggestions
array
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
valid
Required
Address is valid
boolean
object
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
Possible reasons why provided address was not found
array
code
Validation error code
string
Enum:
HOUSE_NUMBER_DOES_NOT_EXIST
HOUSE_LETTER_DOES_NOT_EXIST
STREET_NAME_DOES_NOT_EXIST
PLACE_DOES_NOT_EXIST
ADDRESS_NOT_FOUND
INCORRECT_CITY
PO_BOX_NUMBER_DOES_NOT_EXIST
PO_BOX_FACILITY_DOES_NOT_EXIST
description
Validation error description
string
Alternate address suggestions
array
address_id
Unique address id
string
city
City
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum:
STREET
PLACE
POSTAL_PLACE
PO_BOX
valid
Required
Address is valid
boolean
400 Bad Request
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
code
string
Enum:
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
429 Too Many Requests
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
500 Internal Server Error
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
code
string
Enum:
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string

Response examples

{
  "reasons": [
    {
      "code": "ADDRESS_NOT_FOUND",
      "description": "No matching address found, and no alternative suggestions available"
    }
  ],
  "valid": false
}
comments powered by Disqus