Galon Cloud
Galon API v1

/geo/geocode

Base URL https://api.galon.ai/v1 · export GALON_API_BASE="https://api.galon.ai/v1"

GET /geo/geocode

Geocode an address or GPS text

Turn an address, a place name or GPS text into points. Scope `geo:geocode`. 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.

Parameters

NameInTypeDescription
qquerystring · requiredAddress or place, 1 to 200 characters, or GPS text.
limitqueryintegerResults, 1 to 20 (default 5).
languagequery"en" | "fr" | "es" | "de" | "pt" | "it" | "ar" | "zh"Language of the names.
latquerynumberBias near this latitude (with lon).
lonquerynumberBias near this longitude (with lat).
countryquerystringISO 3166-1 alpha-2 filter.

Responses

StatusDescriptionBody
200FeatureCollection of points, attribution and receiptGeoFeatureCollection
422geo_query_invalid, geo_coordinates_out_of_range, geo_coordinates_invalidError
401api_key_missing, api_key_invalid, api_key_revoked, api_key_ambiguousError
402geo_balance_exhausted: the prepaid balance is used upError
403scope_missing, secret_key_in_browser, secret_key_in_url, browser_key_origin_required, browser_key_origin_not_allowed, geo_test_adapter_live_refusedError
404not_found: Geo, or this operation, is not served to this accountError
429geo_rate_limited, geo_monthly_cap_reached, browser_key_daily_cap_reached (Retry-After)Error
503geo_unavailable, geo_operation_unavailable, platform_unavailableError
504geo_upstream_timeout: retryError

Examples

curl

curl -X GET "$GALON_API_BASE/geo/geocode" \
  -H "Authorization: Bearer $GALON_API_KEY"