wreq

https://python.wreq.org/en/v0.10.2/
Admin
An ergonomic and modular Python HTTP client featuring customizable TLS, JA3/JA4, and HTTP/2...
Tokens:107,564
Snippets:617
Trust Score:2.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Make a GET Request with wreq Blocking Client

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Demonstrates how to initialize a blocking client and make a GET request to a specified URL, printing the response text. Ensure the wreq library is installed.

```python
import wreq
import wreq.blocking
from wreq import Method

client = wreq.blocking.Client()
response = client.get("https://httpbin.io/anything")
print(response.text())

```

--------------------------------

### Making a GET Request with wreq

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Demonstrates how to create a wreq client and perform an asynchronous GET request to a specified URL. Ensure asyncio is installed and configured for running asynchronous code.

```python
import wreq
import asyncio
from wreq import Method

async def main():
    client = wreq.Client()
    response = await client.get("https://httpbin.io/anything")
    print(await response.text())

asyncio.run(main())

```

--------------------------------

### Install wreq from PyPI

Source: https://python.wreq.org/en/v0.10.2/getting-started/installation

Use pip to install the wreq library. Ensure Python 3.11+ is installed.

```bash
pip install wreq

```

--------------------------------

### Install wreq using uv

Source: https://python.wreq.org/en/v0.10.2/getting-started/installation

Install the wreq library using the uv package installer. This is an alternative to pip.

```bash
uv pip install wreq

```

--------------------------------

### GET Request Example

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Demonstrates how to make a GET request using the wreq.blocking.get method and access the response text.

```APIDOC
## GET /anything

### Description
Shortcut method to quickly make a GET request.

### Method
GET

### Endpoint
https://httpbin.io/anything

### Parameters
#### Query Parameters
- **emulation** (Emulation | EmulationOption) - Optional - The Emulation settings for the request.
- **headers** (Dict[str, str] | HeaderMap) - Optional - The headers to use for the request.
- **orig_headers** (Sequence[str] | OrigHeaderMap) - Optional - The original headers to use for the request.
- **default_headers** (bool) - Optional - The option enables default headers.
- **cookies** (str | Dict[str, str]) - Optional - The cookies to use for the request.
- **proxy** (Proxy) - Optional - The proxy to use for the request.
- **local_address** (IPv4Address | IPv6Address) - Optional - Bind to a local IP Address.
- **local_addresses** (Tuple[IPv4Address | None, IPv6Address | None]) - Optional - Bind to dual-stack local IP Addresses.
- **interface** (str) - Optional - Bind connections only on the specified network interface. This option is only available on the following operating systems: Android, Fuchsia, Linux, macOS and macOS-like systems (iOS, tvOS, watchOS and visionOS), Solaris and illumos. On Android, Linux, and Fuchsia, this uses the SO_BINDTODEVICE socket option. On macOS and macOS-like systems, Solaris, and illumos, this instead uses the IP_BOUND_IF and IPV6_BOUND_IF socket options (as appropriate). Note that connections will fail if the provided interface name is not a network interface that currently exists when a connection is established.
- **timeout** (timedelta) - Optional - The timeout to use for the request.
- **read_timeout** (timedelta) - Optional - The read timeout to use for the request.
- **version** (Version) - Optional - The HTTP version to use for the request.
- **redirect** (Policy) - Optional - The redirect policy.
- **cookie_provider** (Jar) - Optional - Set cookie provider for the request.
- **gzip** (bool) - Optional - Sets gzip as an accepted encoding.
- **brotli** (bool) - Optional - Sets brotli as an accepted encoding.
- **deflate** (bool) - Optional - Sets deflate as an accepted encoding.
- **zstd** (bool) - Optional - Sets zstd as an accepted encoding.
- **auth** (str) - Optional - The authentication to use for the request.
- **bearer_auth** (str) - Optional - The bearer authentication to use for the request.
- **basic_auth** (Tuple[str, str | None]) - Optional - The basic authentication to use for the request.
- **query** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The query parameters to use for the request.
- **form** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The form parameters to use for the request.
- **json** (Any) - Optional - The JSON body to use for the request.
- **body** (str | bytes | Sequence[Tuple[str, str]] | Tuple[str, str | int | float | bool] | Dict[str, str | int | float | bool] | Any | Generator[bytes, str, None] | AsyncGenerator[bytes, str]) - Optional - The body to use for the request.
- **multipart** (Multipart) - Optional - The multipart form to use for the request.

### Request Example
```python
import wreq
import wreq.blocking

response = wreq.blocking.get("https://httpbin.io/anything")
print(response.text())
```

### Response
#### Success Response (200)
- **text** (str) - The response body as text.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET Request Example

Source: https://python.wreq.org/en/v0.10.2/api/wreq

This snippet demonstrates how to perform a GET request using the Wreq library.

```APIDOC
## GET https://httpbin.io/anything

### Description
Sends a GET request to the specified URL and returns the response.

### Method
GET

### Endpoint
https://httpbin.io/anything

