Skip to content

Commit 15f80d8

Browse files
author
Nathaniel Henry
committed
Add a client-methods reference subsection to Getting Started.
1 parent 7b147bb commit 15f80d8

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

docs/getting_started.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,42 @@ raw = close.block_summary(geoid = "440070008001068", mode = "walk", output = "ra
128128
raw.data["results"][:3]
129129
```
130130

131+
## The client methods
132+
133+
Every data-getting method lives on the client; see the [API reference](api.rst) for
134+
full signatures.
135+
136+
Catalog and lookups (free, no key):
137+
138+
- {py:meth}`~closecity.Client.modes` — the travel modes: walk, bike, transit.
139+
- {py:meth}`~closecity.Client.destination_types` — the catalog of amenity categories and their numeric ids.
140+
- {py:meth}`~closecity.Client.places` — a city name to its GEOID and centre point.
141+
- {py:meth}`~closecity.Client.place_boundary` — the boundary polygon of a census place.
142+
- {py:meth}`~closecity.Client.vintage` — the data vintage.
143+
- {py:meth}`~closecity.Client.last_updated` — when the data was last refreshed.
144+
- {py:meth}`~closecity.Client.isochrone_meta` — isochrone modes, directions, and assumptions.
145+
- {py:meth}`~closecity.Client.health` — a service health check.
146+
147+
Travel times from a block or a point:
148+
149+
- {py:meth}`~closecity.Client.block_summary` — walk/bike/transit time from a block to each amenity type.
150+
- {py:meth}`~closecity.Client.point_summary` — the same, from a `lat`/`lon` point.
151+
- {py:meth}`~closecity.Client.block_pois` — the individual POIs reachable from a block, each with its travel time.
152+
- {py:meth}`~closecity.Client.point_pois` — the same, from a `lat`/`lon` point.
153+
154+
Points of interest:
155+
156+
- {py:meth}`~closecity.Client.pois_search` — search POIs by radius or bounding box.
157+
- {py:meth}`~closecity.Client.poi` — the details of one POI.
158+
- {py:meth}`~closecity.Client.poi_catchment` — the blocks that can walk to a POI (its catchment).
159+
160+
Whole areas:
161+
162+
- {py:meth}`~closecity.Client.blocks_query` — per-block travel times for a polygon, or a centre and radius.
163+
- {py:meth}`~closecity.Client.place_blocks` — per-block travel times for every block in a place.
164+
- {py:meth}`~closecity.Client.place_pois` — every POI within a place's boundary.
165+
- {py:meth}`~closecity.Client.isochrone` — travel-time contours from a block or a point.
166+
131167
## Handling errors
132168

133169
Problem responses become typed exceptions. Catch a specific one, or the

0 commit comments

Comments
 (0)