Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-mobile-proxy-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Mobile proxies route traffic through mobile carrier networks. Only recommended in advanced stealth use cases.
Mobile carrier IPs often route through shared regional gateways. Country targeting is the most reliable option; city and US state targeting are best-effort and may not match every third-party geolocation database.

Configuration

Create a mobile proxy with a target country:
import Kernel from '@onkernel/sdk';

const kernel = new Kernel();

const proxy = await kernel.proxies.create({
  type: 'mobile',
  name: 'my-us-mobile',
  config: {
    country: 'US'
  }
});

const browser = await kernel.browsers.create({
  proxy_id: proxy.id,
});

Configuration parameters

  • country - ISO 3166 country code. Must be provided when providing other targeting options.
  • state - US-only two-letter state code. Best-effort for mobile proxies.
  • city - Provider city alias, such as brooklyn or chicago. Best-effort for mobile proxies.
  • bypass_hosts (optional) - Array of hostnames that bypass the proxy and connect directly (max 100 entries)

Advanced targeting examples

Target by city

Route traffic through a specific city:
const proxy = await kernel.proxies.create({
  type: 'mobile',
  name: 'brooklyn-mobile',
  config: {
    country: 'US',
    state: 'NY',
    city: 'brooklyn'
  }
});
If the city alias is not matched, the API returns examples from the target state to help you find the correct value.

Target by state

Route traffic through a US state:
const proxy = await kernel.proxies.create({
  type: 'mobile',
  name: 'ny-mobile',
  config: {
    country: 'US',
    state: 'NY'
  }
});

Bypass hosts

Configure specific hostnames to bypass the proxy:
const proxy = await kernel.proxies.create({
  type: 'mobile',
  name: 'mobile-with-bypass',
  config: {
    country: 'US',
  },
  bypass_hosts: [
    'localhost',
    'metadata.google.internal',
    '*.internal.company.com',
  ],
});
See the overview for full bypass host rules and examples.