### Parameters
#### Query Parameters
- **emulation** (Emulation | EmulationOption) - Optional - The Emulation settings for the request.
- **headers** (Dict[str, str] | HeaderMap) - Optional - The headers to use for the request.
- **orig_headers** (Sequence[str] | OrigHeaderMap) - Optional - The original headers to use for the request.
- **default_headers** (bool) - Optional - The option enables default headers.
- **cookies** (str | Dict[str, str]) - Optional - The cookies to use for the request.
- **proxy** (Proxy) - Optional - The proxy to use for the request.
- **local_address** (IPv4Address | IPv6Address) - Optional - Bind to a local IP Address.
- **local_addresses** (Tuple[IPv4Address | None, IPv6Address | None]) - Optional - Bind to dual-stack local IP Addresses.
- **interface** (str) - Optional - Bind connections only on the specified network interface. This option is only available on the following operating systems: Android, Fuchsia, Linux, macOS and macOS-like systems (iOS, tvOS, watchOS and visionOS), Solaris and illumos.
- **timeout** (timedelta) - Optional - The timeout to use for the request.
- **read_timeout** (timedelta) - Optional - The read timeout to use for the request.
- **version** (Version) - Optional - The HTTP version to use for the request.
- **redirect** (Policy) - Optional - The redirect policy.
- **cookie_provider** (Jar) - Optional - Set cookie provider for the request.
- **gzip** (bool) - Optional - Sets gzip as an accepted encoding.
- **brotli** (bool) - Optional - Sets brotli as an accepted encoding.
- **deflate** (bool) - Optional - Sets deflate as an accepted encoding.
- **zstd** (bool) - Optional - Sets zstd as an accepted encoding.
- **auth** (str) - Optional - The authentication to use for the request.
- **bearer_auth** (str) - Optional - The bearer authentication to use for the request.
- **basic_auth** (Tuple[str, str | None]) - Optional - The basic authentication to use for the request.
- **query** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The query parameters to use for the request.
- **form** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The form parameters to use for the request.
- **json** (Any) - Optional - The JSON body to use for the request.
- **body** (str | bytes | Sequence[Tuple[str, str]] | Tuple[str, str | int | float | bool] | Dict[str, str | int | float | bool] | Any | Generator[bytes, str, None] | AsyncGenerator[bytes, str]) - Optional - The body to use for the request.
- **multipart** (Multipart) - Optional - The multipart form to use for the request.

### Request Example
```python
import wreq
import asyncio

async def main():
    client = wreq.Client()
    response = await client.get("https://httpbin.io/anything")
    print(await response.text())

asyncio.run(main())
```

### Response
#### Success Response (200)
- **text** (str) - The response body as text.
- **json** (Any) - The response body parsed as JSON.
- **status_code** (int) - The HTTP status code of the response.
- **headers** (Dict[str, str]) - The response headers.

#### Response Example
(Response body will vary based on the request)
```

--------------------------------

### Perform Basic GET Requests

Source: https://python.wreq.org/en/v0.10.2/getting-started/quickstart

Demonstrates how to execute a GET request using both asynchronous and blocking clients.

```python
import asyncio
from wreq import Client

async def main():
    client = Client()
    resp = await client.get("https://httpbin.org/get")
    print(resp.status_code)
    print(await resp.text())

asyncio.run(main())
```

```python
from wreq.blocking import Client

client = Client()
resp = client.get("https://httpbin.org/get")
print(resp.status_code)
print(resp.text())
```

--------------------------------

### Initialize and use wreq.Client

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Demonstrates creating a client instance with configuration and performing a GET request.

```python
import asyncio
import wreq

async def main():
    client = wreq.Client(
        user_agent="Mozilla/5.0",
        timeout=10,
    )
    response = await client.get('https://httpbin.io/get')
    print(await response.text())

asyncio.run(main())
```

--------------------------------

### GET Request with wreq Blocking Client

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Example of making a GET request to a URL using the wreq blocking client. This is the standard method for retrieving data.

```python
import wreq
import wreq.blocking
from wreq import Method

client = wreq.blocking.Client()
response = client.get("https://httpbin.io/anything")
print(response.text())
```

--------------------------------

### Build wreq from Source

Source: https://python.wreq.org/en/v0.10.2/getting-started/installation

Steps to build wreq from source, including setting up the build environment, installing dependencies, and using maturin for development or building wheels.

```bash
sudo apt install -y build-essential cmake perl pkg-config libclang-dev musl-tools git
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
pip install uv maturin

uv venv
source .venv/bin/activate

# Development install
maturin develop --uv

# Build wheel
maturin build --release

# Install from local wheel
pip install target/wheels/wreq-*.whl

```

--------------------------------

### wreq.Client Initialization and Basic Usage

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Demonstrates how to initialize a wreq.Client with custom configurations like user agent and timeout, and perform a basic GET request.

```APIDOC
## Client Initialization and Basic Usage

### Description
Initializes a `wreq.Client` with optional configuration parameters and demonstrates a simple GET request.

### Method
`__init__`

### Endpoint
N/A (Client constructor)

