For the complete documentation index, see llms.txt. This page is also available as Markdown.

Proxies & IP

Most Hyper Solutions APIs take your proxy's outbound IP as an input. This page explains why, and why you must use sticky (not rotating) proxies.

Most of our sensor APIs require your proxy's outbound IP as an input, because the anti-bot expects the generated payload to match the IP the target site actually sees. Fetch it from the /ip endpoint:

Get IP from session

get

Get IP from session

Header parameters
x-api-keystringRequired

Your API key for authentication

Responses
200

OK IP was returned

application/json
ipstringOptional

The IP

200

OK IP was returned

{
  "ip": "text"
}

Use sticky proxies, never rotating

The IP you send to the API must match the IP the target sees. Rotating proxies break this: they issue a new IP on each new connection (CONNECT), so you get one IP from /ip and the target sees another.

  1. You call /ip and get 1.2.3.4.

  2. You generate a payload for the target using that IP.

  3. Your proxy rotates when it opens the connection to the target.

  4. The target sees 5.6.7.8, but the payload was built for 1.2.3.4, so you're blocked.

Sticky (session) proxies hold the same IP for the whole session, so /ip, the API, and the target all agree.

How to use it

  1. Configure your proxy in sticky/session mode.

  2. Call /ip through that proxy to get your outbound IP.

  3. Pass that IP as the ip input on every sensor call in the session.

See Core Requirements for the other non-negotiables.

Last updated