Skip to main content
Back to Dashboard

SOCKS5 API Documentation & Integration Guide

Complete reference for integrating Swift Proxy Network into your applications

5
Programming Languages
195+
Countries Supported
4
Auth Methods
15+
Integration Guides

Quick Start Guide

Get started with your first proxy request in under 5 minutes

Note: You must first sign up and receive your authentication credentials before using the proxy service. All examples use placeholder credentials - replace with your actual username and password.

Python Example Using requests library
import requests

proxies = {
    "http": "socks5://username:[email protected]:1080",
    "https": "socks5://username:[email protected]:1080"
}

response = requests.get("https://api.ipify.org", proxies=proxies)
print(f"Your proxy IP: {response.text}")

Prerequisites

  • Active Swift Proxy Network account
  • Authentication credentials (username/password)
  • Python 3.6+ or Node.js 14+ installed
  • Required libraries (requests, axios, etc.)

First Steps

  1. Sign up and verify your account
  2. Receive your credentials via email
  3. Choose your target location (country/city)
  4. Test with the IP verification endpoint
  5. Integrate into your application

Authentication Methods

Multiple authentication options to suit different security requirements

Username/Password

Standard SOCKS5 authentication with username and password credentials

Format: socks5://username:[email protected]:1080
Security: Basic

IP Whitelisting

Restrict proxy access to specific IP addresses for enhanced security

Format: Only requests from whitelisted IPs are accepted
Security: High

API Key

Programmatic access using unique API keys with rate limiting

Format: X-API-Key: your-api-key-here
Security: Medium

OAuth 2.0

Token-based authentication (coming in Q3 2026)

Format: Bearer
Security: Enterprise

Targeting Options

Granular control over proxy location and behavior

Country Targeting

Route traffic through specific countries

Example: proxy.gatewaypay.online:1080?country=US
195+ countries available

City Targeting

Pinpoint specific cities for geo-localized testing

Example: proxy.gatewaypay.online:1080?city=new_york
2,000+ cities worldwide

ISP Targeting

Select specific Internet Service Providers

Example: proxy.gatewaypay.online:1080?isp=comcast
500+ ISPs available

Session Management

Choose between sticky sessions or rotating IPs

Example: proxy.gatewaypay.online:1080?session=sticky&ttl=300
Sticky (1-3600s) or rotating

Code Examples

Implementation examples in multiple programming languages

Python
JavaScript/Node.js
Java
Go
cURL

Basic Example

Python
import requests

proxies = {
    "http": "socks5://username:[email protected]:1080",
    "https": "socks5://username:[email protected]:1080"
}

response = requests.get("https://api.ipify.org", proxies=proxies)
print(f"Your proxy IP: {response.text}")

Advanced Example

Python
import aiohttp
import asyncio

async def fetch_with_proxy():
    proxy = "socks5://username:[email protected]:1080"
    connector = aiohttp.TCPConnector()
    
    async with aiohttp.ClientSession(connector=connector) as session:
        async with session.get("https://api.ipify.org", proxy=proxy) as response:
            return await response.text()

# Run the async function
print(asyncio.run(fetch_with_proxy()))
Supported Libraries
requests aiohttp Scrapy urllib3

API Reference

Complete REST API documentation for programmatic access

POST /api/v1/auth/token

Generate authentication token

Parameters:

username, password

Response:
{"token": "xyz", "expires": "2026-01-01T00:00:00Z"}
GET /api/v1/proxies

Retrieve available proxy list

Parameters:

country, city, isp, limit, offset

Response:
{"proxies": [{"host": "...", "port": 1080, "location": "..."}]}
GET /api/v1/usage

Get usage statistics

Parameters:

start_date, end_date, granularity

Response:
{"total_requests": 1000, "bandwidth_mb": 50, "countries": ["US", "GB"]}
GET /api/v1/account

Account information and balance

Parameters:

none

Response:
{"plan": "enterprise", "balance": 1000, "expires": "..."}

Error Codes