### Parameters
#### Keyword Arguments (ClientConfig)
- **user_agent** (str) - Optional - Sets the User-Agent header for all requests.
- **timeout** (float) - Optional - Sets the request timeout in seconds.
- **cookie_store** (bool) - Optional - If True, a default cookie jar is created and managed.
- **cookie_provider** (Jar) - Optional - A custom cookie jar implementation to use.

### Request Example
```python
import asyncio
import wreq

async def main():
    client = wreq.Client(
        user_agent="Mozilla/5.0",
        timeout=10,
    )
    response = await client.get('https://httpbin.io/get')
    print(await response.text())

asyncio.run(main())
```

### Response
N/A for constructor. For `get` method, see `request` method response.

```

--------------------------------

### Initialize and Use Blocking Client

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Create a new client instance with custom configuration and perform a GET request.

```python
import asyncio
import wreq

client = wreq.blocking.Client(
    user_agent="Mozilla/5.0",
    timeout=10,
)
response = client.get('https://httpbin.io/get')
print(response.text())
```

--------------------------------

### Send GET Request with Query Parameters

Source: https://python.wreq.org/en/v0.10.2/guide/basic

Demonstrates sending query parameters in a GET request using both lists of tuples and dictionaries. The response is printed as text.

```python
import asyncio
import wreq


async def main():
    # Send list of tuples as query parameters
    resp = await wreq.get(
        "https://httpbin.io/anything",
        query=[
            ("key1", "value1"),
            ("key2", "value2"),
            ("number", 123),
            ("flag", True),
            ("float", 45.67),
        ],
    )
    print(await resp.text())

    # OR send dictionary as query parameters
    resp = await wreq.get(
        "https://httpbin.io/anything",
        query={
            "keyA": "valueA",
            "keyB": "valueB",
            "number": 789,
            "flag": False,
            "float": 12.34,
        },
    )
    print(await resp.text())


if __name__ == "__main__":
    asyncio.run(main())

```

--------------------------------

### Send GET Request with Blocking Client

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Demonstrates how to send a GET request using the blocking client. Ensure wreq and wreq.blocking are imported, along with the Method enum.

```python
import wreq
import wreq.blocking
from wreq import Method

client = wreq.blocking.Client()
response = client.request(Method.GET, "https://httpbin.io/anything")

```

--------------------------------

### Run Local HTTP/2 WebSocket Server

Source: https://python.wreq.org/en/v0.10.2/guide/websocket

Instructions to clone a repository and run a local HTTP/2 WebSocket server using Cargo. This is a prerequisite for testing the HTTP/2 WebSocket client example.

```bash
git clone https://github.com/tokio-rs/axum && cd axum
cargo run -p example-websockets-http2

```

--------------------------------

### POST Request Example

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Demonstrates how to send a POST request using the blocking client with JSON payload.

```APIDOC
## POST /anything

### Description
Sends a POST request to the specified URL with a JSON payload.

### Method
POST

### Endpoint
https://httpbin.io/anything

### Parameters
#### Request Body
- **key** (string) - Required - The key for the JSON payload.

### Request Example
```json
{
  "key": "value"
}
```

### Response
#### Success Response (200)
- **json** (object) - The echoed JSON payload.

#### Response Example
```json
{
  "json": {
    "key": "value"
  },
  "args": {},
  "headers": {
    "Accept": "*/*",
    "Accept-Encoding": "gzip, deflate",
    "Content-Length": "17",
    "Content-Type": "application/json",
    "Host": "httpbin.org",
    "User-Agent": "python-wreq/0.10.2",
    "X-Amzn-Trace-Id": "Root=1-65f4a1b2-3c4d5e6f7a8b9c0d1e2f3a4b"
  },
  "origin": "192.168.1.1",
  "url": "https://httpbin.io/anything"
}
```
```

--------------------------------

### OpenSSL command for PKCS #12 export

Source: https://python.wreq.org/en/v0.10.2/api/tls

Example OpenSSL command to create a PKCS #12 archive (.pfx or .p12) from a private key, certificate, and chain certificates.

```bash
openssl pkcs12 -export -out identity.pfx -inkey key.pem -in cert.pem -certfile chain_certs.pem
```

--------------------------------

### Initialize Part

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Signature for creating a new part instance.

```python
__init__(name, value, filename=None, mime=None, length=None, headers=None)
```

```python
def __init__(
    self,
    name: str,
    value: (
        str
        | bytes
        | Path
        | Generator[bytes, str, None]
        | AsyncGenerator[bytes, str]
    ),
    filename: str | None = None,
    mime: str | None = None,
    length: int | None = None,
    headers: HeaderMap | None = None,
) -> None:
    r"""
    Creates a new part.

    # Arguments
    - `name` - The name of the part.
    - `value` - The value of the part, either text, bytes, a file path, or a async or sync stream.
    - `filename` - The filename of the part.
    - `mime` - The MIME type of the part.
    - `length` - The length of the part when value is a stream (e.g., for file uploads).
    - `headers` - The custom headers for the part.
    """
    ...
