Decodo Python SDK

The official Python SDK for the Decodo Web Scraping API.

Build scraping workflows for search engines, eCommerce platforms, social media, AI tools, and more using the Decodo Web Scraping API.

• Fully typed targets and parameters with IDE autocomplete
• Sync, async, and batch scraping methods
• Built on httpx, Python 3.12+
• Typed error hierarchy for safer integrations
• Built for Python and modern tooling

What is Decodo Python SDK?

Decodo Python SDK is the official Python SDK for the Decodo Web Scraping API. It provides a typed interface for interacting with Decodo targets like Google, Amazon, TikTok, Reddit, YouTube, ChatGPT, Perplexity, and more.

Instead of manually constructing HTTP requests and validating payloads, you can work with fully typed methods and target-specific parameters directly in your editor.

Why use the SDK?

• Typing and autocomplete. Target parameters are fully typed for better DX and fewer mistakes.
• Unified scraping interface. Work with search engines, eCommerce platforms, social media, and AI tools through one SDK.
• Async and batch workflows. Create scraping tasks, poll statuses, and process batches at scale.
• Typed errors. Handle authentication, validation, timeout, and rate-limit failures safely.
• Minimal setup. Single dependency on httpx, no additional HTTP client required.

Requirements

• Python 3.12+

Installation

pip install decodo-sdk

Quick start

Create a new project:

mkdir scrape-with-decodo
cd scrape-with-decodo

pip install decodo-sdk

touch main.py

Get your Web Scraping API token from the Decodo dashboard. The token is the base64-encoded user:password value from the Basic Auth credentials shown in the dashboard.

Every target has a corresponding parameter class. Import the one you need, fill in its fields, and pass it to scrape():

# main.py
from decodo import (
    DecodoClient,
    DecodoConfig,
    Google搜索Params,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token="<basic_auth_token>",
        ),
    )
)

result = client.web_scraping_api.scrape(
    Google搜索Params(
        query="coffee shops",
        geo="United States",
        parse=True,
    )
)

print(result)

Run the script:

python main.py

Parameter classes are bundled with the package, so no extra step is needed after pip install decodo-sdk. Each class pins its own target and accepts only the fields that target supports. Your IDE can flag misspelled or unsupported fields, while runtime validation catches them before the request is sent.

Google搜索Params is the parameter class for Target.Google搜索. The naming follows a simple pattern covered in Targets and parameter classes.

Alternative: dictionary payloads

Scraping methods also accept a plain Python dictionary. The payload is validated against the bundled schema before the request is sent, but nothing is checked while you write the code, so typos and unsupported fields surface only at runtime:

result = client.web_scraping_api.scrape({
    "target": "google_search",
    "query": "coffee shops",
    "geo": "United States",
    "parse": True,
})

print(result)

Use the Target enum instead of a raw string to avoid mistyping the target name:

from decodo import Target

result = client.web_scraping_api.scrape({
    "target": Target.Google搜索,
    "query": "coffee shops",
    "parse": True,
})

print(result)

Typed parameters are recommended for anything beyond a quick experiment. The rest of this README uses the typed parameter approach throughout.

Updating types to a newer schema

The types bundled in the package reflect the schema at release time. To update them to the latest schema without waiting for a new release, run the type generator:

python -m decodo.codegen.codegen --out-dir ./decodo_generated

Then import from that directory instead:

from decodo_generated.targets import Google搜索Params

The directory name passed to --out-dir becomes the import namespace. ./decodo_generated → from decodo_generated.targets import .... You can use any name, but keep it consistent across your project.

Example response

{
  "results": [
    {
      "content": {
        "results": {
          "last_visible_page": 10,
          "page": 1,
          "parse_status_code": 12000,
          "results": {
            "local_pack": [
              {
                "items": [
                  {
                    "address": "Rochester, NY",
                    "paid": false,
                    "pos": 1,
                    "rating": 4.9,
                    "rating_count": 1700,
                    "subtitle": "Coffee shop",
                    "title": "Albunn Coffee House"
                  },
                  {
                    "address": "Rochester, NY",
                    "paid": false,
                    "pos": 2,
                    "rating": 4.8,
                    "rating_count": 937,
                    "subtitle": "Coffee shop",
                    "title": "Layali Coffee House"
                  },
                  {
                    "address": "Ocean Township, NJ",
                    "paid": false,
                    "pos": 3,
                    "rating": 4.9,
                    "rating_count": 124,
                    "subtitle": "Coffee shop",
                    "title": "Ocean Brew Co."
                  }
                ],
                "pos_overall": 1
              }
            ],
            "organic": [
              {
                "desc": "For an alternate, local view, Eater has an interesting list of what it considers Philadelphia's 21 Essential Coffee Shops.",
                "pos": 1,
                "pos_overall": 2,
                "title": "Philadelphia",
                "url": "https://www.brian-coffee-spot.com/the-coffee-spot-guide-to/usa-canada/philadelphia/"
              }
            ],
            "search_information": {
              "query": "coffee shops",
              "total_results_count": 403000000
            }
          },
          "url": "https://www.google.com/search?q=coffee+shops&hl=en&gl=us"
        },
        "errors": [],
        "status_code": 12000,
        "task_id": "7463508496927950850"
      },
      "status_code": 200,
      "url": "https://www.google.com/search?q=coffee+shops&hl=en&gl=us",
      "task_id": "7463508496927950850",
      "created_at": "2026-05-22 08:38:10",
      "updated_at": "2026-05-22 08:38:13"
    }
  ]
}

