traffic

Build the proxy username, URL and code snippets for one connection

Pool, country, rotation and session are encoded in the username; the server validates them (an ISO 3166-1 alpha-2 country or any, the mobile pool only in its mobile countries, session names [a-z0-9_]). rotation: sticky keeps the same device for the session, and the carrier may still change its IP; without a session a stable name is derived for the account. url and snippets contain the real password and are only served to the owning organisation; url_masked is safe to show.

post/v1/traffic/build-url

Request

  • Base URL: https://api.portproof.org
  • URL: https://api.portproof.org/v1/traffic/build-url
  • Auth: one of:
    • API key in cookie pp_session
    • HTTP bearer

Request body

pool'mobile' | 'residential' | 'best' required
countrystring required
rotation'auto5' | 'auto10' | 'auto20' | 'auto60' | 'ondemand' | 'sticky' required
sessionstring
protocol'http' | 'socks5'

Response

Default Response

hoststring required
portinteger required
protocol'http' | 'socks5' required
usernamestring required
sessionstring nullable required
urlstring required
url_maskedstring required

Changes

No recorded changes to this operation across all 1 revision of this API.