```

--------------------------------

### Handle Streaming Responses (Method 1)

Source: https://python.wreq.org/en/v0.10.2/guide/basic

This example shows how to handle streaming responses by iterating over chunks using `resp.stream()`. It includes a small delay between printing chunks.

```python
import asyncio
import wreq
from wreq import Response


async def main():
    resp: Response = await wreq.get("https://httpbin.io/stream/20")
    async with resp:
        async with resp.stream() as streamer:
            async for chunk in streamer:
                print(chunk)
                await asyncio.sleep(0.1)


if __name__ == "__main__":
    asyncio.run(main())

```

--------------------------------

### GET Request

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Sends a GET request to the specified URL.

```APIDOC
## GET /api/resource

### Description
Sends a GET request to retrieve a resource from the specified URL.

### Method
GET

### Endpoint
/api/resource

### Parameters
#### Query Parameters
- **param** (string) - Optional - Description of the query parameter

### Request Example
```python
import wreq
import asyncio

async def main():
    client = wreq.Client()
    response = await client.get("https://httpbin.io/anything")
    print(await response.text())

asyncio.run(main())
```

### Response
#### Success Response (200)
- **body** (string) - The response body content.

#### Response Example
```json
{
  "args": {}, 
  "headers": {"User-Agent": "wreq/0.10.2"}, 
  "origin": "127.0.0.1", 
  "url": "https://httpbin.io/anything"
}
```
```

--------------------------------

### GET /

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Shortcut method to perform a GET request to a specified URL.

```APIDOC
## GET / (wreq.blocking.get)

### Description
Shortcut method to quickly make a GET request.

### Method
GET

### Parameters
#### Query Parameters
- **url** (str) - Required - The target URL for the request.
- **emulation** (Emulation | EmulationOption) - Optional - The Emulation settings for the request.
- **headers** (Dict[str, str] | HeaderMap) - Optional - The headers to use for the request.
- **orig_headers** (Sequence[str] | OrigHeaderMap) - Optional - The original headers to use for the request.
- **default_headers** (bool) - Optional - The option enables default headers.
- **cookies** (str | Dict[str, str]) - Optional - The cookies to use for the request.
- **proxy** (Proxy) - Optional - The proxy to use for the request.
- **local_address** (IPv4Address | IPv6Address) - Optional - Bind to a local IP Address.
- **local_addresses** (Tuple[IPv4Address | None, IPv6Address | None]) - Optional - Bind to dual-stack local IP Addresses.
- **interface** (str) - Optional - Bind connections only on the specified network interface.
- **timeout** (timedelta) - Optional - The timeout to use for the request.
- **read_timeout** (timedelta) - Optional - The read timeout to use for the request.
- **version** (Version) - Optional - The HTTP version to use for the request.
- **redirect** (Policy) - Optional - The redirect policy.
- **cookie_provider** (Jar) - Optional - Set cookie provider for the request.
- **gzip** (bool) - Optional - Sets gzip as an accepted encoding.
- **brotli** (bool) - Optional - Sets brotli as an accepted encoding.
- **deflate** (bool) - Optional - Sets deflate as an accepted encoding.
- **zstd** (bool) - Optional - Sets zstd as an accepted encoding.
- **auth** (str) - Optional - The authentication to use for the request.
- **bearer_auth** (str) - Optional - The bearer authentication to use for the request.
- **basic_auth** (Tuple[str, str | None]) - Optional - The basic authentication to use for the request.
- **query** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The query parameters to use for the request.
- **form** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The form parameters to use for the request.
- **json** (Any) - Optional - The JSON body to use for the request.
- **body** (str | bytes | ...) - Optional - The body to use for the request.
- **multipart** (Multipart) - Optional - The multipart form to use for the request.
```

--------------------------------

### Initialize wreq Client

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Constructor signature for creating a new Client instance with various configuration options.

```python
__init__(*, emulation=..., user_agent=..., headers=..., orig_headers=..., referer=..., redirect=..., cookie_store=..., cookie_provider=..., timeout=..., connect_timeout=..., read_timeout=..., tcp_keepalive=..., tcp_keepalive_interval=..., tcp_keepalive_retries=..., tcp_user_timeout=..., tcp_nodelay=..., tcp_reuse_address=..., pool_idle_timeout=..., pool_max_idle_per_host=..., pool_max_size=..., http1_only=..., http2_only=..., https_only=..., http1_options=..., http2_options=..., verify=..., verify_hostname=..., identity=..., keylog=..., tls_info=..., min_tls_version=..., max_tls_version=..., tls_options=..., no_proxy=..., proxies=..., local_address=..., local_addresses=..., interface=..., dns_options=..., gzip=..., brotli=..., deflate=..., zstd=...)
```

--------------------------------

### GET /

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Sends a GET request to the specified URL using the blocking client.

```APIDOC
## GET [url]

### Description
Sends a GET request to the given URL.

### Method
GET

### Parameters
#### Request Body
- **url** (str) - Required - The target URL for the request.
- **emulation** (Emulation | EmulationOption) - Optional - The Emulation settings for the request.
- **headers** (Dict[str, str] | HeaderMap) - Optional - The headers to use for the request.
- **query** (Sequence | Dict) - Optional - The query parameters to use for the request.
- **timeout** (timedelta) - Optional - The timeout to use for the request.

