Skip to content
Closed
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions docs/sdk/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,22 @@ for result in api_client.scroll_events(
print(f"The next execution could resume using from={result.next}")
```

## Using a Proxy

To route requests through an HTTP proxy, pass a `proxies` dict to `FlareApiClient`. It accepts the same format as the [`requests` `proxies` argument](https://requests.readthedocs.io/en/latest/user/advanced/#proxies).

```python Using a Proxy
from flareio import FlareApiClient


client = FlareApiClient(
api_key="fw_...",
proxies={"https": "http://proxy.corp.local:8080"},
)
```

The `HTTP_PROXY` and `HTTPS_PROXY` environment variables are also picked up by `requests`, so setting them is enough if you'd rather not pass `proxies` explicitly.

## Custom Session

The `FlareApiClient` can be initialized with a custom `requests.Session`. This allows, for example,
Expand Down
Loading