Skip to content

Commit 6c34086

Browse files
authored
Update README.md
1 parent a9d6966 commit 6c34086

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,15 @@ pip install ytfetcher
4646

4747
## Basic Usage
4848

49+
**Note:** When specifying the channel, you must provide the exact **channel handle** without the `@` symbol, channel URL, or channel display name.
50+
For example, use `TheOffice` instead of `@TheOffice` or `https://www.youtube.com/c/TheOffice`.
51+
52+
### How to find the channel handle for a YouTube channel
53+
54+
1. Go to the YouTube channel page.
55+
2. Look at the URL in your browser's address bar.
56+
3. The handle is the part that comes right after `https://www.youtube.com/@`
57+
4958
Ytfetcher uses **YoutubeV3 API** to get channel details and video id's so you have to create your API key from Google Cloud Console [In here](https://console.cloud.google.com/apis/api/youtube.googleapis.com).
5059

5160
Also keep in mind that you have a quota limit for **YoutubeV3 API**, but for basic usage quota isn't generally a concern.
@@ -237,7 +246,7 @@ ytfetcher from_channel --api-key <API_KEY> -c <CHANNEL_HANDLE> -m <MAX_RESULTS>
237246
Basic usage example:
238247

239248
```bash
240-
ytfetcher from_channel --api-key <API_KEY> -c "channelname" -m 20 -f json
249+
ytfetcher from_channel --api-key <API_KEY> -c <CHANNEL_HANDLE> -m 20 -f json
241250
```
242251

243252
### Output Example
@@ -269,13 +278,13 @@ ytfetcher config <YOUR_API_KEY>
269278
Now you can basically say without passing API key argument.
270279

271280
```bash
272-
ytfetcher from_channel -c ChannelName
281+
ytfetcher from_channel -c <CHANNEL_HANDLE>
273282
```
274283

275284
### Using Webshare Proxy
276285

277286
```bash
278-
ytfetcher from_channel --api-key <API_KEY> -c "channel" -f json \
287+
ytfetcher from_channel --api-key <API_KEY> -c <CHANNEL_HANDLE> -f json \
279288
--webshare-proxy-username "<USERNAME>" \
280289
--webshare-proxy-password "<PASSWORD>"
281290

@@ -284,15 +293,15 @@ ytfetcher from_channel --api-key <API_KEY> -c "channel" -f json \
284293
### Using Custom Proxy
285294

286295
```bash
287-
ytfetcher from_channel --api-key <API_KEY> -c "channel" -f json \
296+
ytfetcher from_channel --api-key <API_KEY> -c <CHANNEL_HANDLE> -f json \
288297
--http-proxy "http://user:pass@host:port" \
289298
--https-proxy "https://user:pass@host:port"
290299

291300
```
292301

293302
### Using Custom HTTP Config
294303
```bash
295-
ytfetcher from_channel --api-key <API_KEY> -c "channel" \
304+
ytfetcher from_channel --api-key <API_KEY> -c <CHANNEL_HANDLE> \
296305
--http-timeout 4.2 \
297306
--http-headers "{'key': 'value'}" # Must be exact wrapper with double quotes with following single quotes.
298307
```

0 commit comments

Comments
 (0)