### Request Example
```python
import wreq.blocking
client = wreq.blocking.Client()
response = client.get("https://httpbin.io/anything")
```
```

--------------------------------

### GET wreq.get

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Performs an asynchronous GET request and returns a Response object.

```APIDOC
## GET wreq.get

### Description
Performs an asynchronous HTTP GET request to the specified URL.

### Method
GET

### Endpoint
wreq.get(url)

### Parameters
#### Request Body
- **url** (str) - Required - The target URL to fetch.

### Response
#### Success Response (200)
- **Response** (object) - Returns a Response instance containing status, headers, and body content.
```

--------------------------------

### Client Initialization and Configuration

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Initializes a new Wreq Client instance with various configuration options for network binding, decompression, and user agent.

```APIDOC
## Client Initialization

### Description
Creates a new Client instance. Allows for detailed configuration of network binding, decompression, and other client-specific settings.

### Method
`__init__`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

#### Keyword Arguments (ClientConfig)
- **local_addresses** (Tuple[IPv4Address | None, IPv6Address | None]) - Bind to dual-stack local IP Addresses.
- **interface** (str) - Bind connections only on the specified network interface. This option is only available on Android, Fuchsia, Linux, macOS and macOS-like systems, Solaris and illumos. Connections will fail if the provided interface name is not a network interface that currently exists when a connection is established.
- **dns_options** (ResolverOptions) - DNS resolver options.
- **gzip** (bool) - Enable auto gzip decompression by checking the `Content-Encoding` response header.
- **brotli** (bool) - Enable auto brotli decompression by checking the `Content-Encoding` response header.
- **deflate** (bool) - Enable auto deflate decompression by checking the `Content-Encoding` response header.
- **zstd** (bool) - Enable auto zstd decompression by checking the `Content-Encoding` response header.

### Request Example
```python
import asyncio
import wreq

async def main():
    client = wreq.Client(
        user_agent="Mozilla/5.0",
        timeout=10,
        gzip=True
    )
    response = await client.get('https://httpbin.io/get')
    print(await response.text())

asyncio.run(main())
```

### Response
None (initialization)

### Error Handling
None specified.
```

--------------------------------

### Establish a WebSocket connection

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Shows how to initiate a WebSocket connection and exchange messages.

```python
import wreq
import asyncio

async def main():
    client = wreq.Client()
    ws = await client.websocket("wss://echo.websocket.org")
    await ws.send(wreq.Message.from_text("Hello, WebSocket!"))
    message = await ws.recv()
    print("Received:", message.data)
    await ws.close()

asyncio.run(main())
```

--------------------------------

### Perform HTTP GET request

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Sends a GET request to the specified URL.

```python
import wreq
import asyncio
from wreq import Method

async def main():
    client = wreq.Client()
    response = await client.get("https://httpbin.io/anything")
    print(await response.text())

asyncio.run(main())
```

--------------------------------

### Initialize All-Protocol Proxy

Source: https://python.wreq.org/en/v0.10.2/api/proxy

Creates a proxy instance for all request protocols.

```python
all(url, *, username=..., password=..., custom_http_auth=..., custom_http_headers=..., exclusion=...)
```

```python
import wreq

proxy = wreq.Proxy.all("https://proxy.example.com")
```

```python
@staticmethod
def all(url: str, **kwargs: Unpack[ProxyConfig]) -> "Proxy":
    r"""
    Creates a new proxy for all protocols.

    This method sets up a proxy server for all types of requests (HTTP, HTTPS, etc.).

    # Examples

    ```python
    import wreq

    proxy = wreq.Proxy.all("https://proxy.example.com")
    ```
    """
    ...
