ProxyAPI / Dokumentation

En anslutning. Full kontroll.

Koppla upp proxyn, styr routing per anslutning och följ nycklar, användning, fakturering och health från samma API.

quickstart.sh

# TLS även till proxyendpointen
proxy='https://sk_live_KEY:@proxy.proxyapi.se:443'
curl -x "$proxy" https://httpbin.org/ip

{ "origin": "185.x.x.x" }

CONNECTSmart routingREST API

Kontroll-API: https://api.proxyapi.se · Authorization: Bearer <API_KEY>

Snabbstart — Proxy-anslutning

Använd API-nyckeln som proxyanvändarnamn. För kontroll-API:t använder du samma nyckel som Bearer-token mot https://api.proxyapi.se.

Host	proxy.proxyapi.se
Port (HTTPS till proxy)	443 — rekommenderas
Port (HTTP till proxy)	8080 — endast betrodda nät
Användarnamn	din-api-nyckel
Lösenord	(lämna tomt)

curl -x https://sk_live_abc123:@proxy.proxyapi.se:443 https://httpbin.org/ip

import requests
proxies = {"http": "https://sk_live_abc123:@proxy.proxyapi.se:443",
           "https": "https://sk_live_abc123:@proxy.proxyapi.se:443"}
print(requests.get("https://httpbin.org/ip", proxies=proxies).json())

curl -H 'Authorization: Bearer sk_live_abc123' \
  https://api.proxyapi.se/v1/customer/usage

Targeting per request

Välj proxytyp, land, session eller provider per request genom att lägga till modifierare i proxyanvändarnamnet. Bas-API-nyckeln följs av -nyckel-värde par. Modifierarna påverkar bara den enskilda anslutningen och skriver inte över dina bestående preferenser.

# Endast ISP-proxies i Sverige
curl -x 'https://sk_live_abc123-country-se-type-isp:@proxy.proxyapi.se:443' https://ifconfig.me

# Sticky session (samma exit-IP i 10 min)
curl -x 'https://sk_live_abc123-session-job42-type-residential:@proxy.proxyapi.se:443' https://...

# Tvinga eller exkludera en provider
curl -x 'https://sk_live_abc123-provider-iproyal:@proxy.proxyapi.se:443' https://...
curl -x 'https://sk_live_abc123-provider-!agent:@proxy.proxyapi.se:443' https://...

Modifierare	Värden	Exempel
-type-	`isp`, `residential`, `datacenter`, `mobile`, `agent`	-type-residential
-country-	Två gemena ISO-3166-1-bokstäver	-country-se
-session-	4–32 gemena bokstäver/siffror. Samma id → samma exit-IP (10 min default).	-session-abc42
-ttl-	Sessionens livslängd, högst 60 minuter.	-ttl-30m
-provider-	Endast proxies från denna provider.	-provider-iproyal
-provider-!	Alla providers utom denna.	-provider-!agent

Modifierare kan kombineras i valfri ordning och parsas höger-till-vänster tills första icke-modifierare hittas — resten utgör API-nyckeln.

Bearer-varianten fungerar likvärdigt: Proxy-Authorization: Bearer sk_live_abc123-type-isp.

API-nycklar

GET/v1/customer/keys

Lista alla API-nycklar.

{ "keys": [{ "id": "uuid", "name": "prod", "prefix": "sk_live_abc",
    "created_at": "...", "last_used_at": null, "revoked_at": null }] }

POST/v1/customer/keys

Skapa ny nyckel. Body: {"name": "prod"}

{ "raw": "sk_live_abc123...", "prefix": "sk_live_abc", "name": "prod" }

Nyckeln (raw) visas bara en gång.

DELETE/v1/customer/keys/:id

Återkalla nyckel. Kan inte ångras.

Användningsdata

GET/v1/customer/usage?from=YYYY-MM-DD&to=YYYY-MM-DD&source=all

Daglig användning. source kan vara all, proxy eller validator.

{ "source": "all", "days": [{ "day": "2026-04-13", "gb_used": 0.023, "requests": 1420,
    "bytes_in": 12345678, "bytes_out": 98765432 }],
  "total_gb": 0.456, "total_requests": 28400 }

GET/v1/customer/usage/source-summary?from=...&to=...

Fördelning mellan vanlig proxytrafik och validatortrafik.

{ "validator": { "requests": 24, "gb": 0.02 },
  "proxy": { "requests": 28400, "gb": 12.32 } }

GET/v1/customer/usage/hosts

De 20 största destinationshostarna under innevarande månad.

{ "hosts": [{ "sni_host": "example.com", "gb_used": 0.12, "requests": 5400 }] }

Fakturering & plan

GET/v1/customer/billing

