ProxyWhirl Docs
OpenapiPool Management

Stream all proxies as NDJSON

GET
/api/proxies/stream

Stream all proxies in NDJSON format (newline-delimited JSON).

Useful for exporting large proxy lists without buffering entire response. Each line is a complete JSON object representing one proxy.

Args: status_filter: Filter by health status (optional) rotator: ProxyWhirl dependency api_key: API key verification

Returns: StreamingResponse with NDJSON content

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Query Parameters

status_filter?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/proxies/stream"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}