{"openapi":"3.1.0","info":{"title":"Proxare API","version":"1.0.0","summary":"Read a proxy account and generate proxy lists.","description":"Residential, mobile and ISP proxies. Authenticate with an API key made in the Proxare dashboard\n(Settings -> API keys) and sent as `Authorization: Bearer pxr_live_...`.\n\nGenerating a proxy list is free: you are billed for the traffic you push through the proxies, never for\nmaking a list, so a client may generate as many lines as it needs. Nothing in this API can spend money.\n\nThere is also an MCP server at https://www.proxare.com/mcp/ with the same capabilities as tools for AI assistants.","contact":{"name":"Proxare support","url":"https://www.proxare.com/contact/"},"license":{"name":"Proprietary","url":"https://www.proxare.com/terms/"}},"servers":[{"url":"https://www.proxare.com/v1","description":"Production"}],"externalDocs":{"description":"Integration guide","url":"https://www.proxare.com/integrations/api/"},"security":[{"apiKey":[]}],"tags":[{"name":"Catalogue","description":"Public: no API key needed."},{"name":"Account","description":"What this account owns and has left."},{"name":"Proxies","description":"Generating proxy lines."},{"name":"Settings","description":"IP whitelist and proxy passwords."}],"paths":{"/products/":{"get":{"tags":["Catalogue"],"operationId":"listProducts","security":[],"summary":"Products and prices","description":"Every product Proxare sells with its pack prices in USD. No API key needed.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products"}}}}}}},"/openapi/":{"get":{"tags":["Catalogue"],"operationId":"getOpenapi","security":[],"summary":"This document","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/account/":{"get":{"tags":["Account"],"operationId":"getAccount","summary":"The account behind the key","description":"Email, the key's own scopes, total GB left, and every product with its live Torch numbers.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/subaccounts/":{"get":{"tags":["Account"],"operationId":"listSubaccounts","summary":"Short list for a dropdown","description":"The same products as /account/, trimmed to what a \"sub-account\" dropdown needs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subaccounts"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/countries/":{"get":{"tags":["Account"],"operationId":"listCountries","summary":"Countries a product can target","parameters":[{"name":"product","in":"query","schema":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"]},"description":"Pass \"mobile\" for the live carrier list."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Countries"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/orders/":{"get":{"tags":["Account"],"operationId":"listOrders","summary":"Paid orders","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/proxies/":{"post":{"tags":["Proxies"],"operationId":"generateProxies","summary":"Generate a proxy list","description":"Builds ready-to-use proxy lines from the account's own login. Each line gets its own session id, so\ncount: 100 means 100 different IPs. Costs no GB.\n\nNeeds the `generate` scope.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRequest"},"examples":{"hundredGerman":{"summary":"100 sticky German IPs for a proxy manager","value":{"product":"private","count":100,"country":"de","sticky":true,"lifetime":"30m","format":"hpup"}},"rotating":{"summary":"One rotating endpoint, SOCKS5","value":{"product":"private","count":1,"sticky":false,"protocol":"socks","format":"url"}},"mixed":{"summary":"50 lines spread over many countries","value":{"product":"private","count":50,"mixed":true}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotOwned"},"409":{"$ref":"#/components/responses/NoPassword"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/Upstream"}}},"get":{"tags":["Proxies"],"operationId":"generateProxiesGet","summary":"Generate a proxy list (query-string form)","description":"The same as POST, for tools that can only make GET requests. Parameters match the POST body.","parameters":[{"name":"product","in":"query","required":true,"schema":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"]}},{"name":"count","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":10}},{"name":"country","in":"query","schema":{"type":"string","pattern":"^[a-z]{2}$"}},{"name":"sticky","in":"query","schema":{"type":"boolean","default":true}},{"name":"protocol","in":"query","schema":{"type":"string","enum":["http","socks"],"default":"http"}},{"name":"format","in":"query","schema":{"type":"string","enum":["hpup","uphp","uphp2","url"],"default":"hpup"}},{"name":"api_key","in":"query","schema":{"type":"string"},"description":"Only for tools that cannot set a header. Prefer Authorization."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/whitelist/":{"post":{"tags":["Settings"],"operationId":"setWhitelist","summary":"Replace the IP whitelist","description":"Those IPs can then connect without a password. The list sent replaces the old one. Needs the `manage` scope.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhitelistRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhitelistResult"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/Upstream"}}}},"/password/":{"post":{"tags":["Settings"],"operationId":"resetPassword","summary":"Reset a proxy password","description":"Makes a new 8-character proxy password. Lists generated with the old password stop working. Needs the `manage` scope.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product"],"properties":{"product":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordResult"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotOwned"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/Upstream"}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"pxr_live_...","description":"An API key from the Proxare dashboard (Settings -> API keys). Scopes: read, generate, manage."}},"responses":{"BadRequest":{"description":"Something in the request is wrong; `error` says what, in plain words.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing, unknown or revoked API key (code: no_key).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The key does not carry the scope this call needs (code: scope).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotOwned":{"description":"The account does not own this product (code: not_owned).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NoPassword":{"description":"The product has no proxy password yet; call /password/ first (code: no_password).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"TooManyRequests":{"description":"120 calls a minute per account. Wait and retry (code: none, HTTP 429).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Upstream":{"description":"The proxy network could not be reached. Retry (code: upstream).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A message that can be shown to a person as it is."},"code":{"type":"string","enum":["no_key","scope","product","format","protocol","region","lifetime","city","carrier","country","not_owned","no_password","ips","unsupported","upstream","not_found"]}}},"Products":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"]},"name":{"type":"string"},"type":{"type":"string","enum":["residential","mobile","isp"]},"unit":{"type":"string","enum":["GB","IP"]},"protocols":{"type":"array","items":{"type":"string","enum":["http","socks"]}},"sticky":{"type":"boolean","description":"Supports sticky sessions."},"city":{"type":"boolean","description":"Supports city targeting."},"carrier":{"type":"boolean","description":"Supports carrier targeting (mobile)."},"prices":{"type":"object"}}}},"cryptoDiscountPct":{"type":"number"},"validityDays":{"type":"integer","description":"How long bought GB stay usable."},"buy":{"type":"string","format":"uri"}}},"Product":{"type":"object","properties":{"product":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"]},"name":{"type":"string"},"type":{"type":"string","enum":["residential","mobile","isp"]},"username":{"type":"string","description":"The proxy login. A secret: never log it."},"limitGb":{"type":"number"},"usedGb":{"type":"number"},"leftGb":{"type":"number","description":"GB left. At 0 the proxies stop connecting; generating still works."},"whitelist":{"type":"array","items":{"type":"string"}},"canWhitelist":{"type":"boolean"},"canResetPassword":{"type":"boolean"},"error":{"type":"string","description":"Set when the network could not be read; the other numbers are then missing."}}},"Account":{"type":"object","properties":{"email":{"type":"string"},"key":{"type":"object","properties":{"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["read","generate","manage"]}}}},"trafficGb":{"type":"object","properties":{"left":{"type":"number"},"used":{"type":"number"}}},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}},"Subaccounts":{"type":"object","properties":{"subaccounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"username":{"type":"string"},"leftGb":{"type":["number","null"]},"usedGb":{"type":["number","null"]},"limitGb":{"type":["number","null"]},"error":{"type":"string"}}}}}},"Countries":{"type":"object","properties":{"product":{"type":["string","null"]},"countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"ISO 3166-1 alpha-2, lower case."},"name":{"type":"string"},"carriers":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}}}}}}}},"Orders":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","enum":["gb","ip"]},"quantity":{"type":"number"},"amount":{"type":"number","description":"USD."},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"paidAt":{"type":["string","null"],"format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"}}}}}},"GenerateRequest":{"type":"object","required":["product"],"properties":{"product":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"],"description":"A product the account owns (see /subaccounts/)."},"count":{"type":"integer","minimum":1,"maximum":1000,"default":10,"description":"How many lines. Values above 1000 are clamped."},"country":{"type":"string","pattern":"^[a-z]{2}$","description":"Two-letter country code. Leave out for any country."},"countries":{"type":"array","items":{"type":"string","pattern":"^[a-z]{2}$"},"description":"Several codes: the list is spread evenly over them, one per line in turn."},"mixed":{"type":"boolean","default":false,"description":"Spread the list over the standard country pool (us, gb, de, fr, nl, es, it, pl, se, ca, br, mx, au, jp, in, sg, tr, za, ae)."},"city":{"type":"string","description":"Only together with a country, e.g. \"new_york\". Letters, digits and underscores."},"carrier":{"type":"string","description":"Mobile only: a carrier code from /countries/?product=mobile."},"sticky":{"type":"boolean","default":true,"description":"true: each line holds one IP for `lifetime`. false: a new IP on every request."},"lifetime":{"type":"string","enum":["10m","30m","1h"],"default":"30m","description":"How long a sticky session keeps its IP."},"protocol":{"type":"string","enum":["http","socks"],"default":"http"},"format":{"type":"string","enum":["hpup","uphp","uphp2","url"],"default":"hpup","description":"hpup = host:port:user:pass, uphp = user:pass@host:port, uphp2 = user:pass:host:port, url = scheme://user:pass@host:port"},"region":{"type":"string","enum":["auto","eu","asia"],"default":"auto","description":"Which gateway to connect to. Pick the one nearest your server; it does not change the exit country."}}},"ProxyList":{"type":"object","properties":{"product":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"scheme":{"type":"string","enum":["http","socks5h"]},"username":{"type":"string"},"rotating":{"type":"boolean"},"countries":{"type":"array","items":{"type":"string"}},"format":{"type":"string"},"leftGb":{"type":"number"},"usedGb":{"type":"number"},"proxies":{"type":"array","items":{"type":"string"},"description":"The lines, in the requested format. Write them straight into a proxy list file."}}},"WhitelistRequest":{"type":"object","required":["ips"],"properties":{"ips":{"type":"array","maxItems":10,"items":{"type":"string","format":"ipv4"},"description":"Public IPv4 addresses. Replaces the current list."},"product":{"type":"string","enum":["oxylabs","decodo","brightdata","iproyal","private","basic","geonode","packetstream","mobile","isp"],"description":"Only this product. Left out: every product that supports a whitelist."}}},"WhitelistResult":{"type":"object","properties":{"ok":{"type":"boolean"},"ips":{"type":"array","items":{"type":"string"}},"products":{"type":"array","items":{"type":"string"}},"failed":{"type":"array","items":{"type":"string"}}}},"PasswordResult":{"type":"object","properties":{"ok":{"type":"boolean"},"product":{"type":"string"},"username":{"type":"string"},"password":{"type":"string","description":"The new password, shown once here."}}}}}}