Skip to content

Proxy Setup

Fresh Source: docs.airtop.ai

Airtop supports integrated residential proxies and bring-your-own (BYO) proxy configurations, including domain-specific routing.

Airtop Integrated Proxy

Built-in residential proxies with country targeting and sticky sessions.

typescript
const session = await client.sessions.create({
  configuration: {
    proxy: {
      type: 'airtop',
      options: {
        country: 'US',
        sticky: true,
      },
    },
  },
});
python
session = client.sessions.create(
    configuration={
        "proxy": {
            "type": "airtop",
            "options": {
                "country": "US",
                "sticky": True,
            }
        }
    }
)

Proxy Options

OptionTypeDescription
countrystringISO country code (e.g., "US", "DE", "JP")
stickybooleanKeep the same IP across requests in the session

Custom (BYO) Proxy

Use your own proxy server.

typescript
const session = await client.sessions.create({
  configuration: {
    proxy: {
      type: 'custom',
      options: {
        url: 'http://username:password@proxy.example.com:8080',
      },
    },
  },
});
python
session = client.sessions.create(
    configuration={
        "proxy": {
            "type": "custom",
            "options": {
                "url": "http://username:password@proxy.example.com:8080"
            }
        }
    }
)

Domain-Specific Proxy Routing

Route different domains through different proxy configurations using patterns.

typescript
const session = await client.sessions.create({
  configuration: {
    proxy: {
      type: 'airtop',
      domainPatterns: [
        { pattern: '*.google.com', country: 'US' },
        { pattern: '*.amazon.co.uk', country: 'GB' },
        { pattern: '*.example.com', country: 'DE' },
      ],
    },
  },
});
python
session = client.sessions.create(
    configuration={
        "proxy": {
            "type": "airtop",
            "domainPatterns": [
                {"pattern": "*.google.com", "country": "US"},
                {"pattern": "*.amazon.co.uk", "country": "GB"},
                {"pattern": "*.example.com", "country": "DE"},
            ]
        }
    }
)

Proxy Cost

Proxy bandwidth is included in the credit cost. Using proxies costs additional credits proportional to bandwidth consumed. Airtop integrated proxies are generally more cost-effective than BYO for most use cases.

Best Practices

  1. Use sticky sessions when you need consistent IP across multiple page loads
  2. Match country to target site — use US proxy for US-targeted sites
  3. Use domain patterns when scraping multiple sites with different geo requirements
  4. Monitor credit usage — proxy bandwidth adds to costs
  5. Test without proxy first — many sites work fine without one

Unofficial SOP documentation for Airtop