Skip to main content
GET
Query facility/location data

Query Parameters

source
string
required

Source ID to query.

Minimum string length: 1
category
string

Point category exact match, for example aed, public_facility, or school_elementary.

Minimum string length: 1
external_id
string

Exact external_id match for a single-record lookup. Unique per source, so at most one record is returned.

Minimum string length: 1
name_contains
string

Substring match against name. Case-insensitive for ASCII, literal match for non-ASCII (Japanese).

Minimum string length: 1
address_contains
string

Substring match against address. Same case-sensitivity semantics as name_contains.

Minimum string length: 1
bbox_south
number

South edge latitude of the bounding box. Must be supplied together with bbox_north/bbox_west/bbox_east.

Required range: -90 <= x <= 90
bbox_north
number

North edge latitude of the bounding box (bbox_south <= bbox_north).

Required range: -90 <= x <= 90
bbox_west
number

West edge longitude of the bounding box (bbox_west <= bbox_east; date-line wrap is not supported).

Required range: -180 <= x <= 180
bbox_east
number

East edge longitude of the bounding box.

Required range: -180 <= x <= 180
limit
integer
default:1000

Maximum number of items to return. Defaults to 1000.

Required range: 1 <= x <= 10000
offset
integer
default:0

Number of items to skip. Defaults to 0.

Required range: x >= 0

Response

Point query result.

points
object[]
required
total
integer
required
Required range: x >= 0
limit
integer
required
Required range: 1 <= x <= 10000
offset
integer
required
Required range: x >= 0