thordata-python-sdk/.env.example at main · Thordata/thordata-python-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# =============================================================================
# Thordata Python SDK - Environment Template
# Copy to .env and fill in values. Never commit .env to version control.
# =============================================================================

# --- Authentication (Required for API usage) ---
# SERP, Universal Scrape, Task Builder
THORDATA_SCRAPER_TOKEN=

# Account info, task status/download, locations, proxy users, whitelist, unlimited
THORDATA_PUBLIC_TOKEN=
THORDATA_PUBLIC_KEY=

# --- Proxy Credentials by Product ---
# From Dashboard -> respective product -> Endpoint Generator
# Residential (default): port 9999, host pr.thordata.net
THORDATA_RESIDENTIAL_USERNAME=
THORDATA_RESIDENTIAL_PASSWORD=

# Unlimited / High-bandwidth proxy (if your plan has separate credentials)
# Used by extract_ip_list(product="unlimited") and when using unlimited proxy.
THORDATA_UNLIMITED_USERNAME=
THORDATA_UNLIMITED_PASSWORD=

# Optional: Other proxy products
THORDATA_DATACENTER_USERNAME=
THORDATA_DATACENTER_PASSWORD=

THORDATA_MOBILE_USERNAME=
THORDATA_MOBILE_PASSWORD=

THORDATA_ISP_HOST=
THORDATA_ISP_USERNAME=
THORDATA_ISP_PASSWORD=

# --- Proxy Endpoint (Optional; defaults per product) ---
THORDATA_PROXY_HOST=
THORDATA_PROXY_PORT=
THORDATA_PROXY_PROTOCOL=

# --- Scraping Browser (Optional) ---
# If different from residential; used by get_browser_connection_url()
THORDATA_BROWSER_USERNAME=
THORDATA_BROWSER_PASSWORD=

# --- Network (Optional) ---
# Upstream proxy when behind firewall/GFW (e.g. Clash Verge, corporate proxy).
# Unit tests do NOT need this; only integration/live proxy tests or production behind GFW.
# Clash Verge examples:
#   HTTPS proxy (port 7899, recommended):
#     THORDATA_UPSTREAM_PROXY=https://127.0.0.1:7899
#   SOCKS5 proxy (port 7898):
#     THORDATA_UPSTREAM_PROXY=socks5://127.0.0.1:7898
#   HTTP proxy (port 7897, legacy):
#     THORDATA_UPSTREAM_PROXY=http://127.0.0.1:7897
# THORDATA_UPSTREAM_PROXY=

# --- API Base URL Overrides (Optional, advanced) ---
# Defaults point to official production endpoints. Override for private/mock endpoints.
# THORDATA_SCRAPERAPI_BASE_URL=https://scraperapi.thordata.com
# THORDATA_UNIVERSALAPI_BASE_URL=https://webunlocker.thordata.com
# THORDATA_WEB_SCRAPER_API_BASE_URL=https://openapi.thordata.com/api/web-scraper-api
# THORDATA_LOCATIONS_BASE_URL=https://openapi.thordata.com/api/locations
# THORDATA_GATEWAY_BASE_URL=https://openapi.thordata.com/api/gateway
# THORDATA_CHILD_BASE_URL=https://openapi.thordata.com/api/child
# THORDATA_WHITELIST_BASE_URL=https://openapi.thordata.com/api
# THORDATA_PROXY_API_BASE_URL=https://openapi.thordata.com/api

# =============================================================================
# Testing (only needed to run integration tests)
# =============================================================================
# THORDATA_INTEGRATION=true
# THORDATA_INTEGRATION_STRICT=true
# THORDATA_INTEGRATION_HTTP=true

# Optional: demo-specific parameters
# Used by examples/demo_web_scraper_api.py when running against real APIs.
# THORDATA_DEMO_AMAZON_ASIN=B0BZYCJK89