Docs/Quickstart/curl
curl & gateway parameters
The gateway is a standard HTTP/SOCKS5 proxy. Everything — geography, intent, sticky sessions, Personas, attribution — is declared in the proxy username. If your tool can set a proxy, it can use AixIps.
1Prerequisites
curl (or any HTTP client) and an AixIps API key from the console. Snippets use the placeholder sk_test_xxx. No installation step — there is nothing to install.
2Minimal request
The simplest form: username is user-<apikey>, password is any value. The platform picks a default exit.
curl -x "http://user-sk_test_xxx:[email protected]:7777" \
https://httpbin.org/ip3Declare routing parameters
Append optional segments to the username: country for geography, session for sticky reuse (a p_ prefix routes to a Persona), type for intent (explore/session/checkout), and tag for per-agent cost attribution.
# Full username syntax:
# user-{apikey}[-country-{cc}][-session-{sid}][-type-{intent}][-tag-{agent_tag}]
# JP residential, sticky session "s1", attributed to agent "crawler":
curl -x "http://user-sk_test_xxx-country-jp-session-s1-type-session-tag-crawler:[email protected]:7777" \
https://httpbin.org/ip
# Route through a Persona (p_ prefix; country is taken from the Persona):
curl -x "http://user-sk_test_xxx-session-p_jpshopper01:[email protected]:7777" \
https://httpbin.org/ip4SOCKS5 variant
Prefer SOCKS5 for non-HTTP protocols or tools with better SOCKS support. The username syntax is identical.
# SOCKS5 works with the same username syntax:
curl -x "socks5h://user-sk_test_xxx-country-us:[email protected]:1080" \
https://httpbin.org/ip5Verify
The echoed origin IP belongs to the requested region. Check the console Usage page to see the request attributed to your key and tag.
$ curl -x "http://user-sk_test_xxx-country-jp:[email protected]:7777" https://httpbin.org/ip
{
"origin": "203.0.113.42"
}session-p_* targets a Persona, any country parameter is ignored — the Persona's own geography wins, and the conflict is logged as a warning.