| Name |
Type |
Description |
Notes |
| gid |
str |
A scoped GID for this result. This can be passed to the place endpoint. Note that these are not always stable. For Geonames and Who's on First, these are usually stable, but for other sources like OSM, no stability is guaranteed. |
[optional] |
| source_id |
str |
An ID referencing the original data source (specified via source) for the result. These IDs are specific to the source that they originated from. For example, in the case of OSM, these typically look like way/123 or point/123. |
[optional] |
| label |
str |
A full, human-readable label. However, you may not necessarily want to use this; be sure to read the docs for name, locality, and region before making a decision. This field is mostly localized. The order of components is generally locally correct (ex: for an address in South Korea, the house number appears after the street name). However, components will use a request language equivalent if one exists (ex: Seoul instead of 서울 if lang=en). |
[optional] |
| layer |
PeliasLayer |
|
[optional] |
| name |
str |
The name of the place, the street address including house number, or label of similar relevance. If your app is localized to a specific region, you may get better display results by combining name, locality OR region (or neither?), and postal code together in the local format. Experiment with what works best for your use case. |
[optional] |
| accuracy |
str |
The accuracy of the geographic coordinates in the result. This value is a property of the result itself and won't change based on the query. A point result means that the record can reasonably be represented by a single geographic point. Addresses, venues, or interpolated addresses usually have point accuracy. Larger areas, such as a city or country, cannot be represented by a single point, so a centroid is given instead. |
[optional] |
| addendum |
PeliasGeoJSONPropertiesAddendum |
|
[optional] |
| continent |
str |
|
[optional] |
| continent_gid |
str |
|
[optional] |
| country |
str |
|
[optional] |
| country_gid |
str |
|
[optional] |
| neighbourhood |
str |
|
[optional] |
| neighbourhood_gid |
str |
|
[optional] |
| borough |
str |
|
[optional] |
| borough_gid |
str |
|
[optional] |
| postalcode |
str |
|
[optional] |
| street |
str |
|
[optional] |
| housenumber |
str |
|
[optional] |
| locality |
str |
The city, village, town, etc. that the place / address is part of. Note that values may not always match postal or local conventions perfectly. |
[optional] |
| locality_gid |
str |
|
[optional] |
| county |
str |
Administrative divisions between localities and regions. Useful for disambiguating nearby results with similar names. |
[optional] |
| region |
str |
Typically the first administrative division within a country. For example, a US state or a Canadian province. |
[optional] |
| region_a |
str |
The abbreviation for the region. |
[optional] |
from stadiamaps.models.pelias_geo_json_properties import PeliasGeoJSONProperties
# TODO update the JSON string below
json = "{}"
# create an instance of PeliasGeoJSONProperties from a JSON string
pelias_geo_json_properties_instance = PeliasGeoJSONProperties.from_json(json)
# print the JSON string representation of the object
print(PeliasGeoJSONProperties.to_json())
# convert the object into a dict
pelias_geo_json_properties_dict = pelias_geo_json_properties_instance.to_dict()
# create an instance of PeliasGeoJSONProperties from a dict
pelias_geo_json_properties_from_dict = PeliasGeoJSONProperties.from_dict(pelias_geo_json_properties_dict)[Back to Model list] [Back to API list] [Back to README]