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

typescript

const results = await ss.logistics.geocoding.forward('350 Fifth Ave, New York', { limit: 3 })

Geocoding endpoints are API-only
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)

limit

integer

Max results (1–10). Default 5.

country

string

Country code filter (max 10 chars, e.g. US)

bbox

string

Bounding box filter as minLng,minLat,maxLng,maxLat (max 100 chars)

Error responses

400 Invalid query parameters

401 Unauthorized

402 Insufficient Tokens

429 Rate Limited

Reverse Geocode

GET

typescript

const addr = await ss.logistics.geocoding.reverse(40.7484, -73.9857)

Reverse geocoding is an API-only operation
Use the REST API or TypeScript SDK

Query param

Type

Description

lat required

number

Latitude (−90 to 90)

lng required

number

Longitude (−180 to 180)

Error responses

400 Invalid coordinates

401 Unauthorized

402 Insufficient Tokens

429 Rate Limited

Autocomplete

GET

typescript

const suggestions = await ss.logistics.geocoding.autocomplete('350 Fifth', {
  limit: 5,
  country: 'US',
  proximity: { lat: 40.75, lng: -73.99 },
})

Autocomplete is an API-only operation
Use the REST API or TypeScript SDK

Body field

Type

Description

q required

string

Search query for address suggestions (1–500 chars)

limit

integer

Max suggestions (1–10). Default 5.

country

string

Country code filter (max 10 chars, e.g. US)

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)

Error responses

400 Invalid body (validation error)

401 Unauthorized

402 Insufficient Tokens

429 Rate Limited