API Documentation

from proxysdk import ProxyClient

client = ProxyClient(api_key="your-api-key", base_url="https://your-domain")

# List US residential nodes
nodes = client.list_nodes(country="US", ip_type="residential")

# Or let the server pick the best one
best = client.get_best_node(country="US", ip_type="residential")

# Build a proxy URL — relay host/port are supplied when your account is opened
proxy_url = client.get_proxy_url("<relay-host>", 1080, session_id="task1")
print(f"Proxy: {proxy_url}")

import { ProxyClient } from 'proxy-sdk';

const client = new ProxyClient({ apiKey: 'your-api-key', baseUrl: 'https://your-domain' });

// List German nodes
const nodes = await client.listNodes({ country: 'DE', ipType: 'residential' });

// Build a proxy URL — relay host/port are supplied when your account is opened
const proxyUrl = client.getProxyUrl('<relay-host>', 1080, { sessionId: 'task1' });
console.log('Proxy:', proxyUrl);

package main

import (
    "context"
    "fmt"

    proxysdk "github.com/your-org/proxy-sdk-go"
)

func main() {
    client := proxysdk.NewClient("your-api-key", "https://your-domain")

    nodes, _ := client.ListNodes(context.Background(), "US", "residential", 10)
    fmt.Println("nodes:", len(nodes))

    best, _ := client.GetBestNode(context.Background(), "US", "residential")
    fmt.Println("best:", best.ID)
}

import proxysdk.ProxyClient;

var client = new ProxyClient("your-api-key", "https://your-domain");

// List nodes (raw JSON)
var nodes = client.listNodes("US", "residential", 10);

// Build a proxy URL — relay host/port are supplied when your account is opened
System.out.println("Proxy: " + client.getProxyUrl("<relay-host>", 1080, "socks5h", "task1"));