POST /geo/matrix
Compute a distance matrix
Durations and distances between 1 to 25 sources and 1 to 25 destinations (625 pairs at most), billed per pair. Served when its price is configured; otherwise 404. Scope `geo:route`. Billed per request from the prepaid balance; the answer carries a `receipt`. Auth: a secret key (`Authorization: Bearer gln_…`) from a server, or a browser key (`gln_pk_…`, in `?key=` or the Bearer header) from a page whose origin is declared on the key. A secret key sent with an `Origin` header, or in the URL, is refused (403 `secret_key_in_browser`, `secret_key_in_url`).
API key (Bearer), on the public API endpoint.
Request body
application/json · schema GeoMatrixRequest
| Field | Type | Description |
|---|---|---|
profile | "driving" | "walking" | "cycling" | "two_wheeler" | Travel mode (default driving). |
sources | array<GeoPlace> · required | 1 to 25 starting places. |
destinations | array<GeoPlace> | 1 to 25 arrival places (default: the sources). |
Responses
| Status | Description | Body |
|---|---|---|
200 | durations_s and distances_m tables (null: no path), resolved places, attribution and receipt | GeoMatrix |
422 | geo_matrix_too_large, geo_matrix_too_far, geo_coordinates_out_of_range, geo_coordinates_invalid, geo_address_not_found | Error |
401 | api_key_missing, api_key_invalid, api_key_revoked, api_key_ambiguous | Error |
402 | geo_balance_exhausted: the prepaid balance is used up | Error |
403 | scope_missing, secret_key_in_browser, secret_key_in_url, browser_key_origin_required, browser_key_origin_not_allowed, geo_test_adapter_live_refused | Error |
404 | not_found: Geo, or this operation, is not served to this account | Error |
429 | geo_rate_limited, geo_monthly_cap_reached, browser_key_daily_cap_reached (Retry-After) | Error |
503 | geo_unavailable, geo_operation_unavailable, platform_unavailable | Error |
504 | geo_upstream_timeout: retry | Error |
Examples
curl
curl -X POST "$GALON_API_BASE/geo/matrix" \
-H "Authorization: Bearer $GALON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sources": [[1]]}'