Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion proxies/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ When no longer needed, delete the proxy configuration:
<DeleteProxySnippet />

<Info>
Deleting a proxy does not affect existing browser sessions that are currently using it. The configuration is only removed from your organization so it can't be used in future browser sessions.
Deleting a proxy immediately reconfigures associated browsers to route directly to the internet.
</Info>

## Limitations
Expand Down
122 changes: 114 additions & 8 deletions proxies/residential.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Residential proxies route traffic through real residential IP addresses. They su

## Configuration

Residential proxies support multiple targeting parameters:
Create a residential proxy with a target country:

<CodeGroup>

Expand All @@ -16,10 +16,9 @@ const kernel = new Kernel();

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

Expand All @@ -34,10 +33,9 @@ client = kernel.Kernel()

proxy = client.proxies.create(
type='residential',
name='my-la-residential',
name='my-us-residential',
config={
'country': 'US',
'city': 'los_angeles'
'country': 'US'
}
)

Expand All @@ -54,4 +52,112 @@ browser = client.browsers.create(
- **`state`** - Two-letter state code. Only supported for US.
- **`city`** - City name (lowercase, no spaces, e.g., `sanfrancisco`, `newyork`).
- **`zip`** - US ZIP code (5 digits). Conflicts with city and state.
- **`asn`** - Autonomous System Number. Conflicts with city and state.
- **`asn`** - Autonomous System Number. Conflicts with city and state.

## Advanced Targeting Examples

Kernel recommends using the least-specific targeting configuration that works for your use case. The more specific a configuration, the less available IPs there are, increasing the chance of a slow connection or no available connection (`no_peer` connection error).

### Target by City

Route traffic through a specific city:

<CodeGroup>

```typescript Typescript/Javascript
const proxy = await kernel.proxies.create({
type: 'residential',
name: 'la-residential',
config: {
country: 'US',
state: 'CA',
city: 'los_angeles'
}
});
```

```Python Python
proxy = client.proxies.create(
type='residential',
name='la-residential',
config={
'country': 'US',
'state': 'CA',
'city': 'los_angeles'
}
)
```

</CodeGroup>

<Note>
If the city name is not matched, the API will return the best 10 city names from the state to help you find the correct city identifier.
</Note>

### Target by State

Route traffic through a specific state:

<CodeGroup>

```typescript Typescript/Javascript
const proxy = await kernel.proxies.create({
type: 'residential',
name: 'ny-residential',
config: {
country: 'US',
state: 'NY'
}
});
```

```Python Python
proxy = client.proxies.create(
type='residential',
name='ny-residential',
config={
'country': 'US',
'state': 'NY'
}
)
```

</CodeGroup>

<Note>
If the state name is not matched, the API will return the most-available 10 states.
</Note>

### Target by ASN

Route traffic through a specific Autonomous System Number (ISP):

<CodeGroup>

```typescript Typescript/Javascript
const proxy = await kernel.proxies.create({
type: 'residential',
name: 'comcast-residential',
config: {
country: 'US',
asn: 'AS7922'
}
});
```

```Python Python
proxy = client.proxies.create(
type='residential',
name='comcast-residential',
config={
'country': 'US',
'asn': 'AS7922'
}
)
```

</CodeGroup>

<Note>
If the ASN is not matched, the API will return the most-available 10 examples.
</Note>