OppiziDeveloper
API ReferenceTargeting

Find routes around a point

GET
/client/carrier-routes/search

USPS carrier routes within a radius of a latitude and longitude — the same search the Oppizi map runs when you drop a pin on a store.

Pair it with the geocoder to start from a street address.

Pass each result's raw object straight into Set EDDM routes.

This endpoint caps results rather than paging them: it accepts first but has no skip. If totalCount is larger than what you got back, raise first — there is no second page to fetch.

Authorization

ClientBearer
AuthorizationBearer <token>

Client-scoped key as a Bearer JWT; always pinned to your own client.

In: header

Query Parameters

lat*string

Latitude (decimal degrees).

lng*string

Longitude (decimal degrees).

radius?string

Search radius in meters (default 3000, ≤20000).

first?string

Max routes (default 200, ≤500).

includePaths?string

true to include route polygons as [{lng,lat}] paths.

Response Body

application/json

curl -X GET "https://example.com/client/carrier-routes/search?lat=string&lng=string"
{  "success": true,  "data": {    "nodes": [      {        "zip": "60614",        "croute": "C021",        "zipName": "CHICAGO",        "residentCount": 512,        "businessCount": 14,        "totalCount": 526,        "raw": {          "ZIP": "60614",          "CROUTE": "C021",          "TOTAL_COUN": 526        }      }    ],    "totalCount": 1  }}
Empty
Empty
Empty
Empty
Empty