Decodo Help Documentation

https://help.decodo.com/docs
Admin
Comprehensive help documentation for Decodo, featuring guides for residential, mobile, datacenter,...
Tokens:537,716
Snippets:4,081
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Quick start: setup, scrape, and search commands

Source: https://help.decodo.com/docs/cli

Run these commands after installing the CLI to authenticate and perform your first scrape and search. The setup command saves your token to config, scrape fetches a URL, and search queries the API.

```bash
decodo setup
decodo scrape https://ip.decodo.com
decodo search "decodo scraping api"
```

--------------------------------

### Install the Decodo Go SDK

Source: https://help.decodo.com/docs/go-sdk

Use `go get` to install the Decodo Go SDK package.

```bash
go get github.com/decodo/sdk-go
```

--------------------------------

### Example prompt: Get YouTube video metadata and subtitles

Source: https://help.decodo.com/docs/agent-skills

Example prompt to get metadata and subtitles for a YouTube video.

```text
Get the metadata and subtitles for this YouTube video: youtube.com/watch?v=dQw4w9WgXcQ
```

--------------------------------

### Quick start: scrape with GoogleSearchParams

Source: https://help.decodo.com/docs/python-sdk

Example main.py that imports the Decodo client and parameter classes, configures the client with the token from the environment, and performs a Google search scrape with parsing enabled.

```python
# main.py
from decodo import (
    DecodoClient,
    DecodoConfig,
    GoogleSearchParams,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token=os.environ["DECODO_TOKEN"],
        ),
    )
)

result = client.web_scraping_api.scrape(
    GoogleSearchParams(
        query="coffee shops",
        geo="United States",
        parse=True,
    )
)

print(result)
```

--------------------------------

### Go proxy setup with net/http

Source: https://help.decodo.com/docs/code-integration

Uses net/http and net/url to make a GET request through the Decodo proxy. Replace 'username' and 'password' with your credentials.

```Go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
)

const 
	resourceUrl = "http://ip.decodo.com/json"
	proxyHost   = "gate.decodo.com:7000"
	username    = "username"
	password    = "password"
)

func main() {
	proxyUrl := &url.URL{
		Scheme: "http",
		User:   url.UserPassword(username, password),
		Host:   proxyHost,
	}

	client := http.Client{
		Transport: &http.Transport{
			Proxy: http.ProxyURL(proxyUrl),
		},
	}

	resp, err := client.Get(resourceUrl)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()

	var body map[string]interface{}
	if err = json.NewDecoder(resp.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}

	fmt.Println(body)
}
```

--------------------------------

### Response example for starting a crawl

Source: https://help.decodo.com/docs/web-data-api-crawl-quick-start

Example JSON response from the POST /crawl request. Contains the crawl_id, status, and links to status and results.

```json
{
    "target": "crawl",
    "url": "https://decodo.com/",
    "created_at": "2026-10-08 07:14:45",
    "crawl_id": "{crawl_id}",
    "status": "pending",
    "crawl_status": "https://data.decodo.com/v1/crawl/{crawl_id}/status",
    "results_tasks": "https://data.decodo.com/v1/crawl/{crawl_id}",
    "results_content": "https://data.decodo.com/v1/crawl/{crawl_id}?type=content"
}

```

--------------------------------

### C# proxy setup with HttpClient

Source: https://help.decodo.com/docs/code-integration

Uses WebProxy and HttpClientHandler to make an async GET request through the Decodo proxy. Replace 'username' and 'password' with your credentials.

```C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static void Main(string[] args)
    {
        Task t = new Task(DownloadPageAsync);
        t.Start();
        Console.ReadLine();
    }

    static async void DownloadPageAsync()
    {
        string page = "http://ip.decodo.com/json";

        var proxy = new WebProxy("gate.decodo.com:7000")
        {
            UseDefaultCredentials = false,

            Credentials = new NetworkCredential(
                userName: "username",
                password: "password")
        };

        var httpClientHandler = new HttpClientHandler()
        {
            Proxy = proxy,
        };

        var client = new HttpClient(handler: httpClientHandler, disposeHandler: true);
        var response = await client.GetAsync(page);
        using (HttpContent content = response.Content)
        {
            string result = await content.ReadAsStringAsync();
            Console.WriteLine(result);
            Console.WriteLine("Press any key to exit.");
            Console.ReadKey();

        }
    }
}
```

--------------------------------

### Test Decodo CLI setup with scrape and search commands

Source: https://help.decodo.com/docs/cli

Run these commands after installing and authenticating the Decodo CLI. The scrape command fetches a URL as Markdown by default, and the search command performs a web search with pagination and parsing. If an authentication error appears, verify the Basic Auth token in the dashboard.

```bash
decodo scrape https://ip.decodo.com
decodo google-search "top articles hacker news" --page-count 5 --parse
```

--------------------------------

### Create a new project and install dependencies

Source: https://help.decodo.com/docs/python-sdk

Commands to create a new project directory, navigate into it, install the SDK, and create the main.py file.

