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.
Subscribe to updates
Endpoints
https://api.bring.com/address
Usage | Method | Endpoint |
---|---|---|
Get addresses matching query | GET |
/api/{country-code}/addresses
|
Get address suggestions | GET |
/api/{country-code}/addresses/suggestions
|
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
https://api.bring.com/address/api/{country-code}/addresses
Fetches addresses matching provided filters.
Request
header parameters
-
X-Mybring-API-Uid
Required -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
query parameters
-
street_or_place
-
- Description
- Street or place name. Required when querying for street and place address types
- Type
- string
- Example
street_or_place=kolåsveien
-
address_type
Required -
- Description
- Address type
- Type
- string
- Enum
street
place
postal_place
po_box
-
po_box_number
-
- Description
- Post office box number
- Type
- integer
- Example
po_box_number=1
-
po_box_facility
-
- Description
- Post office box facility name
- Type
- string
- Example
po_box_facility=Sentrum
-
postal_code
-
- Description
- Postal code
- Type
- string
- Example
postal_code=1555
-
city
-
- Description
- City
- Type
- string
- Example
city=Son
-
street_number
-
- Description
- Street number
- Type
- integer
- Example
street_number=9
-
letter
-
- Description
- House letter
- Type
- string
- Example
letter=B
-
page
-
- Description
- Page number for paginated results
- Type
- integer
-
limit
-
- Description
- Number of results per page. Default 10. Max 10.
- Type
- integer
Responses
200 OK
Schema
-
Required
- array of objects
-
address_id
- Unique address idstring
-
city
- Citystring
- Coordinateobject
-
-
latitude
- WGS84 Latitudestring
-
longitude
- WGS84 Longitudestring
-
-
county
- County address is located instring
-
house_number
- House numberinteger <int32>
-
letter
- House letterstring
-
municipality
- Municipality address is located instring
-
place
- Place namestring
-
po_box_facility
- Post office box facility namestring
-
po_box_number
- Post office box numberinteger <int32>
-
postal_code
- Postal codestring
-
street_name
- Street namestring
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- object
- object
-
-
Required
- array wrapped
-
- Alternate address suggestionsobject
-
-
AddressId
- Unique address idstring
-
City
- Citystring
- Coordinateobject
-
-
Latitude
- WGS84 Latitudestring
-
Longitude
- WGS84 Longitudestring
-
-
County
- County address is located instring
-
HouseNumber
- House numberinteger <int32>
-
Letter
- House letterstring
-
Municipality
- Municipality address is located instring
-
Place
- Place namestring
-
PostOfficeBoxFacility
- Post office box facility namestring
-
PostOfficeBoxNumber
- Post office box numberinteger <int32>
-
PostalCode
- Postal codestring
-
StreetName
- Street namestring
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- object
-
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
Response examples
{
"addresses": [
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
},
{
"address_id": "1817302",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"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
}
}
<?xml version="1.0" encoding="UTF-8"?>
<Addresses>
<AddressList>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
<Address>
<AddressId>1817302</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>10</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
</AddressList>
<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" totalHits="2">
</Navigation>
</Addresses>
{
"code": "INVALID_ADDRESS_TYPE",
"description": "The 'address_type' query param requires one of the following values: [street, place, postal_place, po_box]"
}
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LETTER",
"description": "The 'letter' query param cannot be numeric"
}
{
"code": "INVALID_LIMIT",
"description": "The `limit` query param must be numeric"
}
{
"code": "INVALID_PAGE_NUMBER",
"description": "The 'page' query param must be numeric"
}
{
"code": "INVALID_POSTAL_CODE",
"description": "Invalid postal code format. Postal code must be numeric and consist of 4 digits"
}
{
"code": "INVALID_PO_BOX_NUMBER",
"description": "The 'po_box_number' query param must be numeric"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "INVALID_STREET_NUMBER",
"description": "The 'street_number' query param must be numeric"
}
{
"code": "LIMIT_LARGER_THAN_10",
"description": "The `limit` query param cannot be greater than 10"
}
{
"code": "MISSING_ADDRESS_TYPE",
"description": "The 'address_type' query param cannot be null"
}
{
"code": "MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS",
"description": "Either 'postal_code' or 'city' query param is mandatory when providing an 'address_type' of postal place or post office box"
}
{
"code": "MISSING_STREET_OR_PLACE",
"description": "The 'street_or_place' query param is mandatory when providing an 'address_type' of street or place"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>
Get address suggestions
https://api.bring.com/address/api/{country-code}/addresses/suggestions
Returns a list of addresses matching input query. The following address types are supported:
- Street address
- Place
Supports suggestions for street addresses including house numbers + letters. Search is prefix based.
Request
header parameters
-
X-Mybring-API-Uid
Required -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
query parameters
-
q
Required -
- Description
- Street or place name to filter for
- Type
- string
- Examples
-
- Partial street or place name
- Will return all matching streets or places containing this name
q=kolås
- Street name and number in city/postalCode
- To get addresses having matching street name and numbers in a specific city/postalCode (prefixed by ,)
q=storgata 5, sarpsborg
- Street name with house number
- To get addresses having matching street name and house numbers. House numbers are searched by prefix, so 1 will also give hits on 10, 11, 12 etc.
q=kolåsvei 14
- Street name with house number and letter
- To get addresses having matching street name and house numbers and letter.
q=kolåsvei 14B
- Street or place name
- Will return all matching streets or places with this name
q=kolåsveien
- Street or place name with city
- When street name is common and present in multiple municipalities, you can narrow the search by providing the city (prefixed by ,)
q=storgata, son
- Street or place name with postal code
- When street name is common and present in multiple municipalities, you can narrow the search by providing the postal code (prefixed by ,)
q=storgata, 1555
-
page
-
- Description
- Page number for paginated results
- Type
- integer
-
limit
-
- Description
- Number of results per page. Default 10. Max 10.
- Type
- integer
Responses
200 OK
Schema
-
Required
- array of objects
-
address_id
- Unique address idstring
-
city
- Citystring
- Coordinateobject
-
-
latitude
- WGS84 Latitudestring
-
longitude
- WGS84 Longitudestring
-
-
county
- County address is located instring
-
house_number
- House numberinteger <int32>
-
letter
- House letterstring
-
municipality
- Municipality address is located instring
-
place
- Place namestring
-
po_box_facility
- Post office box facility namestring
-
po_box_number
- Post office box numberinteger <int32>
-
postal_code
- Postal codestring
-
street_name
- Street namestring
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- object
- object
-
-
Required
- array wrapped
-
- Alternate address suggestionsobject
-
-
AddressId
- Unique address idstring
-
City
- Citystring
- Coordinateobject
-
-
Latitude
- WGS84 Latitudestring
-
Longitude
- WGS84 Longitudestring
-
-
County
- County address is located instring
-
HouseNumber
- House numberinteger <int32>
-
Letter
- House letterstring
-
Municipality
- Municipality address is located instring
-
Place
- Place namestring
-
PostOfficeBoxFacility
- Post office box facility namestring
-
PostOfficeBoxNumber
- Post office box numberinteger <int32>
-
PostalCode
- Postal codestring
-
StreetName
- Street namestring
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- object
-
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
Response examples
{
"addresses": [
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
},
{
"address_id": "1817302",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"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
}
}
<?xml version="1.0" encoding="UTF-8"?>
<Addresses>
<AddressList>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
<Address>
<AddressId>1817302</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>10</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
</AddressList>
<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" totalHits="2">
</Navigation>
</Addresses>
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LIMIT",
"description": "The `limit` query param must be numeric"
}
{
"code": "INVALID_PAGE_NUMBER",
"description": "The 'page' query param must be numeric"
}
{
"code": "INVALID_POSTAL_CODE",
"description": "Invalid postal code format. Postal code must be numeric and consist of 4 digits"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "LIMIT_LARGER_THAN_10",
"description": "The `limit` query param cannot be greater than 10"
}
{
"code": "QUERY_PARAM_MISSING_OR_EMPTY",
"description": "The 'q' query param cannot be null or empty"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>
Get address
https://api.bring.com/address/api/{country-code}/addresses/{id}
Fetches details for provided address id
Request
header parameters
-
X-Mybring-API-Uid
Required -
- Description
- Mybring login ID
- Type
- any
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- any
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
-
id
Required -
- Description
- Id of address to fetch
- Type
- any
- Example
2264429
Responses
200 OK
Schema
-
address_id
- Unique address idstring
-
city
- Citystring
- Coordinateobject
-
-
latitude
- WGS84 Latitudestring
-
longitude
- WGS84 Longitudestring
-
-
county
- County address is located instring
-
house_number
- House numberinteger <int32>
-
letter
- House letterstring
-
municipality
- Municipality address is located instring
-
place
- Place namestring
-
po_box_facility
- Post office box facility namestring
-
po_box_number
- Post office box numberinteger <int32>
-
postal_code
- Postal codestring
-
street_name
- Street namestring
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
- Alternate address suggestionsobject
-
-
AddressId
- Unique address idstring
-
City
- Citystring
- Coordinateobject
-
-
Latitude
- WGS84 Latitudestring
-
Longitude
- WGS84 Longitudestring
-
-
County
- County address is located instring
-
HouseNumber
- House numberinteger <int32>
-
Letter
- House letterstring
-
Municipality
- Municipality address is located instring
-
Place
- Place namestring
-
PostOfficeBoxFacility
- Post office box facility namestring
-
PostOfficeBoxNumber
- Post office box numberinteger <int32>
-
PostalCode
- Postal codestring
-
StreetName
- Street namestring
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
404 Address not found
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
Response examples
{
"address_id": "3419922",
"city": "Sulitjelma",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Nordland",
"municipality": "Fauske",
"place": "Stormo",
"postal_code": "8230",
"type": "PLACE"
}
{
"address_id": "61899",
"city": "Oslo",
"coordinate": {
"latitude": "60.00012",
"longitude": "5.0033"
},
"county": "Oslo",
"municipality": "Oslo",
"po_box_facility": "Sentrum",
"po_box_number": 506,
"postal_code": "0105",
"type": "PO_BOX"
}
{
"address_id": "61899",
"city": "Oslo",
"coordinate": {
"latitude": "60.00012",
"longitude": "5.0033"
},
"county": "Oslo",
"municipality": "Oslo",
"po_box_facility": "Sentrum",
"po_box_number": 506,
"postal_code": "0105",
"type": "PO_BOX"
}
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
}
<?xml version="1.0" encoding="UTF-8"?>
<Address>
<AddressId>3419922</AddressId>
<City>Sulitjelma</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Nordland</County>
<Municipality>Fauske</Municipality>
<Place>Stormo</Place>
<PostalCode>8230</PostalCode>
<Type>PLACE</Type>
</Address>
<?xml version="1.0" encoding="UTF-8"?>
<Address>
<AddressId>61899</AddressId>
<City>Oslo</City>
<GeoCoordinate>
<Latitude>60.00012</Latitude>
<Longitude>5.0033</Longitude>
</GeoCoordinate>
<County>Oslo</County>
<Municipality>Oslo</Municipality>
<PostOfficeBoxFacility>Sentrum</PostOfficeBoxFacility>
<PostOfficeBoxNumber>506</PostOfficeBoxNumber>
<PostalCode>0105</PostalCode>
<Type>PO_BOX</Type>
</Address>
<?xml version="1.0" encoding="UTF-8"?>
<Address>
<AddressId>61899</AddressId>
<City>Oslo</City>
<GeoCoordinate>
<Latitude>60.00012</Latitude>
<Longitude>5.0033</Longitude>
</GeoCoordinate>
<County>Oslo</County>
<Municipality>Oslo</Municipality>
<PostOfficeBoxFacility>Sentrum</PostOfficeBoxFacility>
<PostOfficeBoxNumber>506</PostOfficeBoxNumber>
<PostalCode>0105</PostalCode>
<Type>PO_BOX</Type>
</Address>
<?xml version="1.0" encoding="UTF-8"?>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LIMIT",
"description": "The `limit` query param must be numeric"
}
{
"code": "INVALID_PAGE_NUMBER",
"description": "The 'page' query param must be numeric"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "LIMIT_LARGER_THAN_10",
"description": "The `limit` query param cannot be greater than 10"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "NOT_FOUND",
"description": "Not found"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>NOT_FOUND</Code>
<Description>Not found</Description>
</Error>
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>
Get street
https://api.bring.com/address/api/{country-code}/streets/{id}
Fetches details for provided street id
Request
header parameters
-
X-Mybring-API-Uid
Required -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
-
id
Required -
- Description
- Id of street to fetch
- Type
- string
- Example
NO-0301-11704
Responses
200 OK
Schema
-
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 namestring
-
postal_code
- string
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
- object
-
-
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 namestring
-
PostalCode
- string
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
404 Street not found
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
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"
}
{
"city": "Oslo",
"county": "Oslo",
"id": "NO-0301-11704",
"name": "Falsens gate",
"postal_code": "0556",
"type": "STREET"
}
<?xml version="1.0" encoding="UTF-8"?>
<StreetOrPlace>
<City>Sulitjelma</City>
<County>Nordland</County>
<Id>3419922</Id>
<Name>Stormo</Name>
<PostalCode>8230</PostalCode>
<Type>PLACE</Type>
</StreetOrPlace>
<?xml version="1.0" encoding="UTF-8"?>
<StreetOrPlace>
<City>Oslo</City>
<County>Oslo</County>
<Id>NO-0301-11704</Id>
<Name>Falsens gate</Name>
<PostalCode>0556</PostalCode>
<Type>STREET</Type>
</StreetOrPlace>
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LIMIT",
"description": "The `limit` query param must be numeric"
}
{
"code": "INVALID_PAGE_NUMBER",
"description": "The 'page' query param must be numeric"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "LIMIT_LARGER_THAN_10",
"description": "The `limit` query param cannot be greater than 10"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "NOT_FOUND",
"description": "Not found"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>NOT_FOUND</Code>
<Description>Not found</Description>
</Error>
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>
Get available street numbers
https://api.bring.com/address/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 -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
-
id
Required -
- Description
- Street id
- Type
- string
- Example
NO-3019-04900
query parameters
-
page
-
- Description
- Page number for paginated results
- Type
- integer
-
limit
-
- Description
- Number of results per page. Default 20. Max 20.
- Type
- integer
Responses
200 OK
Schema
- object
-
street_name
- Street namestring
-
Required
- array of objects
-
address_id
- Unique address idstring
-
formatted_number
- House number (and letter) combinedstring
-
letter
- House letterstring
-
number
- House numberinteger <int32>
-
- object
-
- object
-
StreetName
- Street namestring
-
Required
- array wrapped
-
- object
-
-
AddressId
- Unique address idstring
-
FormattedNumber
- House number (and letter) combinedstring
-
Letter
- House letterstring
-
Number
- House numberinteger <int32>
-
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
404 Not Found
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
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
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<StreetNumbers>
<Navigation self="https://api.bring.com/address/api/no/streets/NO-3019-04900/numbers&page=1" totalHits="4">
</Navigation>
<StreetName>Kolåsveien</StreetName>
<StreetNumberList>
<StreetNumber>
<AddressId>1817301</AddressId>
<FormattedNumber>1</FormattedNumber>
<Number>1</Number>
</StreetNumber>
<StreetNumber>
<AddressId>1817302</AddressId>
<FormattedNumber>1A</FormattedNumber>
<Letter>A</Letter>
<Number>1</Number>
</StreetNumber>
<StreetNumber>
<AddressId>1817303</AddressId>
<FormattedNumber>1B</FormattedNumber>
<Letter>B</Letter>
<Number>1</Number>
</StreetNumber>
<StreetNumber>
<AddressId>1817304</AddressId>
<FormattedNumber>2</FormattedNumber>
<Number>2</Number>
</StreetNumber>
</StreetNumberList>
</StreetNumbers>
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LIMIT",
"description": "The `limit` query param must be numeric"
}
{
"code": "INVALID_PAGE_NUMBER",
"description": "The 'page' query param must be numeric"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "LIMIT_LARGER_THAN_20",
"description": "The `limit` query param cannot be greater than 20"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "NOT_FOUND",
"description": "Not found"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>NOT_FOUND</Code>
<Description>Not found</Description>
</Error>
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>
Get street or place suggestions
https://api.bring.com/address/api/{country-code}/suggestions
Returns a list of streets and places matching input query. The following address types are supported:
- Street address
- Place
Returned suggestions are identified by either an street_id or an address_id. Depending on the returned suggestion type, the id will differ.
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.
NOTE: Before applying the city/postal code to the query to narrow the search, the street or place name should be as complete as possible. Using a query like q=ki, oslo
will not return all streets or places starting with "ki" in Oslo.
However, when used in combination with a full name, e.g. q=kirkeveien, oslo
, the appended city will return all streets in Oslo with name "Kirkeveien".
Request
header parameters
-
X-Mybring-API-Uid
Required -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
query parameters
-
q
Required -
- Description
- Street or place name to filter for
- Type
- 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
- When street name is common and present in multiple municipalities, you can narrow the search by providing the city (prefixed by ,)
q=storgata, son
- Street or place name with postal code
- When street name is common and present in multiple municipalities, you can narrow the search by providing the postal code (prefixed by ,)
q=storgata, 1555
-
page
-
- Description
- Page number for paginated results
- Type
- integer
-
limit
-
- Description
- Number of results per page. Default 10. Max 10.
- Type
- integer
Responses
200 OK
Schema
- object
-
Required
- array of objects
-
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 namestring
-
postal_code
- string
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- object
-
- object
-
Required
- array wrapped
-
- object
-
-
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 namestring
-
PostalCode
- string
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
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"
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<StreetsAndPlaces>
<Navigation self="https://api.bring.com/address/api/no/suggestions?page=1" totalHits="2">
</Navigation>
<StreetOrPlaceList>
<StreetOrPlace>
<City>Oslo</City>
<County>Oslo</County>
<Id>NO-0301-11704</Id>
<Name>Falsens gate</Name>
<PostalCode>0556</PostalCode>
<Type>STREET</Type>
</StreetOrPlace>
<StreetOrPlace>
<City>Sulitjelma</City>
<County>Nordland</County>
<Id>3419922</Id>
<Name>Stormo</Name>
<PostalCode>8230</PostalCode>
<Type>PLACE</Type>
</StreetOrPlace>
</StreetOrPlaceList>
</StreetsAndPlaces>
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LIMIT",
"description": "The `limit` query param must be numeric"
}
{
"code": "INVALID_PAGE_NUMBER",
"description": "The 'page' query param must be numeric"
}
{
"code": "INVALID_POSTAL_CODE",
"description": "Invalid postal code format. Postal code must be numeric and consist of 4 digits"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "LIMIT_LARGER_THAN_10",
"description": "The `limit` query param cannot be greater than 10"
}
{
"code": "QUERY_PARAM_MISSING_OR_EMPTY",
"description": "The 'q' query param cannot be null or empty"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>
Validate provided address
https://api.bring.com/address/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 -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
Accept
-
- Description
- Desired output media type
- Type
- string
- Enum
application/json
application/xml
- Default
application/json
path parameters
-
country-code
Required -
- Description
- Country code
- Type
- string
- Value
no
query parameters
-
street_or_place
-
- Description
- Street or place name. Required when querying for street and place address types
- Type
- string
- Example
street_or_place=kolåsveien
-
address_type
Required -
- Description
- Address type
- Type
- string
- Enum
street
place
postal_place
po_box
-
po_box_number
-
- Description
- Post office box number
- Type
- integer
- Example
po_box_number=1
-
po_box_facility
-
- Description
- Post office box facility name
- Type
- string
- Example
po_box_facility=Sentrum
-
postal_code
Required -
- Description
- Postal code
- Type
- string
- Example
postal_code=1555
-
city
-
- Description
- City. Required for postal place addresses
- Type
- string
- Example
city=Son
-
street_number
-
- Description
- Street number. Required for street addresses
- Type
- integer
- Example
street_number=9
-
letter
-
- Description
- House letter
- Type
- string
- Example
letter=B
Responses
200 OK
Schema
- Alternate address suggestionsobject
-
-
address_id
- Unique address idstring
-
city
- Citystring
- Coordinateobject
-
-
latitude
- WGS84 Latitudestring
-
longitude
- WGS84 Longitudestring
-
-
county
- County address is located instring
-
house_number
- House numberinteger <int32>
-
letter
- House letterstring
-
municipality
- Municipality address is located instring
-
place
- Place namestring
-
po_box_facility
- Post office box facility namestring
-
po_box_number
- Post office box numberinteger <int32>
-
postal_code
- Postal codestring
-
street_name
- Street namestring
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- Possible reasons why provided address was not foundarray of objects
-
code
- Validation error codestring
- 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 descriptionstring
-
- Alternate address suggestionsarray of objects
-
address_id
- Unique address idstring
-
city
- Citystring
- Coordinateobject
-
-
latitude
- WGS84 Latitudestring
-
longitude
- WGS84 Longitudestring
-
-
county
- County address is located instring
-
house_number
- House numberinteger <int32>
-
letter
- House letterstring
-
municipality
- Municipality address is located instring
-
place
- Place namestring
-
po_box_facility
- Post office box facility namestring
-
po_box_number
- Post office box numberinteger <int32>
-
postal_code
- Postal codestring
-
street_name
- Street namestring
-
type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
-
valid
Required - Address is validboolean
- object
-
- Alternate address suggestionsobject
-
-
AddressId
- Unique address idstring
-
City
- Citystring
- Coordinateobject
-
-
Latitude
- WGS84 Latitudestring
-
Longitude
- WGS84 Longitudestring
-
-
County
- County address is located instring
-
HouseNumber
- House numberinteger <int32>
-
Letter
- House letterstring
-
Municipality
- Municipality address is located instring
-
Place
- Place namestring
-
PostOfficeBoxFacility
- Post office box facility namestring
-
PostOfficeBoxNumber
- Post office box numberinteger <int32>
-
PostalCode
- Postal codestring
-
StreetName
- Street namestring
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
- Possible reasons why provided address was not foundarray wrapped
-
- Possible reasons why provided address was not foundobject
-
-
Code
- Validation error codestring
- 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 descriptionstring
-
- Alternate address suggestionsarray wrapped
-
- Alternate address suggestionsobject
-
-
AddressId
- Unique address idstring
-
City
- Citystring
- Coordinateobject
-
-
Latitude
- WGS84 Latitudestring
-
Longitude
- WGS84 Longitudestring
-
-
County
- County address is located instring
-
HouseNumber
- House numberinteger <int32>
-
Letter
- House letterstring
-
Municipality
- Municipality address is located instring
-
Place
- Place namestring
-
PostOfficeBoxFacility
- Post office box facility namestring
-
PostOfficeBoxNumber
- Post office box numberinteger <int32>
-
PostalCode
- Postal codestring
-
StreetName
- Street namestring
-
Type
- Address typestring
- Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
-
-
Valid
Required - Address is validboolean
400 Bad Request
Schema
- array of objects
-
code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
description
- string
-
- array
-
- object
-
-
Code
- string
- Enum
INVALID_QUERY_PARAM
INVALID_COUNTRY
INVALID_POSTAL_CODE_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
INVALID_POSTAL_CODE_FORMAT_FOR_COUNTRY
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
MISSING_POSTAL_CODE
INVALID_COUNTRY_CODE
UNSUPPORTED_COUNTRY_CODE
MISSING_SEARCH_EXPRESSION
-
Description
- string
-
429 Too Many Requests
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
Code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
Description
- string
-
500 Internal Server Error
Schema
-
code
- string
- Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
-
description
- string
- object
-
-
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
}
{
"reasons": [
{
"code": "INCORRECT_CITY",
"description": "Incorrect city"
}
],
"suggestions": [
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
}
],
"valid": false
}
{
"reasons": [
{
"code": "HOUSE_LETTER_DOES_NOT_EXIST",
"description": "Requested house letter does not exist"
}
],
"suggestions": [
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
}
],
"valid": false
}
{
"reasons": [
{
"code": "HOUSE_NUMBER_DOES_NOT_EXIST",
"description": "Requested house number does not exist"
}
],
"suggestions": [
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
}
],
"valid": false
}
{
"reasons": [
{
"code": "PLACE_DOES_NOT_EXIST",
"description": "Requested place not found"
}
],
"suggestions": [
{
"address_id": "3419922",
"city": "Sulitjelma",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Nordland",
"municipality": "Fauske",
"place": "Stormo",
"postal_code": "8230",
"type": "PLACE"
}
],
"valid": false
}
{
"reasons": [
{
"code": "PO_BOX_FACILITY_DOES_NOT_EXIST",
"description": "Requested post office box facility does not exist"
}
],
"suggestions": [
{
"address_id": "61899",
"city": "Oslo",
"coordinate": {
"latitude": "60.00012",
"longitude": "5.0033"
},
"county": "Oslo",
"municipality": "Oslo",
"po_box_facility": "Sentrum",
"po_box_number": 506,
"postal_code": "0105",
"type": "PO_BOX"
}
],
"valid": false
}
{
"reasons": [
{
"code": "PO_BOX_NUMBER_DOES_NOT_EXIST",
"description": "Requested post office box number does not exist"
}
],
"suggestions": [
{
"address_id": "61899",
"city": "Oslo",
"coordinate": {
"latitude": "60.00012",
"longitude": "5.0033"
},
"county": "Oslo",
"municipality": "Oslo",
"po_box_facility": "Sentrum",
"po_box_number": 506,
"postal_code": "0105",
"type": "PO_BOX"
}
],
"valid": false
}
{
"reasons": [
{
"code": "STREET_NAME_DOES_NOT_EXIST",
"description": "Requested street name not found"
}
],
"suggestions": [
{
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
}
],
"valid": false
}
{
"match": {
"address_id": "1817301",
"city": "Son",
"coordinate": {
"latitude": "60.0000",
"longitude": "5.0000"
},
"county": "Viken",
"house_number": 9,
"municipality": "Vestby",
"postal_code": "1555",
"street_name": "Kolåsveien",
"type": "STREET"
},
"valid": true
}
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>ADDRESS_NOT_FOUND</Code>
<Description>No matching address found, and no alternative suggestions available</Description>
</Reason>
</Reasons>
<Suggestions>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>INCORRECT_CITY</Code>
<Description>Incorrect city</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>HOUSE_LETTER_DOES_NOT_EXIST</Code>
<Description>Requested house letter does not exist</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>HOUSE_NUMBER_DOES_NOT_EXIST</Code>
<Description>Requested house number does not exist</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>PLACE_DOES_NOT_EXIST</Code>
<Description>Requested place not found</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>3419922</AddressId>
<City>Sulitjelma</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Nordland</County>
<Municipality>Fauske</Municipality>
<Place>Stormo</Place>
<PostalCode>8230</PostalCode>
<Type>PLACE</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>PO_BOX_FACILITY_DOES_NOT_EXIST</Code>
<Description>Requested post office box facility does not exist</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>61899</AddressId>
<City>Oslo</City>
<GeoCoordinate>
<Latitude>60.00012</Latitude>
<Longitude>5.0033</Longitude>
</GeoCoordinate>
<County>Oslo</County>
<Municipality>Oslo</Municipality>
<PostOfficeBoxFacility>Sentrum</PostOfficeBoxFacility>
<PostOfficeBoxNumber>506</PostOfficeBoxNumber>
<PostalCode>0105</PostalCode>
<Type>PO_BOX</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>PO_BOX_NUMBER_DOES_NOT_EXIST</Code>
<Description>Requested post office box number does not exist</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>61899</AddressId>
<City>Oslo</City>
<GeoCoordinate>
<Latitude>60.00012</Latitude>
<Longitude>5.0033</Longitude>
</GeoCoordinate>
<County>Oslo</County>
<Municipality>Oslo</Municipality>
<PostOfficeBoxFacility>Sentrum</PostOfficeBoxFacility>
<PostOfficeBoxNumber>506</PostOfficeBoxNumber>
<PostalCode>0105</PostalCode>
<Type>PO_BOX</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<GeoCoordinate>
</GeoCoordinate>
</Address>
<Reasons>
<Reason>
<Code>STREET_NAME_DOES_NOT_EXIST</Code>
<Description>Requested street name not found</Description>
</Reason>
</Reasons>
<Suggestions>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
</Suggestions>
</AddressValidation>
<?xml version="1.0" encoding="UTF-8"?>
<AddressValidation>
<Address>
<AddressId>1817301</AddressId>
<City>Son</City>
<GeoCoordinate>
<Latitude>60.0000</Latitude>
<Longitude>5.0000</Longitude>
</GeoCoordinate>
<County>Viken</County>
<HouseNumber>9</HouseNumber>
<Municipality>Vestby</Municipality>
<PostalCode>1555</PostalCode>
<StreetName>Kolåsveien</StreetName>
<Type>STREET</Type>
</Address>
<Reasons>
</Reasons>
<Suggestions>
</Suggestions>
<Valid>true</Valid>
</AddressValidation>
{
"code": "INVALID_ADDRESS_TYPE",
"description": "The 'address_type' query param requires one of the following values: [street, place, postal_place, po_box]"
}
{
"code": "INVALID_COUNTRY",
"description": "The provided country code is not supported"
}
{
"code": "INVALID_LETTER",
"description": "The 'letter' query param cannot be numeric"
}
{
"code": "INVALID_PO_BOX_NUMBER",
"description": "The 'po_box_number' query param must be numeric"
}
{
"code": "INVALID_QUERY_PARAM",
"description": "Invalid query param(s)"
}
{
"code": "INVALID_STREET_NUMBER",
"description": "The 'street_number' query param must be numeric"
}
{
"code": "MISSING_ADDRESS_TYPE",
"description": "The 'address_type' query param cannot be null"
}
{
"code": "MISSING_CITY_POSTAL_PLACE_ADDRESS",
"description": "The 'city' query param is mandatory when providing an 'address_type' postal place"
}
{
"code": "MISSING_OR_INVALID_POSTAL_CODE",
"description": "The 'postal_code' query param is missing or has an invalid postal code format. Postal code must be numeric and consist of 4 digits"
}
{
"code": "MISSING_PO_BOX_NUMBER",
"description": "'po_box_number' query param is mandatory when providing a po_box 'address_type'"
}
{
"code": "MISSING_STREET_NUMBER",
"description": "'street_number' query param is mandatory when providing a street 'address_type'"
}
{
"code": "MISSING_STREET_OR_PLACE",
"description": "The 'street_or_place' query param is mandatory when providing an 'address_type' of street or place"
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
{
"code": "RATE_LIMIT_EXCEEDED",
"description": "Request rate cannot exceed 40 requests per 1 second"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>RATE_LIMIT_EXCEEDED</Code>
<Description>Request rate cannot exceed 40 requests per 1 second</Description>
</Error>
{
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred"
}
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>INTERNAL_ERROR</Code>
<Description>An unexpected error occurred</Description>
</Error>