Zipcode Area Search

Search postal code areas with full pagination support. Query by country, state, city, postal code, and geographic coordinates.

Endpoint: POST /biz/bigdata/data/zipcode/area

Parameters

Parameter	Type	Required	Description
countryCode	String	No*	ISO 3166-1 alpha-2 country code
country	String	No*	Country name
state	String	No*	State/province name
stateCode	String	No*	State/province code
city	String	No*	City name
suburbs	String	No*	Suburb/district name
zipCode	String	No*	Postal/zip code (exact match)
zipCodeStartWith	String	No*	Postal code prefix (LIKE prefix%)
zipCodeEndWith	String	No*	Postal code suffix (LIKE %suffix)
location	String	No*	Location name
lat	String	No*	Latitude (exact match)
lon	String	No*	Longitude (exact match)
pageNumber	Integer	No	Page number (default: 1)
pageSize	Integer	No	Page size (default: 30)

*At least one search parameter is required (excluding pagination parameters).

Request

curl -X POST "https://api.alaikis.com/std/biz/bigdata/data/zipcode/area" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d 'bizContent={"countryCode": "US", "state": "California", "pageNumber": 1, "pageSize": 10}'

Response

{
  "code": 200,
  "msg": "success",
  "data": {
    "content": [
      {
        "id": 1001,
        "country": "United States",
        "countryCode": "US",
        "state": "California",
        "stateCode": "CA",
        "city": "Los Angeles",
        "suburbs": "Beverly Hills",
        "zipCode": "90210",
        "location": "Beverly Hills",
        "latitude": "34.1030",
        "longitude": "-118.4100",
        "createdTime": "2024-01-15T10:30:00",
        "validAdministrativeType": "city",
        "isValid": true
      }
    ],
    "totalElements": 2530,
    "pageNumber": 0,
    "pageSize": 10
  }
}

Data Model

Field	Type	Description
id	Integer	Unique record ID
country	String	Country name
countryCode	String	ISO 3166-1 alpha-2 country code
state	String	State/province name
stateCode	String	State/province code
city	String	City name
suburbs	String	Suburb/district name
zipCode	String	Postal/zip code
location	String	Location description
latitude	String	Latitude in decimal degrees
longitude	String	Longitude in decimal degrees
createdTime	String	Record creation timestamp
validAdministrativeType	String	Administrative type validation
isValid	Boolean	Whether the record is validated

Pagination

The response uses a paginated structure:

Field	Type	Description
content	Array	Result records for current page
totalElements	Long	Total number of matching records
pageNumber	Integer	Current page number (0-based)
pageSize	Integer	Number of records per page

Error Codes

Code	Description
400	Invalid JSON format
406	No search parameters provided