Configuration

from decodo import (
    DecodoClient,
    DecodoConfig,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token="<basic_auth_token>",
        ),
        timeout_ms=120_000,  # optional, request timeout in ms (default: 180000)
    )
)

Parameter	Description
token	Web Scraping API basic auth token, the base64-encoded user:password string from the Decodo dashboard
timeout_ms	Request timeout in milliseconds (default: 180000)

Web Scraping API

Access the API via client.web_scraping_api.

The snippets below assume you have already constructed a client. See Configuration for how to build one.

Sync scrape

Waits for the scraping result before returning:

from decodo import (
    AmazonProductParams,
    DecodoClient,
    DecodoConfig,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token="<basic_auth_token>",
        ),
    )
)

# Run the scrape and wait for the result.
result = client.web_scraping_api.scrape(
    AmazonProductParams(
        query="B09H74FXNW",
        parse=True,
    )
)

# Print the completed response.
print(result)

Async scrape

Creates a scraping task and returns immediately, then you poll for status and results:

import time

from decodo import (
    DecodoClient,
    DecodoConfig,
    Google搜索Params,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token="<basic_auth_token>",
        ),
    )
)

# Submit the scraping task and return immediately.
task = client.web_scraping_api.scrape_async(
    Google搜索Params(
        query="laptop reviews",
        parse=True,
    )
)

# Save the returned task ID.
task_id = task["id"]

# Poll until the task finishes.
while True:
    status = client.web_scraping_api.get_status(task_id)["status"]

    if status == "done":
        break

    if status == "faulted":
        raise RuntimeError(f"Scraping task {task_id} failed.")

    time.sleep(2)

# Retrieve and print the completed result.
result = client.web_scraping_api.get_results(task_id)

print(result)

get_status returns pending, done, or faulted.

Batch scrape

Send multiple inputs in a single request. Batch calls use the batch variant of the target's parameter class, where the primary input accepts a list:

import time

from decodo import (
    DecodoClient,
    DecodoConfig,
    Google搜索BatchParams,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token="<basic_auth_token>",
        ),
    )
)

# Submit multiple queries in a single batch request.
# For another target, use its batch parameter class and primary input.
batch = client.web_scraping_api.scrape_batch(
    Google搜索BatchParams(
        query=["coffee", "tea", "juice"],
        parse=True,
    )
)

# Wait for each task and print its completed result.
for task in batch["queries"]:
    task_id = task["id"]

    while True:
        status = client.web_scraping_api.get_status(task_id)["status"]

        if status == "done":
            break

        if status == "faulted":
            raise RuntimeError(f"Scraping task {task_id} failed.")

        time.sleep(2)

    result = client.web_scraping_api.get_results(task_id)

    print(result)

Targets and parameter classes

Every target in the Target enum has a matching parameter class. The name of the class is the enum member name followed by Params:

Target.Google搜索 → Google搜索Params
Target.Chatgpt      → ChatgptParams
Target.Airbnb       → AirbnbParams

For batch calls, insert Batch before Params. The batch class takes a list for the primary input and otherwise behaves the same:

Target.Google搜索 → Google搜索BatchParams
Target.Chatgpt      → ChatgptBatchParams
Target.Airbnb       → AirbnbBatchParams

Two things follow from this:

• You don't need to pass a target. Each class already pins its own target, so Google搜索Params(query="coffee shops") is complete. Passing target=Target.Google搜索 explicitly is allowed and type-checked, just redundant.
• The Target enum is still useful. Reach for it when you build dictionary payloads, or when you read the target field back off a response.

One target breaks the rule. Target.Target maps to TargetStoreParams and TargetStoreBatchParams, not TargetParams. Every other target is mechanical.