400 Bad Request Check request parameters
401 Unauthorized Verify credentials or IP whitelist
403 Forbidden Check account permissions or targeting restrictions
429 Too Many Requests Reduce request rate or upgrade plan
500 Internal Server Error Contact support with request ID
502 Bad Gateway Proxy node issue - try different endpoint
503 Service Unavailable Temporary outage - check status page

Rate Limits

  • Free Tier: 100 req/min
  • Business: 1,000 req/min
  • Enterprise: 10,000 req/min
  • Custom: Contact sales

MCP Integration (Model Context Protocol)

Use our SOCKS5 proxy pool with AI agents and MCP‑compatible clients like Claude Desktop, OpenClaw, and NanoClaw.

Agent Credentials

API Key: Use_your_assigned_API_Key

MCP Manifest: https://gatewaypay.online/api/v1/mcp

Base URL: https://gatewaypay.online/api/v1

MCP Tool Calls (JSON)

JSON
{"name": "proxy_info", "parameters": {}}
JSON
{"name": "proxy_countries", "parameters": {}}
JSON
{"name": "proxy_list", "parameters": {"limit": 50, "country": "US"}}
JSON
{"name": "proxy_fetch_one", "parameters": {"id": "1"}}
JSON
{"name": "proxy_my_key", "parameters": {}}

Direct HTTP (cURL)

cURL
curl -s "https://gatewaypay.online/api/v1/proxy/info" -H "Authorization: Bearer Use_your_assigned_API_Key"
# Pool stats
cURL
curl -s "https://gatewaypay.online/api/v1/proxy/countries" -H "Authorization: Bearer Use_your_assigned_API_Key"
# Countries list
cURL
curl -s "https://gatewaypay.online/api/v1/proxy/list?limit=50&country=US" -H "Authorization: Bearer Use_your_assigned_API_Key"
# 50 US proxies
cURL
curl -s "https://gatewaypay.online/api/v1/proxy/list?limit=50&country=NL" -H "Authorization: Bearer Use_your_assigned_API_Key"
# 50 NL proxies
cURL
curl -s "https://gatewaypay.online/api/v1/proxy/list?limit=100" -H "Authorization: Bearer Use_your_assigned_API_Key"
# Any 100 proxies

Response Format

JSON
{
  "proxies": [
    {
      "id": "1",
      "host": "206.123.156.225",
      "ip_port": "206.123.156.225:5133",
      "country_code": "US",
      "protocol": "socks5",
      "type": "smtp25"
    }
  ],
  "count": 50,
  "charged": 0.05
}

Usage: Use ip_port directly: socks5h://206.123.156.225:5133

Pricing & Billing

$0.001 per proxy fetched – deducted from wallet automatically. Top up: POST /api/v1/stripe/topup {"amount": 10}

Filter by Proxy Type: Currently the pool is smtp25 and socks5 type. Filter by country is live. City/state filtering requires checking what columns are populated.

cURL + Python
curl -s "https://gatewaypay.online/api/v1/proxy/countries" -H "Authorization: Bearer Use_your_assigned_API_Key" | python3 -c "
import sys,json; d=json.load(sys.stdin)
for c in d.get('countries',[])[:10]:
    print(c)
"

Use Case Tutorials

Step-by-step guides for common proxy use cases

Ad Verification in 10 Minutes

10 min Beginner
  1. Setup proxy with US residential IP
  2. Visit ad network in incognito mode
  3. Capture ad creatives and placements
  4. Verify geo-targeting accuracy
  5. Check for ad fraud indicators

SERP Tracking Setup Guide

15 min Intermediate
  1. Configure proxies for target countries
  2. Implement rate limiting (1 req/2s)
  3. Parse and store SERP data
  4. Monitor for blocks/captchas
  5. Analyze ranking trends over time

Ethical Web Scraping Best Practices

20 min Advanced
  1. Respect robots.txt and crawl-delay
  2. Implement exponential backoff
  3. Use user-agent rotation
  4. Cache responses when possible
  5. Monitor and respect site load

Need Help?

Our technical support team is ready to assist with your integration.


Documentation updated: July 20, 2026 API Version: 2.1.0