Navigate the map

Move the session's viewport — where you are looking and how close. Data availability follows the view: wide views expose more regional layers, close views unlock parcel-level data, and every query is scoped to the current viewport. Navigate as often as you need; each call replaces the view. Pass either a place name or a latitude/longitude center, never both. Every response reports the resulting zoom, the span in km, and whether parcels are queryable — read it and navigate again if the framing is wrong, rather than guessing a zoom up front.

post/v1/tools/navigate

Request

  • Base URL: https://api.ploti.ai
  • URL: https://api.ploti.ai/v1/tools/navigate
  • Auth: HTTP bearer

Request body

sessionIdstring required

The id start_session returned. Lost it? get_session without an id lists this workspace's open sessions.

placestring

An address, city, county or state the geocoder resolves, e.g. 'Winter Garden, FL'. The viewport frames the place's extent unless zoom is given.

latitudenumber

Latitude of the viewport's center in WGS84 decimal degrees (north positive), e.g. from tools.location.geocode() or a row's coordinates. Pass with longitude. The place to look at, never the user's own location.

longitudenumber

Longitude of the viewport's center in WGS84 decimal degrees (east positive, so negative across the US). Pass with latitude.

zoomnumber

How close to look, as a web-map zoom level: 3 country, 8 region (up to ~140 km across), 10 metro (up to ~35 km, the widest view where parcels are queryable), 13 city (~4 km), 15 neighborhood (~1 km), 17 block (~250 m); values between presets sit between their spans, and actual views are often narrower. With a place, centers on it at this zoom instead of framing its extent; with coordinates, 13 when left out.

Response

What the tool returned: its text, any images, and structured data.

textstring required
dataunknown

Changes

No recorded changes to this operation across all 1 revision of this API.