Each target accepts one primary input parameter (url, query, product_id, or prompt) together with optional configuration. The tables below show that primary input.

搜索 engines

Target	Parameter class	Description	Example input
Target.Google搜索	Google搜索Params	Google 搜索 results for a query	query="coffee shops"
Target.GoogleMaps	GoogleMapsParams	Google Maps search results	query="coffee shops brooklyn"
Target.GoogleShopping搜索	GoogleShopping搜索Params	Google Shopping search results	query="laptop"
Target.GoogleShoppingProduct	GoogleShoppingProductParams	Google Shopping product page	query="laptop"
Target.GoogleSuggest	GoogleSuggestParams	Google Autocomplete suggestions	query="coffee"
Target.GoogleLens	GoogleLensParams	Google Lens reverse image search	query="https://example.com/cat.jpg"
Target.GoogleTravelHotels	GoogleTravelHotelsParams	Google Travel hotel listings	query="hotels in paris"
Target.GoogleTrends探索	GoogleTrends探索Params	Google Trends explore data	query="coffee"
Target.GoogleAds	GoogleAdsParams	Google Ads results for a query	query="laptop"
Target.Bing搜索	Bing搜索Params	Bing 搜索 results	query="electric vehicles"
Target.Bing	BingParams	Raw Bing URL scraping	url="https://bing.com/search?q=laptop"

eCommerce

Target	Parameter class	Description	Example input
Target.AmazonProduct	AmazonProductParams	Amazon product detail page by ASIN	query="B09H74FXNW"
Target.Amazon搜索	Amazon搜索Params	Amazon search results	query="laptop"
Target.AmazonPricing	AmazonPricingParams	Amazon pricing and offers	query="B09H74FXNW"
Target.AmazonSellers	AmazonSellersParams	Amazon seller listings	query="B09H74FXNW"
Target.AmazonBestsellers	AmazonBestsellersParams	Amazon bestsellers by category	query="electronics"
Target.WalmartProduct	WalmartProductParams	Walmart product page by product ID	product_id="15296401808"
Target.Walmart搜索	Walmart搜索Params	Walmart search results	query="laptop"
Target.Walmart	WalmartParams	Raw Walmart URL scraping	url="https://walmart.com/ip/15296401808"
Target.TargetProduct	TargetProductParams	Target.com product page by product ID	product_id="92186007"
Target.Target搜索	Target搜索Params	Target.com search results	query="laptop"
Target.Target	TargetStoreParams	Raw Target.com URL scraping	url="https://target.com/p/-/A-92186007"
Target.Lowes搜索	Lowes搜索Params	Lowe's search results	query="drill"
Target.Ecommerce	EcommerceParams	Generic eCommerce page with parser	url="https://example.com/product/123"

Social media

Target	Parameter class	Description	Example input
Target.RedditPost	RedditPostParams	Reddit post by URL	url="https://reddit.com/r/nba/comments/..."
Target.RedditSubreddit	RedditSubredditParams	Reddit subreddit by URL	url="https://reddit.com/r/nba/"
Target.RedditUser	RedditUserParams	Reddit user profile by URL	url="https://reddit.com/user/example/"
Target.YoutubeVideo	YoutubeVideoParams	YouTube video by ID	query="dFu9aKJoqGg"
Target.Youtube搜索	Youtube搜索Params	YouTube search results	query="ambient music"
Target.Youtube搜索Max	Youtube搜索MaxParams	YouTube search results (extended)	query="ambient music"
Target.YoutubeMetadata	YoutubeMetadataParams	YouTube video metadata by ID	query="dFu9aKJoqGg"
Target.YoutubeTranscript	YoutubeTranscriptParams	YouTube video transcript by ID	query="dFu9aKJoqGg"
Target.YoutubeSubtitles	YoutubeSubtitlesParams	YouTube video subtitles by ID	query="dFu9aKJoqGg"
Target.YoutubeChannel	YoutubeChannelParams	YouTube channel by handle or ID	query="@decodo_official"
Target.TiktokPost	TiktokPostParams	TikTok post by URL	url="https://www.tiktok.com/@nba/video/..."
Target.TiktokShop搜索	TiktokShop搜索Params	TikTok Shop search results	query="wireless earbuds"
Target.TiktokShopProduct	TiktokShopProductParams	TikTok Shop product page by product ID	product_id="7100000000000000000"
Target.Tiktok	TiktokParams	Raw TikTok URL scraping	url="https://www.tiktok.com/@nba"
Target.InstagramGraphql个人资料	InstagramGraphql个人资料Params	Instagram profile via GraphQL	query="nba"

AI tools

Target	Parameter class	Description	Example input
Target.Chatgpt	ChatgptParams	ChatGPT response for a prompt	prompt="What are the top three dog breeds?"
Target.Perplexity	PerplexityParams	Perplexity response for a prompt	prompt="What causes seasonal allergies?"
Target.Gemini	GeminiParams	Gemini response for a prompt	prompt="What are the top three dog breeds?"
Target.GoogleAiMode	GoogleAiModeParams	Google AI Mode response	query="What are the top three dog breeds?"

Other

Target	Parameter class	Description	Example input
Target.Bbb	BbbParams	Better Business Bureau listing by URL	url="https://bbb.org/us/ny/new-york/..."
Target.Autotrader	AutotraderParams	Autotrader listing by URL	url="https://autotrader.com/cars-for-sale/..."
Target.Mobile	MobileParams	Mobile.de listing by URL	url="https://mobile.de/auto/..."
Target.Airbnb	AirbnbParams	Airbnb listing by URL	url="https://airbnb.com/rooms/12345"
Target.AppleAppStore	AppleAppStoreParams	Apple App Store app by URL	url="https://apps.apple.com/app/id12345"

Universal scraping

Target	Parameter class	Description	Example input
Target.Universal	UniversalParams	Any URL via the universal scraper	url="https://example.com"
Target.Google	GoogleParams	Raw Google URL scraping	url="https://google.com/search?q=laptop"
Target.Amazon	AmazonParams	Raw Amazon URL scraping	url="https://amazon.com/dp/B09H74FXNW"

Target.UniversalEcommerce isn't listed above because it doesn't accept a primary input parameter like url, query, product_id, or prompt. Its parameter class UniversalEcommerceParams only accepts optional configuration fields such as callback_url.

For the full target list and parameter details, see the API documentation:

• Target list
• Parameters

Error handling

The SDK raises typed errors that map to API error codes:

import time

from decodo import (
    AuthenticationError,
    DecodoClient,
    DecodoConfig,
    DecodoError,
    Google搜索Params,
    RateLimitError,
    TimeoutError,
    ValidationError,
    WebScrapingApiConfig,
)

client = DecodoClient(
    DecodoConfig(
        web_scraping_api=WebScrapingApiConfig(
            token="<basic_auth_token>",
        ),
    )
)

params = Google搜索Params(
    query="coffee shops",
    geo="United States",
    parse=True,
)


def print_organic_results(response):
    parsed = response["results"][0]["content"]["results"]["results"]

    for item in parsed["organic"]:
        print(item["pos"], item["title"], item["url"])


try:
    response = client.web_scraping_api.scrape(params)
    print_organic_results(response)

except AuthenticationError:
    # Handle authentication failures.
    raise SystemExit(
        "Invalid token. Check the Basic Auth credentials in your dashboard."
    )

except RateLimitError:
    # Retry once after a short delay.
    time.sleep(5)
    response = client.web_scraping_api.scrape(params)
    print_organic_results(response)

except ValidationError as err:
    # Handle invalid request parameters.
    print("Payload rejected:", err.errors or err)

except TimeoutError:
    # Handle request timeouts.
    print(
        "Timed out. Increase timeout_ms or switch to scrape_async for slow targets."
    )

except DecodoError as err:
    # Catch any other SDK errors.
    print(f"Request failed with {err.status_code}: {err}")

The ["results"]["results"] nesting above is the shape returned when parse=True. Without it, content holds the raw page instead.

Error	Raised when	Useful attributes
AuthenticationError	The API returns 401 or 403	status_code
RateLimitError	The API returns 429	status_code
ValidationError	The payload fails local schema validation, or the API returns 422	errors, status_code
TimeoutError	The request exceeds timeout_ms	none
DecodoError	Any other unsuccessful response. Base class for the three errors above	status_code, api_status

Two things to keep in mind:

• TimeoutError sits outside the DecodoError hierarchy, so except DecodoError won't catch it. Catch it separately, as in the example above. Importing it from decodo also shadows the built-in TimeoutError in that module.
• Typed parameters fail earlier than this. An unknown field or a wrong type raises pydantic.ValidationError when you construct the parameter object, before any request is made. decodo.ValidationError covers payloads that are well-formed Python but rejected by the schema or the API.

Related repositories

• Web Scraping API
• Decodo MCP Server
• Decodo OpenClaw Skill

Get started

Build scraping workflows with the Decodo Web Scraping API:

• Start free plan
• Documentation
• Discord

License

Released under the MIT License.