Skip to main content
GET
/
public
/
user
/
zip_code
/
search
Search Zip Code
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/zip_code/search \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": [
    {
      "subdivision_id": "ru-irk",
      "zip_code_alias": "kt3",
      "zip_code_id": 123,
      "zip_code_node_count": 1234
    }
  ],
  "item_count": 1,
  "message": "Zip Code search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}

Authorizations

​
X-API-Private-Key
string
header
required

Private API key for user-level authentication.

​
X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

​
zip_code_id
integer

Filter by specific zip code ID

​
zip_code_alias
string

Filter by zip code alias

​
subdivision_id
string

Filter by subdivision ID

​
zip_code_node_count
integer

Filter by zip code node count

​
per_page
integer

Number of items per page for pagination

​
page
integer

Page number for pagination

​
sort_by
string

Key for sorting or random.

Response

200 - application/json

Successful Zip Code search

Zip Code search was successful.

​
data
object[]

Array of Zip Code items matching the search criteria up to the limit of per_page paramater.

​
item_count
integer

Total number of Zip Code items returned in the data field.

​
message
string

Status message for the search.

​
page
integer

Current page number of the search results returned.

​
per_page
integer

Number of Zip Code items returned per page.

​
total_count
integer

Total of Zip Code items that match the search filter.