Plan, cykelstatus, kreditbalans. Övervaka kvot programmatiskt.

{ "plan": { "code": "starter", "monthly_price_ore": 9900, "included_gb": 25,
    "overage_ore_per_gb": 500 },
  "current_cycle": { "gb_used": 12.34, "gb_remaining": 12.66,
    "gb_overage": 0, "estimated_overage_cost_ore": 0 },
  "credit_balance_ore": 0, "allow_overage": true, "has_subscription": true }

GET/v1/customer/billing/plans

Lista publika planer med pris, inkluderad data, rate limit och samtidiga sessioner.

POST /v1/customer/billing/checkout · /upgrade · /cancel · GET /portal

Hantera prenumerationen. Checkout tar {"plan":"starter"}, upgrade tar en ny plan, cancel tar valfritt immediately, och portal returnerar portal_url.

Planvärden: starter, pro eller business.

GET/v1/customer/billing/invoices

Fakturahistorik.

{ "invoices": [{ "id": "uuid", "cycle_start": "2026-03-01",
    "cycle_end": "2026-03-31", "gb_used": 18.5, "gb_included": 25,
    "gb_overage": 0, "overage_cost_ore": 0 }] }

Proxy-preferenser

Ange vilken typ av proxy du föredrar. Systemet prioriterar din valda typ men faller automatiskt tillbaka till andra tillgängliga proxies om den föredragna typen inte är tillgänglig.

GET/v1/customer/preferences

Hämta nuvarande preferenser.

{ "proxy_type": "auto", "sticky_sessions": false }

PATCH/v1/customer/preferences

Uppdatera preferenser.

{ "proxy_type": "residential" }

proxy_type	`auto`, `datacenter`, `residential`, `isp`, `mobile`
sticky_sessions	Behåll samma proxy-IP inom en session (`true/false`)

auto (default) — systemet gör ett viktat val baserat på success rate, latens, belastning och administrativ vikt. Rekommenderas för de flesta användningsfall.

Proxy-avstängning

Stäng av enskilda proxies om de inte fungerar mot ditt mål. Selektorn hoppar över dem för din kundidentitet men de är fortfarande tillgängliga för andra kunder. Systemet viktar dessutom automatiskt ner proxies med låg success rate (syns i dashboarden), så manuell avstängning behövs oftast bara om en proxy systematiskt blockas av just din destination.

GET/v1/customer/proxy-exclusions

Lista dina avstängda proxies.

{ "exclusions": [{ "proxyId": "uuid", "proxyHost": "1.2.3.4", "proxyPort": 12323,
    "proxyType": "datacenter", "reason": "blocked by target",
    "createdAt": "2026-04-21T08:00:00Z" }] }

POST/v1/customer/proxy-exclusions

Stäng av en proxy. Tar effekt inom ~10s (selectorns refresh-cykel).

{ "proxy_id": "uuid", "reason": "403 on target" }

DELETE/v1/customer/proxy-exclusions/:proxyId

Återaktivera en tidigare avstängd proxy.

Health validators

Automatiska HTTP-checks via dina proxies. Rapporterar status, svarstid och observerad IP.

GET/v1/customer/validators

Lista alla validators.

POST/v1/customer/validators

Skapa validator.

{ "code": "check-httpbin", "url": "https://httpbin.org/ip",
  "expected_status": 200, "run_interval_sec": 300 }

code	Unik identifierare (obligatorisk)
url	URL att testa (obligatorisk)
expected_status	Förväntat HTTP-status (default 200)
run_interval_sec	Intervall i sekunder (default 300)

PATCH/v1/customer/validators/:id

Uppdatera code, url, expected_status, run_interval_sec eller enabled.

GET/v1/customer/validators/:id/results

De 100 senaste resultaten.

{ "results": [{ "id": "uuid", "startedAt": "2026-04-13T12:00:00Z",
    "responseMs": 234, "statusCode": 200, "success": true,
    "observedIp": "185.x.x.x", "errorMessage": null }] }

DELETE/v1/customer/validators/:id

Ta bort validator och alla resultat.

Felkoder

401

Unauthorized

API-nyckel saknas eller ogiltig.

403

Forbidden

Inte behörig för denna resurs.

404

Not Found

Resursen finns inte.

407

Proxy Auth Required

Proxy-nyckel saknas (proxy-gateway).

429

Too Many Requests

Rate limit eller kvot överskriden.

500

Internal Error

Serverfel. Försök igen.

503

Unavailable

En extern betalningsfunktion är inte konfigurerad eller tillfälligt otillgänglig.

Nästa steg

Övervaka användning i dashboarden
Bygg integrationer med usage- och billing-API:et
Konfigurera health validators för proxyövervakning
Frågor? hello@proxyapi.se