Skip to content

docs: clarify proxy section (fixes #32) #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kenrogers wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify proxy section (fixes #32) #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,13 @@ await getJson({ engine: "google", api_key: API_KEY_2, q: "coffee" }); // API_KEY

### Using a Proxy

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

You can route requests through your own proxy by passing `requestOptions` with
an `HttpsProxyAgent` instance. This can be done either globally through the
config object or per-request in the parameters.

First, install the required package:

Expand Down