CTRL+K
Loading
https://api.apifreaks.com/v1.0/zipcode/search/radius
$ pip install requests
Click Test it to start the request and see the response here!
| Field | Type | Requirement | Description |
|---|---|---|---|
| total_results | Number | Mandatory | Total number of ZIP codes or postal codes found within the specified radius. |
| total_pages | Number | Mandatory | Total number of pages available. Each page contains up to 500 results. |
| current_page | Number | Mandatory | Current page number in the paginated response. |
| current_page_size | Number | Mandatory | Number of results returned in the current page. |
| results | Array | Mandatory | Array of ZIP code objects within the radius. |
"results" array contains objects with the following fields
| Field | Type | Requirement | Description |
|---|---|---|---|
| code | String | Mandatory | Postal/ZIP code of the location. |
| region | String | Mandatory | Region/state/province where the postal code is located. |
| region_code | String | Mandatory | ISO or internal code representing the region. |
| city | String | Mandatory | City associated with the ZIP code. |
| district | String | Optional | District, locality, or neighborhood associated with the ZIP code, if available. |
| distance | Float | Mandatory | Distance from the central point in the unit specified in the request. |