```bash
mkdir scrape-with-decodo
cd scrape-with-decodo
pip install decodo-sdk
touch main.py
```

--------------------------------

### Example prompt: Get Amazon product price

Source: https://help.decodo.com/docs/agent-skills

Example prompt to get the current price of Amazon product B09H74FXNW and find the cheapest seller.

```text
What is the current price of Amazon product B09H74FXNW? Find the cheapest seller.
```

--------------------------------

### Create a new Go project for the SDK

Source: https://help.decodo.com/docs/go-sdk

Commands to create a new Go project directory, initialize the module, install the SDK, and create the main.go file.

```bash
mkdir scraper
cd scraper
go mod init scraper
go get github.com/decodo/sdk-go
touch main.go
```

--------------------------------

### Create a new project for Decodo SDK

Source: https://help.decodo.com/docs/typescript-sdk

Commands to create a new project directory, initialize npm, install the SDK, and create the main.js file.

```bash
mkdir scrape-with-decodo
cd scrape-with-decodo
npm init -y
npm install --save @decodo/sdk-ts
touch main.js
```

--------------------------------

### Response example for listing crawled URLs (results_tasks endpoint)

Source: https://help.decodo.com/docs/web-data-api-crawl-status-results-cancellation

Shows the JSON response from GET https://data.decodo.com/v1/crawl/{crawl_id}. Each URL entry includes task_id, status, timestamps, url, depth, parent_url, and links to crawl_status, results_tasks, and results_content. The depth field indicates the number of link hops from the starting URL, and parent_url is the page where the URL was found.

```json
{
  "crawl_id": "{crawl_id}",
  "url": [
    {
      "task_id": "7513859416597222401",
      "status": "done",
      "created_at": "2026-10-08 07:14:45",
      "updated_at": "2026-10-08 07:14:51",
      "url": "https://decodo.com/",
      "depth": 0,
      "crawl_status": "https://data.decodo.com/v1/crawl/{crawl_id}/status",
      "results_tasks": "https://data.decodo.com/v1/crawl/{crawl_id}",
      "results_content": "https://data.decodo.com/v1/crawl/{crawl_id}?type=content"
    },
    {
      "task_id": "7513859440462819329",
      "status": "done",
      "created_at": "2026-10-08 07:14:51",
      "updated_at": "2026-10-08 07:14:59",
      "url": "https://decodo.com/proxies/residential-proxies",
      "depth": 1,
      "parent_url": "https://decodo.com/",
      "crawl_status": "https://data.decodo.com/v1/crawl/{crawl_id}/status",
      "results_tasks": "https://data.decodo.com/v1/crawl/{crawl_id}",
      "results_content": "https://data.decodo.com/v1/crawl/{crawl_id}?type=content"
    }
  ]
}
```

--------------------------------

### Run decodo setup to authenticate

Source: https://help.decodo.com/docs/cli

Run `decodo setup` to authenticate when no auth token is found.

```bash
decodo setup
```

--------------------------------

### Go request example

Source: https://help.decodo.com/docs/datacenter-pay-per-gb-proxy-quick-start

Go example using net/http to send a request through the datacenter proxy.

```go
package main

import (
    "log"
    "net/http"
    "net/url"
)

   func main() {
     proxyUrl, err := url.Parse("http://username:password@dc.decodo.com:10000")
     if err != nil {
       log.Fatalln(err)
     }

     client := &http.Client{
       Transport: &http.Transport{Proxy: http.ProxyURL(proxyUrl)},
     }
     req, err := http.NewRequest("GET", "https://ip.decodo.com/json", nil)
     if err != nil {
       log.Println(err)
     }

     res, err := client.Do(req)
     log.Println(res)

     if err != nil {
       log.Println(err)
     }
   }
```

--------------------------------

### Run CLI without installing

Source: https://help.decodo.com/docs/cli

Use npx to run the CLI without a global install. The example shows checking the version and scraping with a token from an environment variable.

```bash
npx @decodo/cli --version
npx @decodo/cli scrape https://ip.decodo.com --token "$DECODO_AUTH_TOKEN"
```

--------------------------------

### Example build file location

Source: https://help.decodo.com/docs/mcp

Example of the full path to the built index.js file. Your actual path will differ based on your user and project location.

```text
/Users/your.user/projects/decodo-mcp/build/index.js
```

--------------------------------

### Response example for crawl status

Source: https://help.decodo.com/docs/web-data-api-crawl-quick-start

Example JSON response from the GET status endpoint. Shows status 'done' and counts of discovered, completed, failed, and in-flight pages.

```json
{
    "target": "crawl",
    "url": "https://decodo.com/",
    "created_at": "2026-10-08 07:14:45",
    "crawl_id": "{crawl_id}",
    "status": "done",
    "sitemap_status": "skip",
    "output": "markdown",
    "discovered": 2,
    "completed": 2,
    "failed": 0,
    "in_flight": 0,
    "sitemaps": 0,
    "requests": 2
}

```

--------------------------------

### Start a crawl with cURL

Source: https://help.decodo.com/docs/web-data-api-crawl-introduction

