Skip to content

Available countries and regions ​

Returns currently available regions in a country → state/province → city hierarchy, with quality and scale ratings at country and state levels so you can filter targets by need. No authentication required.

Endpoint

This page documents the new areas2 API. Compared with the older flat list, it adds a tree structure plus successLevel (success-rate rating) and ipCountLevel (IP-count rating).

Endpoint ​

ItemValue
MethodGET
URLhttps://api2.ipmart.io/ipmart/common/areas2
AuthNone
Content-Typeapplication/json

Example:

text
https://api2.ipmart.io/ipmart/common/areas2

Request parameters ​

None.

Response structure ​

data is an object:

FieldTypeDescription
upTimeLongData update time (Unix timestamp in milliseconds)
countryListArrayCountry list

Hierarchy:

text
data
└─ countryList[]          # country
   ├─ successLevel        # success-rate level (country)
   ├─ ipCountLevel        # IP-count level (country)
   └─ stateList[]         # state / province
      ├─ successLevel     # success-rate level (state)
      └─ cityList[]       # city (no rating fields)

Country fields (countryList[]) ​

FieldTypeDescription
codeStringCountry code (e.g. US, AE)
cntryStringCountry name in English
cntryNameStringCountry name in Chinese
successLevelIntSuccess-rate level, 5–1 (see below)
ipCountLevelIntIP-count level, 5–1 (see below)
stateListArrayStates / provinces under this country

State / province fields (stateList[]) ​

FieldTypeDescription
stateStringState/province code or English key (for request parameters)
stateNameStringState/province display name
successLevelIntSuccess-rate level, 5–1 (supported at state level)
cityListArrayCities under this state

Note

States provide successLevel only — they do not include ipCountLevel.

City fields (cityList[]) ​

FieldTypeDescription
cityStringCity code or English key (for request parameters)
cityNameStringCity display name

Cities do not include success-rate or IP-count ratings.

Rating reference ​

successLevel (success-rate rating) ​

Higher values mean higher success rates:

LevelMeaning
5Success rate 95%+
4Success rate 90%+
3Success rate 80%+
2Success rate 70%+
1Success rate below 70%

Applies to: country and state/province.

ipCountLevel (IP-count rating) ​

Higher values mean a larger available IP pool:

LevelMeaning
5100,000+ IPs
410,000+ IPs
31,000+ IPs
2100+ IPs
1fewer than 100 IPs

Applies to: country only.

Tips

  • If needed, filter countries and states by successLevel and ipCountLevel to match the quality you want.
  • For overall live pool scale, see real-time online IP count.

Response example ​

Success ​

Truncated sample (the live response includes all countries / states / cities):

json
{
  "status": 200,
  "data": {
    "upTime": 1789219531759,
    "countryList": [
      {
        "code": "AE",
        "cntry": "United Arab Emirates",
        "cntryName": "阿拉伯联合酋长国",
        "successLevel": 5,
        "ipCountLevel": 4,
        "stateList": [
          {
            "state": "Abudhabi",
            "stateName": "Abudhabi",
            "successLevel": 5,
            "cityList": [
              {
                "city": "Abudhabi",
                "cityName": "Abudhabi"
              },
              {
                "city": "Alain",
                "cityName": "Alain"
              }
            ]
          },
          {
            "state": "Dubai",
            "stateName": "Dubai",
            "successLevel": 5,
            "cityList": [
              {
                "city": "Dubai",
                "cityName": "Dubai"
              }
            ]
          }
        ]
      },
      {
        "code": "US",
        "cntry": "United States",
        "cntryName": "美国",
        "successLevel": 5,
        "ipCountLevel": 5,
        "stateList": [
          {
            "state": "California",
            "stateName": "California",
            "successLevel": 5,
            "cityList": [
              {
                "city": "Losangeles",
                "cityName": "Losangeles"
              },
              {
                "city": "Sanfrancisco",
                "cityName": "Sanfrancisco"
              }
            ]
          }
        ]
      }
    ]
  }
}