batch

Blocks that can reach many POIs

Every census block within reach of each of many POIs and its travel time, one row per (POI, block, mode). This is the batch form of GET /v1/pois/{dest_id}/catchment. Each row carries its origin dest_id.

post/v1/pois/catchment

Request

  • Base URL: https://api.close.city
  • URL: https://api.close.city/v1/pois/catchment
  • Auth: HTTP bearer

Request body

blockinteger[] nullable
dest_idsinteger[] required

POI destination ids (1-250)

max_minutesnumber nullable
modestring[] nullable

Response

Successful Response

truncatedinteger[] required

dest_ids skipped once the row budget was spent

truncated_reasonstring nullable

'insufficient-balance' or 'row-budget'; null if nothing was truncated

Changes

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