Skip to content
Close API

Per-category travel times at many points

POST
/v1/point/summary

Fastest travel time to each destination category by mode, from the census block containing each of many lat/lon points. This is the batch form of GET /v1/point/summary, a POST on the same path. Each row carries its origin_lat and origin_lon, and origins maps each point to its resolved block with population and land area.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
PointSummaryBatch
object
mode
Any of:
Array<string>
origins
required
Origins

Origin lat/lon points (1-250)

Array<object>
PointOrigin
object
lat
required
Lat
number
>= -90 <= 90
lon
required
Lon
number
>= -180 <= 180
type
Any of:
Array<integer>
Example
{
  "mode": [
    "walk"
  ],
  "origins": [
    {
      "lat": 44.05,
      "lon": -123.09
    },
    {
      "lat": 44.06,
      "lon": -123.02
    }
  ],
  "type": [
    30
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

BatchPointSummaryResponse

POST /v1/point/summary (routers.batch.point_summary_batch)

object
errors
required
Errors
Array<object>
OriginError

One origin that could not be resolved in a batch call. Extra members carry the origin key: geoid (blocks), origin_lat/origin_lon (points), or dest_id (catchment). (routers.batch)

object
detail
required
Detail
string
type
required
Type

Error slug: block-not-found, no-block-data, point-not-covered, or poi-not-found

string
key
additional properties
any
origins
required
Origins
Array<object>
PointSummaryMeta

Per-origin block metadata for POST /v1/point/summary. (routers.batch)

object
land_area_m2
Any of:
number
origin_lat
required
Origin Lat
number
origin_lon
required
Origin Lon
number
population
Any of:
integer
resolved_block
required
Resolved Block

GEOID of the block containing the point

string
results
required
Results
Array<object>
BatchPointCategoryTime

A CategoryTime row tagged with its origin point. (routers.batch)

object
dest_type_id
required
Dest Type Id
integer
mode
required
Mode

Travel mode label, e.g. ‘walk’

string
origin_lat
required
Origin Lat
number
origin_lon
required
Origin Lon
number
travel_time
required
Travel Time

Minutes, capped at 30, 1 decimal

number
truncated
required
Truncated
Array<object>
PointOriginKey

The lat/lon that identifies a point origin in a batch. (routers.batch)

object
origin_lat
required
Origin Lat
number
origin_lon
required
Origin Lon
number
truncated_reason
Any of:
string
Example
{
  "errors": [],
  "origins": [
    {
      "land_area_m2": 45120,
      "origin_lat": 44.05,
      "origin_lon": -123.09,
      "population": 1187,
      "resolved_block": "410390020001010"
    }
  ],
  "results": [
    {
      "dest_type_id": 30,
      "mode": "walk",
      "origin_lat": 44.05,
      "origin_lon": -123.09,
      "travel_time": 6.5
    }
  ],
  "truncated": [],
  "truncated_reason": null
}

400

Section titled “400”

Invalid request (e.g. invalid-parameters, invalid-cursor, invalid-bbox, missing-location, missing-area, invalid-geometry, polygon-too-complex, missing-origins, too-many-origins)

ValidationProblem

400 invalid-parameters, carrying the offending fields. (core.problems, RequestValidationError handler)

object
detail
Any of:
string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
status
required
Status
integer
title
required
Title
string
type
required
Type

Problem type URI; the final path segment is the stable slug

string
key
additional properties
any

401

Section titled “401”

Missing or invalid API key (missing-key, invalid-key)

Problem

RFC 9457 problem detail. Served as application/problem+json. Additional members appear for some problem types (e.g. errors). (core.problems.problem)

object
detail
Any of:
string
status
required
Status
integer
title
required
Title
string
type
required
Type

Problem type URI; the final path segment is the stable slug

string
key
additional properties
any

403

Section titled “403”

Key disabled (account-disabled)

Problem

RFC 9457 problem detail. Served as application/problem+json. Additional members appear for some problem types (e.g. errors). (core.problems.problem)

object
detail
Any of:
string
status
required
Status
integer
title
required
Title
string
type
required
Type

Problem type URI; the final path segment is the stable slug

string
key
additional properties
any

429

Section titled “429”

Rate limited or token balance exhausted (rate-limited, tokens-exhausted); sets Retry-After

Problem

RFC 9457 problem detail. Served as application/problem+json. Additional members appear for some problem types (e.g. errors). (core.problems.problem)

object
detail
Any of:
string
status
required
Status
integer
title
required
Title
string
type
required
Type

Problem type URI; the final path segment is the stable slug

string
key
additional properties
any

503

Section titled “503”

Backend temporarily unavailable (debit-unavailable, store-unavailable); may set Retry-After

Problem

RFC 9457 problem detail. Served as application/problem+json. Additional members appear for some problem types (e.g. errors). (core.problems.problem)

object
detail
Any of:
string
status
required
Status
integer
title
required
Title
string
type
required
Type

Problem type URI; the final path segment is the stable slug

string
key
additional properties
any