OBJECT

PopulatedPlace

A place with some population of inhabitants

link GraphQL Schema definition

1type PopulatedPlace {
2
3# The place native id
4id: ID!
85
5# The place WikiData id
6wikiDataId: ID
85
7# The place name
8name: String!
85
9# The place type
10placeType: PopulatedPlaceType!
85
11# The place elevation (meters) above sea level
12elevationMeters: Int
85
13# The place latittude (-90.0 to 90.0)
14latitude: Float
85
15# The place longitude (-180.0 to 180.0)
16longitude: Float
85
17# The place population
18population: Int!
85
19# The place timezone id
20timezone: String!
85
21# The place's country
22country: Country!
85
23# The place's region
24region: CountryRegion
85
25# The distance result from some location-based query
26# This field has two forms:
27# - As a property (e.g., place.distance), returns the distance as part of a query
28# returning places sorted by distance.
29# - As a function (e.g., place.distance(toPlaceId), returns the distance to the
30# specified place.
31#
32# Arguments
33# toPlaceId: The distance to this place
34# distanceUnit: The unit of distance to use
35distance(toPlaceId: ID, distanceUnit: DistanceUnit): Float
85
36# The place containing this place, if any
37locatedIn: PopulatedPlace
85
38# Find nearby populated places
39#
40# Arguments
41# radius: The location radius within which to find places
42# distanceUnit: The unit of distance to use
43# countryIds: Only places in these countries
44# excludedCountryIds: Only places NOT in these countries
45# namePrefix: Only places whose names start with this prefix. If
46# language is set, the prefix will be matched on the name as it appears in that
47# language.
48# namePrefixDefaultLangResults: When name-prefix matching,
49# whether or not to match on names in the default language if a non-default
50# language is requested.
51# minPopulation: Only places having at least this population
52# maxPopulation: Only places having no more than this population
53# timeZoneIds: Only places in these time-zones
54# types: Only places for these types
55# sort: How to sort place results
56# Format: ±SORT_FIELD,±SORT_FIELD
57# where SORT_FIELD = countryCode | elevation | name | population
58# first: How many results to retrieve from the beginning (or
59# after the 'after' cursor, if specified)
60# after: The cursor id after which to get results
61# last: How many results to retrieve from the end (or before the
62# 'before' cursor, if specified)
63# before: The cursor id before which to get results
64# includeDeleted: Whether to include any places marked deleted
65nearbyPopulatedPlaces(
66radius: Float,
67distanceUnit: DistanceUnit,
68countryIds: [ID],
69excludedCountryIds: [ID],
70namePrefix: String,
71namePrefixDefaultLangResults: Boolean,
72minPopulation: Int,
73maxPopulation: Int,
74timeZoneIds: [ID],
75types: [String],
76sort: String,
77first: Int,
78after: String,
79last: Int,
80before: String,
81includeDeleted: IncludeDeletedFilterType
82): NearbyPopulatedPlacesConnection
85
83# If this place has been marked deleted
84deleted: Boolean!
86
87}