Get Geocode - Google Curated Content

Google Curated Content

Download API definition:

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://dev-api.bentley.com/curated-content/google/geocode[?address][&components][&bounds][&language][&region][&extra_computations][&latlng][&result_type][&location_type]

Retrieves geocode information.

Request parameters

address

components

bounds

language

region

extra_computations

latlng

result_type

location_type

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.return-full-session-info+json is recommended.

Response 200 OK

json

{
    "results": [{
        "address_components": [{
                "long_name": "1600",
                "short_name": "1600",
                "types": [
                    "street_number"
                ]
            },
            {
                "long_name": "Amphitheatre Parkway",
                "short_name": "Amphitheatre Pkwy",
                "types": [
                    "route"
                ]
            },
            {
                "long_name": "Mountain View",
                "short_name": "Mountain View",
                "types": [
                    "locality",
                    "political"
                ]
            },
            {
                "long_name": "Santa Clara County",
                "short_name": "Santa Clara County",
                "types": [
                    "administrative_area_level_2",
                    "political"
                ]
            },
            {
                "long_name": "California",
                "short_name": "CA",
                "types": [
                    "administrative_area_level_1",
                    "political"
                ]
            },
            {
                "long_name": "United States",
                "short_name": "US",
                "types": [
                    "country",
                    "political"
                ]
            },
            {
                "long_name": "94043",
                "short_name": "94043",
                "types": [
                    "postal_code"
                ]
            },
            {
                "long_name": "1351",
                "short_name": "1351",
                "types": [
                    "postal_code_suffix"
                ]
            }
        ],
        "formatted_address": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA",
        "geometry": {
            "location": {
                "lat": 37.4222804,
                "lng": -122.0843428
            },
            "location_type": "ROOFTOP",
            "viewport": {
                "northeast": {
                    "lat": 37.4237349802915,
                    "lng": -122.083183169709
                },
                "southwest": {
                    "lat": 37.4210370197085,
                    "lng": -122.085881130292
                }
            }
        },
        "place_id": "ChIJRxcAvRO7j4AR6hm6tys8yA8",
        "plus_code": {
            "compound_code": "CWC8+W7 Mountain View, CA",
            "global_code": "849VCWC8+W7"
        },
        "types": [
            "street_address"
        ]
    }],
    "status": "OK"
}

Response 400 Bad Request

The 400 (Bad Request) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidGoogleCuratedContentRequest",
        "message": "Invalid request. Missing the 'address', 'components', 'latlng' or 'place_id' parameter."
    }
}

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

GetGeocodeResponse

status

GeocodeStatus

results

GeocodeResult[]

An array of geocoded address information and geometry information.

json

{
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/GeocodeStatus"
        },
        "results": {
            "type": "array",
            "description": "An array of geocoded address information and geometry information.",
            "items": {
                "$ref": "#/components/schemas/GeocodeResult"
            }
        }
    },
    "additionalProperties": false
}

GeocodeStatus

The status of the geocoding request.

String

ZERO_RESULTS

String

OVER_QUERY_LIMIT

String

REQUEST_DENIED

String

INVALID_REQUEST

String

UNKNOWN_ERROR

String

json

{
    "type": "string",
    "enum": [
        "OK",
        "ZERO_RESULTS",
        "OVER_QUERY_LIMIT",
        "REQUEST_DENIED",
        "INVALID_REQUEST",
        "UNKNOWN_ERROR"
    ],
    "description": "The status of the geocoding request."
}

GeocodeResult

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?