Search docs ⌘K
esc
Type to search across all documentation pages
Logistics

Geocoding

Convert between addresses and coordinates. Forward geocoding turns text into lat/lng, reverse geocoding turns lat/lng into addresses. All routes live under /logistics/* and require a token with logistics:read or logistics:write scope.

Forward Geocode

GET
/logistics/geocoding/forward
logistics:read0.0000018 tokens

Convert an address string to coordinates.

curl
curl https://api.saasignal.saastemly.com/logistics/geocoding/forward?q=350+Fifth+Ave \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
typescript
const results = await ss.logistics.geocoding.forward('350 Fifth Ave, New York', { limit: 3 })
  1. Geocoding endpoints are API-only
  2. Use the REST API or TypeScript SDK to geocode addresses
Query param
Type
Description
q required
string
Address or place name to geocode (1–500 chars)
1–500 chars
limit
integer
Max results (1–10). Default 5.
range ≥1 .. ≤10default 5
country
string
Country code filter (max 10 chars, e.g. US)
max 10 chars
bbox
string
Bounding box filter as minLng,minLat,maxLng,maxLat (max 100 chars)
max 100 chars
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Reverse Geocode

GET
/logistics/geocoding/reverse
logistics:read0.0000018 tokens

Convert coordinates to an address.

curl
curl https://api.saasignal.saastemly.com/logistics/geocoding/reverse?lat=40.7128&lng=-74.0060 \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
typescript
const addr = await ss.logistics.geocoding.reverse(40.7484, -73.9857)
  1. Reverse geocoding is an API-only operation
  2. Use the REST API or TypeScript SDK
Query param
Type
Description
lat required
number
Latitude (−90 to 90)
range ≥-90 .. ≤90
lng required
number
Longitude (−180 to 180)
range ≥-180 .. ≤180
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Autocomplete

POST
/logistics/geocoding/autocomplete
logistics:read0.0000018 tokens

Live address suggestions as the user types.

curl
curl -X POST https://api.saasignal.saastemly.com/logistics/geocoding/autocomplete \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"q":"..."}'
json — 200 OK
{ "status": "ok" }
typescript
const suggestions = await ss.logistics.geocoding.autocomplete('350 Fifth', {
  limit: 5,
  country: 'US',
  proximity: { lat: 40.75, lng: -73.99 },
})
  1. Autocomplete is an API-only operation
  2. Use the REST API or TypeScript SDK
Body field
Type
Description
q required
string
Search query for address suggestions (1–500 chars)
1–500 chars
limit
integer
Max suggestions (1–10). Default 5.
range ≥1 .. ≤10default 5
country
string
Country code filter (max 10 chars, e.g. US)
max 10 chars
proximity
object
Bias results near a point: { lat: number (−90 to 90), lng: number (−180 to 180) }
language
string
Response language code (max 10 chars, e.g. en)
max 10 chars
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited