Skip to content
Open
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
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ pip install decodo-sdk
touch main.py
```

Get your Web Scraping API token from the [Decodo dashboard](https://dashboard.decodo.com/welcome). The token is the base64-encoded `user:password` value from the Basic Auth credentials shown in the dashboard.
Copy your Web Data API key from your Web Data API subscription on the [Decodo dashboard](https://dashboard.decodo.com/web-data/playground). Older plans only have a basic authentication token, which you can pass as `token` instead (see [Configuration](#configuration)).

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

Expand All @@ -71,7 +71,7 @@ from decodo import (
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
api_key="<api_key>",
),
)
)
Expand Down Expand Up @@ -235,16 +235,30 @@ from decodo import (
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
api_key="<api_key>",
),
timeout_ms=120_000, # optional, request timeout in ms (default: 180000)
)
)
```

Pass either `api_key` or `token`, not both. The client raises `ValueError` if you set both.

```python
# Basic auth token (older plans)
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
),
)
)
```

| Parameter | Description |
| --- | --- |
| `token` | Web Scraping API basic auth token, the base64-encoded `user:password` string from the Decodo dashboard |
| `api_key` | Web Data API key. Recommended |
| `token` | Web Scraping API basic auth token for older plans, the base64-encoded `user:password` string from the Decodo dashboard. Use it instead of `api_key` |
| `timeout_ms` | Request timeout in milliseconds (default: 180000) |

## Web Scraping API
Expand All @@ -268,7 +282,7 @@ from decodo import (
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
api_key="<api_key>",
),
)
)
Expand Down Expand Up @@ -302,7 +316,7 @@ from decodo import (
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
api_key="<api_key>",
),
)
)
Expand Down Expand Up @@ -355,7 +369,7 @@ from decodo import (
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
api_key="<api_key>",
),
)
)
Expand Down Expand Up @@ -527,7 +541,7 @@ from decodo import (
client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(
token="<basic_auth_token>",
api_key="<api_key>",
),
)
)
Expand All @@ -553,7 +567,7 @@ try:
except AuthenticationError:
# Handle authentication failures.
raise SystemExit(
"Invalid token. Check the Basic Auth credentials in your dashboard."
"Invalid API key or token. Check your credentials in the dashboard."
)

except RateLimitError:
Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/airbnb.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/amazon_bestsellers.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/amazon_pricing.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/amazon_product.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/amazon_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/amazon_sellers.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/amazon_url.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/apple_app_store.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/autotrader.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/batch/google_search_batch.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/bbb.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

from decodo import BbbParams, DecodoClient, DecodoConfig, Target, WebScrapingApiConfig

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/bing_page.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

from decodo import BingParams, DecodoClient, DecodoConfig, Target, WebScrapingApiConfig

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/bing_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/chatgpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/gemini.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/google_ads.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/google_ai_mode.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/google_lens.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/google_maps.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
4 changes: 2 additions & 2 deletions examples/web_scraping_api/google_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
WebScrapingApiConfig,
)

token = os.environ["DECODO_TOKEN"]
api_key = os.environ["DECODO_API_KEY"]

client = DecodoClient(
DecodoConfig(
web_scraping_api=WebScrapingApiConfig(token=token),
web_scraping_api=WebScrapingApiConfig(api_key=api_key),
)
)

Expand Down
Loading
Loading