Proxyscrape SDK

ProxyScrape API client, generated from the OpenAPI spec.

The ProxyScrape API provides access to a global proxy server provider, delivering residential, dedicated, and shared datacenter proxies designed for performance.

Learn more about ProxyScrape API at proxyscrape.com.

This is an unofficial SDK for the ProxyScrape public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

Metadata kindly supplied by www.freepublicapis.com.

TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — ProxyList — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list):

const client = new ProxyscrapeSDK()
const items = await client.ProxyList().list()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = ProxyscrapeSDK.test()
const proxylists = await client.ProxyList().list()
// proxylists is an array of bare ProxyList records populated with mock data
console.log(proxylists)

Python

client = ProxyscrapeSDK.test()
proxylists = client.ProxyList().list()
print(proxylists)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = ProxyscrapeSDK::test([
    "entity" => ["proxylist" => ["test01" => []]],
]);
$proxylists = $client->ProxyList()->list();

Golang

client := sdk.Test()
result, err := client.ProxyList(nil).List(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = ProxyscrapeSDK.test({
  "entity" => { "proxylist" => { "test01" => {} } },
})
proxylists = client.ProxyList.list()

Lua

local client = sdk.test()
local results, err = client:ProxyList():list()

Packages

Language	Package	Install
TypeScript	@voxgig-sdk/proxyscrape	publish pending — install from git tag
Python	voxgig-sdk-proxyscrape	publish pending — install from git tag
PHP	voxgig-sdk/proxyscrape	publish pending — install from git tag
Golang	github.com/voxgig-sdk/proxyscrape-sdk/go	go get github.com/voxgig-sdk/proxyscrape-sdk/go@latest
Ruby	voxgig-sdk-proxyscrape	publish pending — install from git tag
Lua	voxgig-sdk-proxyscrape	publish pending — install from git tag
Go CLI	github.com/voxgig-sdk/proxyscrape-sdk/go-cli	go install github.com/voxgig-sdk/proxyscrape-sdk/go-cli/cmd/proxyscrape@latest
Go MCP server	github.com/voxgig-sdk/proxyscrape-sdk/go-mcp	go get github.com/voxgig-sdk/proxyscrape-sdk/go-mcp@latest

Quickstart

TypeScript

import { ProxyscrapeSDK } from '@voxgig-sdk/proxyscrape'

const client = new ProxyscrapeSDK()

// List all proxylists (returns ProxyList[])
const proxylists = await client.ProxyList().list()
for (const proxylist of proxylists) {
  console.log(proxylist)
}

See the TypeScript README for the full guide.

Surfaces

Surface	Path
SDK (TypeScript, Python, PHP, Golang, Ruby, Lua)	ts/ py/ php/ go/ rb/ lua/
CLI	go-cli/
MCP server	go-mcp/

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o proxyscrape-mcp .

Then add it to your agent's MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "proxyscrape": {
      "command": "/abs/path/to/proxyscrape-mcp"
    }
  }
}

Entities

The API exposes one entity:

Entity	Description	API path
ProxyList	The ProxyList entity (list).	/free-proxy-list/get

The operations available across these entities are list — see each entity's own list above for exactly which it supports.

Quickstart in other languages

Python

from proxyscrape_sdk import ProxyscrapeSDK

client = ProxyscrapeSDK()

# List all proxylists (returns a list, raises on error)
proxylists = client.ProxyList().list()
for proxylist in proxylists:
    print(proxylist)

PHP

<?php
require_once 'proxyscrape_sdk.php';

$client = new ProxyscrapeSDK();

// List all proxylists (returns an array; throws on error)
$proxylists = $client->ProxyList()->list();
print_r($proxylists);

Golang

import sdk "github.com/voxgig-sdk/proxyscrape-sdk/go"

client := sdk.New()

// List all proxylists
proxyLists, err := client.ProxyList(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(proxyLists)

Ruby

require_relative "Proxyscrape_sdk"

client = ProxyscrapeSDK.new

# List all proxylists (returns an Array; raises on error)
proxylists = client.ProxyList.list
puts proxylists

Lua

local sdk = require("proxyscrape_sdk")

local client = sdk.new()

-- List all proxylists
local proxylists, err = client:ProxyList():list()
print(proxylists)

Direct and prepare

For endpoints the entity model doesn't cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Feature	Purpose
TestFeature	In-memory mock transport for testing without a live server

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://github.com/l0v3m0n3y/proxyscrape

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

---

Generated from the ProxyScrape API OpenAPI spec by @voxgig/sdkgen.