Addresses
We've made our Address Object versatile so you can use it the way you need it.
Attribute | Type | Description |
street_name | string | The street name of the Address. |
building | string | The building number of the Address. |
zip_code | string | The zip code of the Address. |
city | string | The city of the Address. |
country | string | The country of the Address. |
geo | array | The geo position of the Address. |
raw | object | All information from the service, e.g. address, country, zip code, etc. |
alias | string | The alias of the Address. |
organization_name | string | The name of the organization at the given address if applicable. |
service | string | The service used for Address. Default is Google. |
full_name | string | The full name of the person associated with the Address. e.g.: "Jane Doe". |
email | string | The email associated with the Address. |
Parameters
Request
Response
Arguments | Type | Description |
service | string | We currently support Google. |
query | string | Query is what you want to search for, e.g.: "Tordenskioldsgate 3, Oslo." |
type | string | Define your search parameter, i.e. street name, zip code, etc. |
GET /addresses/lookup?service=google&type=streetname&query=Karl%20Johans%20gate%2022 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <jwt>
X-Builton-Api-Key: <builton-api-key>
Host: api.builton.dev
HTTP/1.1 200 OK
Content-Type: application/json
{
"alias": "",
"country": "Norway",
"service": "google",
"street_name": "Karl Johans gate 22",
"city": "Oslo",
"geo": [
59.9130629,
10.7402665
],
"service_address_id": "ChIJ7ZkfWX1uQUYRLjlo7CGVLFo",
"raw": {
"geometry": {
"viewport": {
"northeast": {
"lat": 59.9143406802915,
"lng": 10.7415464302915
},
"southwest": {
"lat": 59.91164271970849,
"lng": 10.7388484697085
}
},
"location": {
"lat": 59.9130629,
"lng": 10.7402665
},
"bounds": {
"northeast": {
"lat": 59.9134037,
"lng": 10.7410763
},
"southwest": {
"lat": 59.91257969999999,
"lng": 10.7393186
}
},
"location_type": "ROOFTOP"
},
"place_id": "ChIJ7ZkfWX1uQUYRLjlo7CGVLFo",
"formatted_address": "Stortingsbygningen, Karl Johans gate 22, 0026 Oslo, Norway",
"types": [
"premise"
],
"address_components": [
{
"long_name": "Stortingsbygningen",
"short_name": "Stortingsbygningen",
"types": [
"premise"
]
},
{
"long_name": "22",
"short_name": "22",
"types": [
"street_number"
]
},
{
"long_name": "Karl Johans gate",
"short_name": "Karl Johans gate",
"types": [
"route"
]
},
{
"long_name": "Sentrum",
"short_name": "Sentrum",
"types": [
"political",
"sublocality",
"sublocality_level_1"
]
},
{
"long_name": "Oslo",
"short_name": "Oslo",
"types": [
"postal_town"
]
},
{
"long_name": "Oslo kommune",
"short_name": "Oslo kommune",
"types": [
"administrative_area_level_2",
"political"
]
},
{
"long_name": "Oslo",
"short_name": "Oslo",
"types": [
"administrative_area_level_1",
"political"
]
},
{
"long_name": "Norway",
"short_name": "NO",
"types": [
"country",
"political"
]
},
{
"long_name": "0026",
"short_name": "0026",
"types": [
"postal_code"
]
}
]
},
"zip_code": "0026"
}
Last modified 2yr ago