List places - Placewise API

Request

Query Params

per_page

integer

optional

Number of results to be returned per request. See: API Pagination

page_no

integer

optional

Number of results page. See: API Pagination

>= 1

Default:

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params application/json

country

string

optional

country code

precision

enum<string>

optional

place precision type

Allowed values:

citypostcode

ids

array

optional

array of place id

cities

array[string]

optional

array of city names

postcodes

array[string]

optional

array of postcodes

radius

integer

optional

for fitlering by distance number in meters

latitude

number

optional

for fitlering by distance latitude of radius center

longitude

number

optional

for fitlering by distance longitude of radius center

Example

{
  "country": "string",
  "precision": "city",
  "ids": [
    1
  ],
  "cities": [
    "string"
  ],
  "postcodes": [
    "string"
  ],
  "radius": 0,
  "latitude": 0,
  "longitude": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

places

array[object (Place) {14}]

required

integer <uint64>

read-onlyrequired

Example:

precision

enum<string>

required

Allowed values:

citypostcode

country

string

required

ISO 3166-1 alpha-2

Example:

postcode

string | null

required

city

string | null

required

district

string | null

required

state

string | null

required

suburb

string | null

required

county

string | null

required

latitude

string

required

longitude

string

required

polygon

array [array] | null

required

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

pagination_info

object (PaginationInfo) | null

read-onlyrequired

count

integer

read-onlyrequired

Actual number of results returned in request

Example:

1000

total_count

integer

required

Number of all available results

>= 1

Example:

2050

per_page

integer

read-onlyrequired

Number of results returned per request

Example:

1000

total_pages

integer

read-onlyrequired

Number of all available pages

Example:

current_page

integer

read-onlyrequired

Example:

next_page

integer | null

read-onlyrequired

Next available page (null when it's a last page)

Example:

prev_page

integer | null

read-onlyrequired

Next available page (null when it's a first page)

Example:

null

is_first_page

boolean

read-onlyrequired

Example:

true

is_last_page

boolean

read-onlyrequired

Example:

false

is_out_of_range

boolean

read-onlyrequired

Is given per_page param out of range?

Example:

false

offset

integer

read-onlyrequired

Example:

Example

{
  "places": [
    {
      "id": 1,
      "precision": "city",
      "country": "NO",
      "postcode": "51912",
      "city": "South Laurettastead",
      "district": "Fort Felix",
      "state": "Oregon",
      "suburb": "Velma Point",
      "county": "Clay County",
      "latitude": "-25.3364",
      "longitude": "-152.5065",
      "polygon": null,
      "created_at": "2022-11-05T16:25:58.099512Z",
      "updated_at": "2022-11-15T16:25:58.099512Z"
    },
    {
      "precision": "city",
      "country": "NO",
      "postcode": "02962",
      "city": "Lake Maximillianfort",
      "district": "East Mya",
      "state": "North Dakota",
      "suburb": "Kaela Glens",
      "county": "Lincoln County",
      "latitude": "-14.3785",
      "longitude": "-141.699",
      "polygon": [
        [
          25.9829,
          83.5864
        ],
        [
          -52.6075,
          -88.4505
        ]
      ]
    }
  ],
  "pagination_info": {
    "total_count": 2050
  }
}

🟠422Invalid Parameters