Skip to main content
The Country object represents a geographic country entity in the Byteful system. It contains essential information about countries including their identifiers, names, geographic location, and special designations such as EU membership status.

Key Attributes

Object Relationships

The Country object is connected to several other objects in the Byteful API:
  • Continent: Each country belongs to a specific continent
  • Subdivisions: Countries contain multiple subdivisions (states, provinces, regions)
  • Cities: Countries contain multiple cities directly or through subdivisions
  • Proxies: Proxies are physically located within countries
  • Products: Products may be region-specific and tied to particular countries
  • Services: Services may be region-specific and tied to particular countries

Example Response

Usage Notes

  • The country_id uses the ISO 3166-1 alpha-2 standard (e.g., “us” for United States, “gb” for United Kingdom)
  • Country objects are most commonly used as filters when:
    • Searching for proxies in specific geographic regions
    • Generating residential proxy lists with geographic targeting
    • Purchasing region-specific proxy services
    • Analyzing usage patterns across different geographic regions
  • The country_is_european_union flag is particularly useful for compliance with GDPR and other EU-specific regulations
  • For more granular geographic targeting, combine country filters with subdivision and city filters
  • When working with products and services, country_id is commonly used to identify region-specific offerings

Geographic Hierarchy

Countries are part of a larger geographic hierarchy in the Byteful system:
  1. Continent: The broadest geographic division
  2. Country: Countries within continents
  3. Subdivision: States, provinces, or regions within countries
  4. City: Specific cities within subdivisions
This hierarchical structure allows for increasingly precise geographic targeting of proxies.