01DocumentationDeveloper Quickstart

Developer Quickstart

Integrate kairoxo into your stack in minutes with our standardized API and SOCKS5/HTTP protocols.

01person_add

Initialize Account

Create your developer account and complete email verification to initialize access to the management console and API infrastructure.

02account_tree

Select Provisioning Plan

Provision Residential, ISP, or Mobile network resources tailored to your specific throughput and geographic requirements.

03vpn_key

Configure Authentication

Retrieve your unique API credentials including username, password, and port mappings from the Secure Dashboard.

04settings_input_component

Implement Proxy Logic

Embed credentials into your application or automation workflow. We support native HTTP/S and SOCKS5 protocol implementations.

05terminal

Execute Validation Request

Verify connectivity by executing a test request. Monitor headers, exit IP metadata, and latency benchmarks in real-time.

terminal

Connectivity Test

Utilize the following cURL examples to validate your credentials. Replace placeholders with your actual account data.

# Residential Proxy (US Exit Node)
# Execute authenticated request via US-based residential gateway
curl -x "http://USERNAME-f-country-us-sid-abc123-1-10:PASSWORD@premium-proxy.ipfist.com:9000" https://api.ipify.org
# Unlimited Traffic Endpoint
# Execute request via unmetered high-throughput endpoint
curl -x "http://unlimitedKey:PASSWORD@unlimited.ipfist.com:10000" https://api.ipify.org
02System Overview

How the kairoxo Network Works

Every request you make traverses a three-tier topology: an authentication edge, a routing fabric, and a distributed exit fleet. The edge authenticates your credentials in under 8 ms, the routing fabric selects the optimal exit node based on your targeting parameters, and the exit fleet delivers the request from a legitimate residential, ISP, mobile, or datacenter IP.

The platform is built around three guarantees: a globally distributed pool of 100M+ unique IPs, a 99.99% SLA backed by automatic failover, and a sub-200 ms median TTFB to the most common collection targets. All endpoints terminate TLS 1.3 and support HTTP, HTTPS, and SOCKS5 on the same gateway.

shield_lock

Auth Edge

Validates credentials, applies ACL & rate limits, then signs the routing token.

alt_route

Routing Fabric

Selects exit nodes by geo, ASN, session affinity, and live health scores.

public

Exit Fleet

Residential, ISP, mobile, and datacenter IPs distributed across 195 countries.

02Authentication

Credentials & Targeting Parameters

kairoxo uses standard HTTP Basic authentication over the proxy URL. Targeting modifiers are encoded as hyphenated segments inside the username, which keeps the wire protocol compatible with any HTTP, HTTPS, or SOCKS5 client without custom headers.

Credentials are scoped to a sub-account, which lets you isolate billing per project, revoke a single integration without touching the rest of your stack, and apply distinct ACLs (country allow-list, per-domain throttles, concurrency caps). Rotate the password at any time from Settings → Credentials; old tokens stop working within 30 seconds without dropping in-flight TCP sessions.

ParameterTypeDescription
USERNAMEstringSub-account identifier issued in the dashboard. Scope tokens by project to isolate billing and ACLs.
PASSWORDstringRotating credential. Regenerate from Settings → Credentials; old tokens are revoked within 30 seconds.
countryISO-3166Two-letter exit country code, e.g. us, de, jp. Combine with region/city for granular targeting.
sidstringSticky session identifier. Reuse the same sid to keep the same exit IP for up to 30 minutes.
check_circle
Best practice

Issue one sub-account per environment (dev / staging / prod) and one per workload. Easier billing attribution and instant blast-radius containment if a token leaks.

warning
Avoid

Sharing a single credential across browser automation and backend scraping. The two workloads have different rotation needs and you lose the audit trail.

03Residential Proxies

Rotating Residential Pool

Residential proxies route requests through a peer-to-peer pool of consenting devices on real ISP connections. Because the source IP belongs to a household subscriber, residential is the highest-trust tier for targets that scrutinize ASN, browser fingerprints, or behavioral patterns — search engines, e-commerce sites, sneaker drops, ad-verification platforms.

  • check_circle 100M+ unique IPs across 195 countries
  • check_circle City- and ASN-level targeting included
  • check_circle Sticky sessions up to 30 minutes
  • check_circle Unlimited concurrent connections
  • check_circle Automatic rotation on every request (default)
  • check_circle TLS 1.3 + HTTP/2 on the edge
