Skip to content

Commit 955c579

Browse files
committed
docs: clarify proxy section — SerpApi handles proxies by default
Add a note explaining that SerpApi handles proxies server-side and this config is only for routing through a corporate or network proxy. Fixes #32
1 parent 80b51f9 commit 955c579

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,13 @@ await getJson({ engine: "google", api_key: API_KEY_2, q: "coffee" }); // API_KEY
118118

119119
### Using a Proxy
120120

121-
You can use a proxy by passing `requestOptions` with an `HttpsProxyAgent`
122-
instance. This can be done either globally through the config object or
123-
per-request in the parameters.
121+
> **Note:** SerpApi handles proxies on its end — you do **not** need to supply
122+
> your own proxy to avoid blocks or CAPTCHAs. This option is only for users who
123+
> need to route all outbound requests through a corporate or network proxy.
124+
125+
You can route requests through your own proxy by passing `requestOptions` with
126+
an `HttpsProxyAgent` instance. This can be done either globally through the
127+
config object or per-request in the parameters.
124128

125129
First, install the required package:
126130

0 commit comments

Comments
 (0)