Skip to content

Oxylabs

Updated View as Markdown

Residential proxies, Web Scraper API and Web Unblocker under one connection. Each Oxylabs product has its own user, and an operation can only be enabled when the connection holds the user of the product it runs on.

What you can do (6)

What you can do

Available commands: 6 (6 read, 0 write). Enable only the commands your application needs.

Command Effect
Fetch a page from a residential IP — oxylabs.residential-fetch Read
Check where the residential exit leaves from — oxylabs.residential-location Read
Read Google search results — oxylabs.serp-search Read
Scrape one page as Markdown — oxylabs.web-scrape Read
Read store products — oxylabs.ecommerce Read
Fetch a hard-to-reach page — oxylabs.unblocked-fetch Read

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Oxylabs, then enter the issued values in the connection form below.

  1. Obtain credentials for your purchased Oxylabs product: Residential Proxy uses Proxy username/password, Web Scraper API uses API username/password, and Web Unblocker uses Unblocker username/password. Fill the matching pair, not your account password. Only enable commands for active products.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Residential proxy user Optional
Residential proxy password Optional
Web Scraper API user Optional
Web Scraper API password Optional
Web Unblocker user Optional
Web Unblocker password Optional

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "targetUrl": "https://example.com/",
    "country": "US",
    "state": "California"
  }
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Fetch a page from a residential IP — oxylabs.residential-fetch

Run Fetch a page from a residential IP with Oxylabs. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
targetUrl string Required Public page URL minLength: 1; maxLength: 4096; format: "uri"
country string Optional Country (two-letter code) pattern: "^[A-Za-z]{2}$"
state string Optional US state (name or two-letter code) minLength: 2; maxLength: 40
city string Optional City minLength: 2; maxLength: 60
includeEgress boolean Optional Also report the exit IP and its location

Full JSON Schema

Full JSON Schema

Example input

{
  "targetUrl": "https://example.com/",
  "country": "US",
  "state": "California"
}

At most 5 provider requests per invocation; timeout: 60 seconds.

Check where the residential exit leaves from — oxylabs.residential-location

Run Check where the residential exit leaves from with Oxylabs. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
country string Optional Country (two-letter code) pattern: "^[A-Za-z]{2}$"
state string Optional US state (name or two-letter code) minLength: 2; maxLength: 40
city string Optional City minLength: 2; maxLength: 60

Full JSON Schema

Full JSON Schema

Example input

{
  "country": "US",
  "state": "New York"
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Scrape one page as Markdown — oxylabs.web-scrape

Run Scrape one page as Markdown with Oxylabs. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
targetUrl string Required Public page URL minLength: 1; maxLength: 4096; format: "uri"
render boolean Optional Render JavaScript
country string Optional Country (two-letter code) pattern: "^[A-Za-z]{2}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "targetUrl": "https://example.com/"
}

At most 1 provider requests per invocation; timeout: 180 seconds.

Read store products — oxylabs.ecommerce

Run Read store products with Oxylabs. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
source string Required Store source enum: ["amazon_search","amazon_product","walmart_search","walmart_product","target_search","target_product","google_shopping_search"]
query string Optional Search query (search sources) minLength: 1; maxLength: 300
productId string Optional Product ID (product sources) pattern: "^[A-Za-z0-9-]{1,40}$"
url string Optional Product page URL (product sources) minLength: 1; maxLength: 2048; format: "uri"
country string Optional Country (two-letter code) pattern: "^[A-Za-z]{2}$"
limit integer Optional Product count minimum: 1; maximum: 20

Full JSON Schema

Full JSON Schema

Example input

{
  "source": "amazon_search",
  "query": "usb c charger",
  "limit": 5
}

At most 1 provider requests per invocation; timeout: 150 seconds.

Fetch a hard-to-reach page — oxylabs.unblocked-fetch

Run Fetch a hard-to-reach page with Oxylabs. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
targetUrl string Required Public page URL minLength: 1; maxLength: 4096; format: "uri"
render boolean Optional Render JavaScript
country string Optional Country (two-letter code) pattern: "^[A-Za-z]{2}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "targetUrl": "https://example.com/"
}

At most 4 provider requests per invocation; timeout: 180 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close