# Python · Rotating residential pool
import requests

proxies = {
  "http":  "http://USERNAME-country-us:PASSWORD@gateway.kairoxo.io:9000",
  "https": "http://USERNAME-country-us:PASSWORD@gateway.kairoxo.io:9000",
}
r = requests.get("https://api.ipify.org?format=json", proxies=proxies, timeout=15)
print(r.json())
04ISP Proxies

Static ISP (Datacenter-Hosted Residential)

ISP proxies are residential IP addresses leased directly from Tier-1 carriers and hosted in our datacenter racks. You get the legitimacy of a residential ASN with the throughput and stability of a dedicated datacenter line — the right choice when a workload needs the same IP for hours and cannot tolerate rotation.

When to choose ISP

  • Account-based scraping requiring stable session IPs
  • Long-running browser automation
  • Ad verification with strict viewability windows
  • SEO rank tracking from a fixed geographic vantage

Throughput envelope

  • 1 Gbps symmetric per IP
  • 256 concurrent TCP connections per IP
  • Unlimited bandwidth — pay per IP, not per GB
  • SLA-backed 99.99% per-IP uptime
05Unlimited Traffic

Unmetered High-Throughput Endpoint

The unlimited endpoint is a fixed-cost gateway optimised for predictable, large-volume workloads such as RPA, market intelligence crawls, and continuous ML training data collection. You pay a flat daily rate per port and consume as much bandwidth as the port can sustain — no per-GB metering, no overage charges.

// Node.js · unmetered gateway
import fetch from "node-fetch";
import { HttpsProxyAgent } from "https-proxy-agent";

const agent = new HttpsProxyAgent(
  "http://unlimitedKey:PASSWORD@unlimited.kairoxo.io:10000"
);

const r = await fetch("https://example.com", { agent });
console.log(r.status);
info
Fair-use policy

The unlimited endpoint is engineered for sustained throughput, not burst attacks. Workloads that exhibit DDoS-like patterns are throttled at the routing layer to protect the pool. Contact engineering for confirmed sustained rates above 500 Mbps per port.

06Proxy Pools

Choosing the Right Pool

Each pool exposes the same authentication surface but differs in concurrency, session persistence, and egress IP behavior. Match the pool to the trust profile of your target endpoint.

Residential

$0.50 / GB

Unlimited concurrent · 30 min sticky

ISP

$4.00 / IP

256 concurrent per IP · Unlimited sticky

Mobile 4G/5G

$1.00 / GB

Unlimited concurrent · 10 min sticky

Datacenter

$0.55 / IP

Unmetered bandwidth · Static IP

07Geographic Targeting

Granular Geo Modifiers

Append targeting segments to the username to constrain exit nodes. Segments are evaluated left-to-right and the most specific match wins. Unknown or empty targets fall back to the broader scope.

ModifierExampleNotes
countrycountry-deISO-3166 alpha-2 country code
regionregion-bavariaSubdivision name, lowercase, no spaces
citycity-munichRequires country; falls back to country pool if no match
asnasn-3320Pin to a specific autonomous system number
sidsid-checkout42-1-30Sticky session id with TTL in minutes
# Country only
USERNAME-country-de
# Country + region + city
USERNAME-country-us-region-california-city-sanfrancisco
# ASN pinning with sticky session
USERNAME-asn-7922-sid-checkout42-1-30
08API Reference

Management Endpoints

All management endpoints live under https://api.kairoxo.io, authenticated with a bearer token. Responses are JSON with cursor-based pagination on collections.

GET/v1/sessions
POST/v1/sessions
DELETE/v1/sessions/:id
GET/v1/usage
GET/v1/geos
09Error Handling

Response Codes & Retry Policy

Proxy errors are surfaced as standard HTTP status codes on the upstream response. Always implement exponential backoff with jitter; never retry tighter than 250 ms on a 429 or you will compound the rate limit. Persistent 5xx responses should trigger a fresh sticky session before the next retry.

407
Proxy Authentication Required

Credentials missing or revoked. Rotate from the dashboard.

429
Rate Limited

Concurrency cap exceeded. Back off with exponential jitter (base 250 ms).

502
Bad Gateway

Upstream target rejected. Retry on a fresh sticky session.