Use this cURL command to start a crawl by POSTing to the /crawl endpoint. Replace the TOKEN value with your API key. The example sets a limit of 2 pages, max_depth of 1, and skips the sitemap.

```bash
#replace the TOKEN value with your API KEY
curl --request 'POST' \
      --url 'https://data.decodo.com/v1/crawl' \
      --header 'Accept: application/json' \
      --header 'Authorization: Bearer TOKEN VALUE' \
      --header 'Content-Type: application/json' \
      --data '
    {
    "url": "https://decodo.com",
    "limit": 2,
    "max_depth": 1,
    "sitemap": "skip"
    }
'

```

--------------------------------

### Authentication methods

Source: https://help.decodo.com/docs/cli

Shows three ways to authenticate: interactive setup that saves a token to config, setting an environment variable, and a per-command token override. Precedence is --token flag, then env var, then saved config.

```bash
# Interactive - saves token to config
decodo setup

# Environment variable - no saved config required
export DECODO_AUTH_TOKEN='your-token'

# Per-command override
decodo whoami --token 'your-token'
```

--------------------------------

### Node.js proxy setup with axios

Source: https://help.decodo.com/docs/code-integration

Uses the axios library to make a GET request through the Decodo proxy. Replace 'username' and 'password' with your credentials.

```Node.js
const axios = require("axios");

const url = "http://ip.decodo.com/json";
const resp = axios.get(url, {
    proxy: {
        host: 'gate.decodo.com',
        port: 7000,
        auth: {
            username: 'username',
            password: 'password'
        }
    }
    
}). then(resp => {
    console.log(resp.data);
});
```

--------------------------------

### Go: Set proxy connection parameters

Source: https://help.decodo.com/docs/code-integration

Configure the resource URL, proxy host, username, and password for Go. Replace the placeholder values with your actual credentials.

```Go
resourceUrl = "http://ip.decodo.com/json"
	proxyHost   = "gate.decodo.com:7000"
	username    = "username"
	password    = "password"
```

--------------------------------

### Python proxy setup with requests

Source: https://help.decodo.com/docs/code-integration

Uses the requests library to make a GET request through the Decodo proxy. Replace 'username' and 'password' with your credentials.

```Python
import requests

url = 'http://ip.decodo.com/json'
username = 'username'
password = 'password'

proxy = f'http://{username}:{password}@gate.decodo.com:7000'
  
response = requests.get(url, proxies={'http': proxy, 'https': proxy})

print(response.text)
```

--------------------------------

### decodo setup

Source: https://help.decodo.com/docs/cli

Interactively saves the Basic Auth token for authentication.

```APIDOC
## decodo setup

### Description
Interactively saves the Basic Auth token for authentication.

### Command
`decodo setup`

### Output
Confirmation that the token has been saved.
```

--------------------------------

### Get an IP from a random location (US) with a rotating session

Source: https://help.decodo.com/docs/free-proxy-advanced-parameters

cURL example to connect to the backconnect endpoint with rotating session, using only username and password.

```APIDOC
## GET dc.decodo.com:10000

### Description
Connects to the backconnect endpoint with a rotating session, using only username and password. The IP is selected from a random location (with Free Proxies, the only available location is the US).

### Method
GET

### Endpoint
dc.decodo.com:10000

### Authentication
Username and password (proxy user credentials).

### Request Example
```bash
curl -U "username:password" -x "dc.decodo.com:10000" "https://ip.decodo.com/json?provider=IPinfo"
```

### Response
Returns IP information in JSON format (e.g., from IPinfo).
```

--------------------------------

### Scrape Google search results with the Decodo Go SDK

Source: https://help.decodo.com/docs/go-sdk

Example main.go that creates a client, sets up Google Search parameters, and scrapes results. Requires the DECODO_TOKEN environment variable to be set.

```go
// main.go
package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/decodo/sdk-go"
)

func main() {
	client := decodo.NewClient(decodo.Config{
		WebScrapingAPI: &decodo.WebScrapingAPIConfig{
			Token: os.Getenv("DECODO_TOKEN"),
		},
	})

	params := decodo.NewGoogleSearchParams()
	params.Query = decodo.Ptr("coffee shops")
	params.Geo = decodo.Ptr("United States")
	params.Parse = decodo.Ptr(true)

	result, err := client.WebScrapingAPI.Scrape(context.Background(), params)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(result.Results[0].Content)
}
```

--------------------------------

### Run sample agents

Source: https://help.decodo.com/docs/langchain

Run any of the sample agents provided in the repository: universal, Google, or Amazon.

```Shell
npm run example:agent-universal
npm run example:agent-google
npm run example:agent-amazon
```

--------------------------------

### Install Decodo plugin via marketplace

Source: https://help.decodo.com/docs/agent-skills

Adds the Decodo/agent-skills repository as a plugin marketplace and installs the decodo plugin, which bundles all available skills. The marketplace name is 'decodo-skills' and the plugin is 'decodo'.

```shell
/plugin marketplace add Decodo/agent-skills
/plugin install decodo@decodo-skills
```
Tokens:
Raw