Query for postal code records based on a geometry string.
GET {{baseUrl}}/postalcodes/us/geometry?wkt=POINT(-117.852723 33.63799)&bufferDistance=50&bufferUnit=m
Get postal codes based on a WKT (well-known text) geometry string.
Examples:
- POINT(-122.40317865990883 45.585729937697515)
- LINESTRING (-122.40581795357949 45.58497908445598,-122.40325376176125 45.58627054581282)
- POLYGON ((-122.4032877944377 45.58629457984625,-122.40264406427413 45.585697658341736,-122.40184476598769 45.58610686936547,-122.40244558080703 45.586688769812724,-122.4032877944377 45.58629457984625))
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
wkt | string | (Required) The geometry of the location expressed in WKT (well-known text) format. | |
bufferDistance | number | Buffer distance expressed in 'bufferUnits.' | |
bufferUnit | string | The unit type to apply to the buffer (e.g., m=meters, km=kilometers, ft=feet, or mi=miles). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"$ref":"minim voluptate sed","$metadata":{"geogcs":{"epgs":"4269"},"recordSet":{"totalRecords":99,"bbox":{"xMax":-21981234.626704007,"xMin":55180771.69559774,"yMax":-21938817.93671584,"yMin":76591520.31415856}},"$geogcs":"enim ullamco q"},"postalCode":[{"fips":"enim sit","$ref":"magna commodo labore","id":"pariatur minim labore incididunt"},{"fips":"id sed","$ref":"ea reprehenderit consectetur est","id":"sint proident"}]}