@@ -39,18 +39,26 @@ pip install .
3939## Quick Start
4040
4141### 1. Initialize the Client
42+ > [ !IMPORTANT]
43+ > Go to your [ ** account settings** ] ( https://brightdata.com/cp/setting/users ) , to verify that your API key have ** "admin permissions"** .
4244
4345``` python
4446from brightdata import bdclient
4547
46- # Using API token directly
47- client = bdclient(api_token = " your_api_token_here" )
48+ client = bdclient(api_token = " your_api_token_here" ) # can also be defined as BRIGHTDATA_API_TOKEN in your .env file
4849```
4950
50- Or use by setting BRIGHTDATA_API_TOKEN in .env file
51+ Or you can use a custom zone name
5152``` python
52- client = bdclient()
53+ client = bdclient(
54+ api_token = " your_token" ,
55+ auto_create_zones = False , # Else it creates the Zone automatically
56+ web_unlocker_zone = " custom_zone" , # Custom zone name (serp_zone for search requests)
57+ )
5358```
59+ > [ !TIP]
60+ > Hover over the "bdclient" (or over each function in the package) with your cursor to see all its available parameters.
61+
5462
5563### 2. Scrape Websites
5664
@@ -111,18 +119,9 @@ Create a `.env` file in your project root:
111119``` env
112120BRIGHTDATA_API_TOKEN=your_bright_data_api_token
113121WEB_UNLOCKER_ZONE=your_web_unlocker_zone # Optional
114- SERP_ZONE=your_serp_zone # Optional
122+ SERP_ZONE=your_serp_zone # Optional
115123```
116124
117- ### Configuration Options
118-
119- ``` python
120- client = bdclient(
121- api_token = " your_token" ,
122- auto_create_zones = True , # Automatically create missing zones
123- web_unlocker_zone = " custom_zone" , # Custom zone name
124- )
125- ```
126125### Manage Zones
127126
128127``` python
@@ -140,6 +139,7 @@ bdclient(
140139 api_token: str = None ,
141140 auto_create_zones: bool = True ,
142141 web_unlocker_zone: str = None ,
142+ serp_zone: str = None ,
143143)
144144```
145145
0 commit comments