Addresses

Address Object
Changes since API version 2019-02-01
2019-10-08 - New Fields
Three new fields added to Address:full_name,phone_number, email.
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.
We currently support localization with Google.
Retrieve an 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.
1
GET /addresses/lookup?service=google&type=streetname&query=Karl%20Johans%20gate%2022 HTTP/1.1
2
Content-Type: application/json
3
Authorization: Bearer <jwt>
4
X-Builton-Api-Key: <builton-api-key>
5
Host: api.builton.dev
Copied!
1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
​
4
{
5
    "alias": "",
6
    "country": "Norway",
7
    "service": "google",
8
    "street_name": "Karl Johans gate 22",
9
    "city": "Oslo",
10
    "geo": [
11
        59.9130629,
12
        10.7402665
13
    ],
14
    "service_address_id": "ChIJ7ZkfWX1uQUYRLjlo7CGVLFo",
15
    "raw": {
16
        "geometry": {
17
            "viewport": {
18
                "northeast": {
19
                    "lat": 59.9143406802915,
20
                    "lng": 10.7415464302915
21
                },
22
                "southwest": {
23
                    "lat": 59.91164271970849,
24
                    "lng": 10.7388484697085
25
                }
26
            },
27
            "location": {
28
                "lat": 59.9130629,
29
                "lng": 10.7402665
30
            },
31
            "bounds": {
32
                "northeast": {
33
                    "lat": 59.9134037,
34
                    "lng": 10.7410763
35
                },
36
                "southwest": {
37
                    "lat": 59.91257969999999,
38
                    "lng": 10.7393186
39
                }
40
            },
41
            "location_type": "ROOFTOP"
42
        },
43
        "place_id": "ChIJ7ZkfWX1uQUYRLjlo7CGVLFo",
44
        "formatted_address": "Stortingsbygningen, Karl Johans gate 22, 0026 Oslo, Norway",
45
        "types": [
46
            "premise"
47
        ],
48
        "address_components": [
49
            {
50
                "long_name": "Stortingsbygningen",
51
                "short_name": "Stortingsbygningen",
52
                "types": [
53
                    "premise"
54
                ]
55
            },
56
            {
57
                "long_name": "22",
58
                "short_name": "22",
59
                "types": [
60
                    "street_number"
61
                ]
62
            },
63
            {
64
                "long_name": "Karl Johans gate",
65
                "short_name": "Karl Johans gate",
66
                "types": [
67
                    "route"
68
                ]
69
            },
70
            {
71
                "long_name": "Sentrum",
72
                "short_name": "Sentrum",
73
                "types": [
74
                    "political",
75
                    "sublocality",
76
                    "sublocality_level_1"
77
                ]
78
            },
79
            {
80
                "long_name": "Oslo",
81
                "short_name": "Oslo",
82
                "types": [
83
                    "postal_town"
84
                ]
85
            },
86
            {
87
                "long_name": "Oslo kommune",
88
                "short_name": "Oslo kommune",
89
                "types": [
90
                    "administrative_area_level_2",
91
                    "political"
92
                ]
93
            },
94
            {
95
                "long_name": "Oslo",
96
                "short_name": "Oslo",
97
                "types": [
98
                    "administrative_area_level_1",
99
                    "political"
100
                ]
101
            },
102
            {
103
                "long_name": "Norway",
104
                "short_name": "NO",
105
                "types": [
106
                    "country",
107
                    "political"
108
                ]
109
            },
110
            {
111
                "long_name": "0026",
112
                "short_name": "0026",
113
                "types": [
114
                    "postal_code"
115
                ]
116
            }
117
        ]
118
    },
119
    "zip_code": "0026"
120
}
Copied!

Nuts & Bolts - Previous

Common Object Fields

Next - Nuts & Bolts

Images

Last modified 2yr ago

Copy link

Contents

Address Object

Retrieve an Address