Session Types
Rotating IP (Default)
Behavior: You get a new IP address on every single request.
Use Case: Ideal for large-scale scraping tasks where you need maximum diversity of IPs to avoid rate limits and blocks.
How to use: Send requests with your base username, without any session parameters.
Use Case: Ideal for large-scale scraping tasks where you need maximum diversity of IPs to avoid rate limits and blocks.
How to use: Send requests with your base username, without any session parameters.
Sticky IP (Sticky Session)
Behavior: You get a single IP address and can reuse it for a specific period.
Use Case: Essential for any multi-step workflow on a website, such as logging in, adding items to a cart, or navigating through paginated results.
How to use: Add the
Use Case: Essential for any multi-step workflow on a website, such as logging in, adding items to a cart, or navigating through paginated results.
How to use: Add the
-session parameter to your username.Session Control Parameters
These parameters work together to give you full control over your sticky sessions.Session ID (-session)
This is the primary parameter for enabling a sticky session.
Parameter Details
Parameter Details
- Format:
-session-[id] - Value: Any alphanumeric string you choose. This string is your unique identifier for a session.
- Dependencies: None.
- How it works: All requests sent with the same session ID will be routed through the same exit IP for the duration of the session. To get a new IP, simply change the session ID.
- Example Usernames:
...-my_scraper-session-user123(gets IP A)...-my_scraper-session-user123(still gets IP A)...-my_scraper-session-user456(gets a new IP, IP B)
Session Time (-time)
By default, a sticky session lasts for 10 minutes. The -time parameter allows you to change this duration.
Parameter Details
Parameter Details
- Format:
-time-[minutes] - Value: A whole number.
- Dependencies: Must be used together with a
-sessionparameter. - Example Username:
...-my_scraper-session-user123-time-30 - Result: The sticky session for
user123will now last for 30 minutes instead of the default 10. - Error Case: Using
-time-30without-sessionwill result in an error.
Strict Session (-const)
This parameter changes the behavior of the gateway when a session IP goes offline.
Parameter Details
Parameter Details
- Format:
-const(this is a flag, it has no value). - Dependencies: Must be used together with a
-sessionparameter. - Default Behavior (without
-const): If your session IP goes offline, we automatically assign a new IP to your session. This ensures your scraper continues working. - Behavior with
-const: If your session IP goes offline, we do not assign a replacement. Instead, your request will fail with a502 Bad Gatewayerror and anX-2extract-Error: Session IP is offlineheader. - Use Case: Use this only when your workflow is critically dependent on using the exact same IP from start to finish, and you would rather have the process fail than continue with a new IP.
- Example Username:
...-my_scraper-session-user123-time-60-const