```

--------------------------------

### Define the get method signature

Source: https://python.wreq.org/en/v0.10.2/api/blocking

The internal definition for the blocking get shortcut method.

```python
def get(
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Shortcut method to quickly make a request.

    # Examples

    ```python
    import wreq
    import wreq.blocking

    response = wreq.blocking.get("https://httpbin.io/anything")
    print(response.text())
    ```
    """
    ...
```

--------------------------------

### GET Method with Parameters

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Details the parameters available for the GET method of the blocking client.

```APIDOC
## GET /<url>

### Description
Sends a GET request to the specified URL with various configurable options.

### Method
GET

### Endpoint
/<url>

### Parameters
#### Query Parameters
- **emulation** (Emulation | EmulationOption) - Optional - The Emulation settings for the request.
- **headers** (Dict[str, str] | HeaderMap) - Optional - The headers to use for the request.
- **orig_headers** (Sequence[str] | OrigHeaderMap) - Optional - The original headers to use for the request.
- **default_headers** (bool) - Optional - Enables default headers.
- **cookies** (str | Dict[str, str]) - Optional - The cookies to use for the request.
- **proxy** (Proxy) - Optional - The proxy to use for the request.
- **local_address** (IPv4Address | IPv6Address) - Optional - Bind to a local IP Address.
- **local_addresses** (Tuple[IPv4Address | None, IPv6Address | None]) - Optional - Bind to dual-stack local IP Addresses.
- **interface** (str) - Optional - Bind connections only on the specified network interface. This option is only available on Android, Fuchsia, Linux, macOS and macOS-like systems, Solaris and illumos.
- **timeout** (timedelta) - Optional - The timeout to use for the request.
- **read_timeout** (timedelta) - Optional - The read timeout to use for the request.
- **version** (Version) - Optional - The HTTP version to use for the request.
- **redirect** (Policy) - Optional - The redirect policy.
- **cookie_provider** (Jar) - Optional - Set cookie provider for the request.
- **gzip** (bool) - Optional - Sets gzip as an accepted encoding.
- **brotli** (bool) - Optional - Sets brotli as an accepted encoding.
- **deflate** (bool) - Optional - Sets deflate as an accepted encoding.
- **zstd** (bool) - Optional - Sets zstd as an accepted encoding.
- **auth** (str) - Optional - The authentication to use for the request.
- **bearer_auth** (str) - Optional - The bearer authentication to use for the request.
- **basic_auth** (Tuple[str, str | None]) - Optional - The basic authentication to use for the request.
- **query** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The query parameters to use for the request.
- **form** (Sequence[Tuple[str, str | int | float | bool]] | Dict[str, str | int | float | bool]) - Optional - The form parameters to use for the request.
- **json** (Any) - Optional - The JSON body to use for the request.
- **body** (str | bytes | Sequence[Tuple[str, str]] | Tuple[str, str | int | float | bool] | Dict[str, str | int | float | bool] | Any | Generator[bytes, str, None] | AsyncGenerator[bytes, str]) - Optional - The body to use for the request.
- **multipart** (Multipart) - Optional - The multipart form to use for the request.

### Response
#### Success Response (200)
- **Response** (object) - The response object.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Constructor: __init__

Source: https://python.wreq.org/en/v0.10.2/api/dns

Initializes a new instance of ResolverOptions with a specified IP lookup strategy.

```APIDOC
## __init__

### Description
Create a new ResolverOptions with the given lookup IP strategy.

### Parameters
#### Request Body
- **lookup_ip_strategy** (LookupIpStrategy) - Optional - The IP lookup strategy to use. Defaults to IPV4_AND_IPV6.
```

--------------------------------

### Perform a blocking GET request

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Use this to execute a synchronous GET request and retrieve the response body.

```python
import wreq
import wreq.blocking

response = wreq.blocking.get("https://httpbin.io/anything")
print(response.text())
```

--------------------------------

### Initialize Http2Options

Source: https://python.wreq.org/en/v0.10.2/api/http2

Constructor signature for configuring HTTP/2 connection parameters.

```python
__init__(*, initial_window_size=..., initial_connection_window_size=..., initial_max_send_streams=..., initial_stream_id=..., adaptive_window=..., max_frame_size=..., max_header_list_size=..., header_table_size=..., max_concurrent_streams=..., keep_alive_interval=..., keep_alive_timeout=..., keep_alive_while_idle=..., enable_push=..., enable_connect_protocol=..., no_rfc7540_priorities=..., max_concurrent_reset_streams=..., max_send_buf_size=..., max_pending_accept_reset_streams=..., headers_stream_dependency=..., headers_pseudo_order=..., settings_order=..., priorities=...)
```

--------------------------------

### Initialize Http2Options

Source: https://python.wreq.org/en/v0.10.2/api/http2

Constructor signature for configuring HTTP/2 connection parameters.

```python
__init__(*, initial_window_size=..., initial_connection_window_size=..., initial_max_send_streams=..., initial_stream_id=..., adaptive_window=..., max_frame_size=..., max_header_list_size=..., header_table_size=..., max_concurrent_streams=..., keep_alive_interval=..., keep_alive_timeout=..., keep_alive_while_idle=..., enable_push=..., enable_connect_protocol=..., no_rfc7540_priorities=..., max_concurrent_reset_streams=..., max_send_buf_size=..., max_pending_accept_reset_streams=..., headers_stream_dependency=..., headers_pseudo_order=..., settings_order=..., priorities=...)
```

```python
def __init__(self, **kwargs: Unpack[Params]) -> None:
    """
    Create a new Http2Options instance.
    """
    ...
```

--------------------------------

### PUT Request Example

Source: https://python.wreq.org/en/v0.10.2/api/blocking

Example of how to perform a PUT request using the blocking client with JSON payload.

```APIDOC
## PUT https://httpbin.io/anything

### Description
Sends a PUT request to the specified URL with a JSON payload.

### Method
PUT

### Endpoint
https://httpbin.io/anything

### Parameters
#### Request Body
- **json** (Any) - Required/Optional - The JSON body to use for the request.

### Request Example
```json
{
  "key": "value"
}
```

### Response
#### Success Response (200)
- **text** (str) - The response body as text.

#### Response Example
```
{
  "args": {},
  "data": "",
  "files": {},
  "form": {},
  "headers": {
    "Accept": "*/*",
    "Accept-Encoding": "gzip, deflate",
    "Content-Length": "13",
    "Host": "httpbin.io",
    "User-Agent": "python-wreq/0.10.2",
    "X-Amzn-Trace-Id": "Root=1-65a7f1a3-1234567890abcdef12345678"
  },
  "json": {
    "key": "value"
  },
  "origin": "192.168.1.1",
  "url": "https://httpbin.io/anything"
}
```
```

--------------------------------

### Define the get method signature

Source: https://python.wreq.org/en/v0.10.2/api/wreq

The signature for the asynchronous get method, including all available request configuration parameters.

```python
get(url, *, emulation=..., headers=..., orig_headers=..., default_headers=..., cookies=..., proxy=..., local_address=..., local_addresses=..., interface=..., timeout=..., read_timeout=..., version=..., redirect=..., cookie_provider=..., gzip=..., brotli=..., deflate=..., zstd=..., auth=..., bearer_auth=..., basic_auth=..., query=..., form=..., json=..., body=..., multipart=...)
```

--------------------------------

### Initialize Http1Options

Source: https://python.wreq.org/en/v0.10.2/api/http1

Constructor signature for creating a new Http1Options instance with various configuration parameters.

```python
__init__(*, http09_responses=..., writev=..., max_headers=..., read_buf_exact_size=..., max_buf_size=..., allow_spaces_after_header_name_in_responses=..., ignore_invalid_headers_in_responses=..., allow_obsolete_multiline_headers_in_responses=...)
```

```python
def __init__(self, **kwargs: Unpack[Params]) -> None:
    """
    Crate a new Http1Options instance.
    """
    ...
```

--------------------------------

### Initialize HTTP/1 parameters

Source: https://python.wreq.org/en/v0.10.2/api/http1

Constructor signature for defining HTTP/1 connection parameters.

```python
__init__(*, http09_responses=..., writev=..., max_headers=..., read_buf_exact_size=..., max_buf_size=..., allow_spaces_after_header_name_in_responses=..., ignore_invalid_headers_in_responses=..., allow_obsolete_multiline_headers_in_responses=...)
```

--------------------------------

### Perform an asynchronous HTTP GET request

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Demonstrates how to use wreq to perform an asynchronous GET request and access various response attributes and content.

```python
import asyncio
import wreq

async def main():
    response = await wreq.get("https://www.rust-lang.org")
    print("Status Code: ", response.status)
    print("Version: ", response.version)
    print("Response URL: ", response.url)
    print("Headers: ", response.headers)
    print("Content-Length: ", response.content_length)
    print("Encoding: ", response.encoding)
    print("Remote Address: ", response.remote_addr)

    text_content = await response.text()
    print("Text: ", text_content)

if __name__ == "__main__":
    asyncio.run(main())
```

--------------------------------

### Initialize CertStore

Source: https://python.wreq.org/en/v0.10.2/api/tls

Use this constructor to create a CertStore. Provide DER-encoded certificates, PEM-encoded certificates, or set default_paths to True to use system defaults.

```python
def __init__(
    self,
    der_certs: Sequence[bytes] | None = None,
    pem_certs: Sequence[str] | None = None,
    default_paths: bool | None = None,
) -> None:
    """
    Creates a new CertStore.

    Args:
        der_certs: Optional list of DER-encoded certificates (as bytes).
        pem_certs: Optional list of PEM-encoded certificates (as str).
        default_paths: If True, use system default certificate paths.
    """
    ...
```

--------------------------------

### Perform a Simple GET Request

Source: https://python.wreq.org/en/v0.10.2/guide/basic

Use this for basic GET requests to retrieve data from a URL. It prints various response attributes like status code, headers, and cookies.

```python
import asyncio
import wreq
from wreq import Method


async def main():
    resp: wreq.Response = await wreq.request(Method.GET, url="https://www.google.com/")
    print("Status Code: ", resp.status)
    print("Version: ", resp.version)
    print("Response URL: ", resp.url)
    print("Headers: ", resp.headers)
    print("Cookies: ", resp.cookies)
    print("Content-Length: ", resp.content_length)
    print("Remote Address: ", resp.remote_addr)


if __name__ == "__main__":
    asyncio.run(main())

```

--------------------------------

### Configure the blocking Client

Source: https://python.wreq.org/en/v0.10.2/guide/blocking

Demonstrates setting user agents, browser emulation, and various proxy configurations.

```python
from wreq import Proxy
from wreq.blocking import Client
from wreq.emulation import Emulation


def main():
    client = Client(
        emulation=Emulation.Firefox133,
        user_agent="wreq",
        proxies=[
            Proxy.http("socks5h://abc:def@127.0.0.1:1080"),
            Proxy.https(url="socks5h://127.0.0.1:1080", username="abc", password="def"),
            Proxy.http(url="http://abc:def@127.0.0.1:1080", custom_http_auth="abcedf"),
            Proxy.all(
                url="socks5h://abc:def@127.0.0.1:1080",
                exclusion="google.com, facebook.com, twitter.com",
            ),
        ],
    )
    resp = client.get("https://api.ip.sb/ip")
    print("Status Code: ", resp.status)
    print("Version: ", resp.version)
    print("Response URL: ", resp.url)
    print("Headers: ", resp.headers)
    print("Content-Length: ", resp.content_length)
    print("Remote Address: ", resp.remote_addr)
    print("Text: ", resp.text())


if __name__ == "__main__":
    main()
```

--------------------------------

### Constructor: __init__

Source: https://python.wreq.org/en/v0.10.2/api/header

Initializes a new HeaderMap instance, optionally with an existing dictionary or a capacity hint.

```APIDOC
## __init__

### Description
Create a new HeaderMap instance.

### Parameters
#### Request Body
- **init** (Dict[str, str] | None) - Optional - Optional dictionary to initialize headers from
- **capacity** (int | None) - Optional - Optional initial capacity hint for performance

### Response
#### Success Response (200)
- **instance** (HeaderMap) - A new HeaderMap instance
```

--------------------------------

### GET protocol

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Retrieves the WebSocket protocol currently in use.

```APIDOC
## GET protocol

### Description
Get the WebSocket protocol.

### Method
GET

### Endpoint
protocol
```

--------------------------------

### Get string representation

Source: https://python.wreq.org/en/v0.10.2/api/header

Returns a string representation of all headers.

```python
def __str__(self) -> str:
    """Return a string representation of all headers."""
    ...
```

--------------------------------

### Constructor: Http2Options.__init__

Source: https://python.wreq.org/en/v0.10.2/api/http2

Initializes a new instance of Http2Options with specific HTTP/2 configuration parameters.

```APIDOC
## Constructor: Http2Options.__init__

### Description
Initializes the configuration settings for an HTTP/2 connection, allowing fine-tuning of stream management, window sizes, and frame limits.

### Parameters
#### Request Body
- **initial_window_size** (int) - Optional - Initial window size for HTTP/2 streams.
- **initial_connection_window_size** (int) - Optional - Initial connection-level window size.
- **initial_max_send_streams** (int) - Optional - Initial maximum number of send streams.
- **initial_stream_id** (int) - Optional - Initial stream ID for the connection.
- **adaptive_window** (bool) - Optional - Whether to use adaptive flow control.
- **max_frame_size** (int) - Optional - Maximum frame size to use for HTTP/2.
- **max_header_list_size** (int) - Optional - Maximum size of the header list.
- **header_table_size** (int) - Optional - Header table size for HPACK compression.
- **max_concurrent_streams** (int) - Optional - Maximum concurrent streams from remote peer.
- **keep_alive_interval** (timedelta) - Optional - Interval for HTTP/2 keep-alive ping frames.
- **keep_alive_timeout** (timedelta) - Optional - Timeout for keep-alive ping acknowledgements.
- **keep_alive_while_idle** (bool) - Optional - Whether keep-alive applies while idle.
- **enable_push** (bool) - Optional - Whether to enable push promises.
- **enable_connect_protocol** (bool) - Optional - Whether to enable the CONNECT protocol.
- **no_rfc7540_priorities** (bool) - Optional - Whether to disable RFC 7540 Stream Priorities.
- **max_concurrent_reset_streams** (int) - Optional - Max concurrent locally reset streams.
- **max_send_buf_size** (int) - Optional - Maximum send buffer size for streams.
- **max_pending_accept_reset_streams** (int) - Optional - Max pending accept reset streams.
- **headers_stream_dependency** (StreamDependency) - Optional - Stream dependency for outgoing HEADERS.
- **headers_pseudo_order** (PseudoOrder) - Optional - Order of pseudo-header fields in HEADERS.
- **settings_order** (SettingsOrder) - Optional - Order of settings parameters in SETTINGS frame.
- **priorities** (Priorities) - Optional - List of PRIORITY frames to send after connection.
```

--------------------------------

### Get All Cookies from Jar

Source: https://python.wreq.org/en/v0.10.2/api/cookie

Retrieves all cookies stored in the jar.

```python
get_all()
```

```python
def get_all(self) -> Sequence[Cookie]:
    r"""
    Get all cookies.
    """
    ...
```

--------------------------------

### Initialize ProxyConfig

Source: https://python.wreq.org/en/v0.10.2/api/proxy

Constructor signature for ProxyConfig.

```python
__init__(*, username=..., password=..., custom_http_auth=..., custom_http_headers=..., exclusion=...)
```

--------------------------------

### GET port

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Retrieves the port number associated with the socket address.

```APIDOC
## GET port

### Description
Returns the port number of the socket address.

### Method
GET

### Endpoint
port()

### Response
#### Success Response (200)
- **port** (int) - The port number of the socket address.
```

--------------------------------

### Get status code as integer

Source: https://python.wreq.org/en/v0.10.2/api/wreq

Returns the status code as an integer.

```python
as_int()
```

```python
def as_int(self) -> int:
    r"""
    Return the status code as an integer.
    """
    ...
```
Tokens:
Raw