Introduction:
Welcome to the Geonode Proxy API! This API allows you to:
- Target specific geolocations (countries, states, cities, and even ISPs).
- Manage sticky sessions to keep a consistent IP across multiple requests.
- Track usage statistics (e.g., bandwidth, session counts).
- Filter proxy types (residential, data center, mobile).
This guide will help you make your first calls, retrieve essential information, and move on to more advanced features—without overwhelming you.
Prerequisites:
- API Credentials: Our API uses Basic Authentication, requiring a proxy username and password for access. You must include these credentials in every request using the Authorization header. (Base64-encoded string)
- Service Name: Indicate which specific service plan or tier you’re using (e.g., residential-premium).
Please refer to our user dashboard to find the information mentioned above.
Basic Workflow:
- Authenticate: Include your proxy username and password in each request using Basic Authentication (via the Authorization header).
- Specify Your Service: Use the appropriate service name in each call so the API applies the correct proxy settings.
- Send Requests: Interact using standard HTTP methods (GET, POST, PUT, etc.).
- Parse JSON Responses: You’ll generally receive JSON objects containing the requested data or error details.
Handling Errors:
While some endpoints may have its own nuances, you’ll commonly see:
- 200 OK – The request was successful.
- 402 Bad Request – Missing or invalid parameters.
- 407 Unauthorized – Incorrect or missing API key/token.
- 429 Too Many Requests – You’ve hit a rate limit.
- 5xx Server Errors – Temporary issues on our side.
We recommend adding retries or fallback logic where appropriate to handle these cases gracefully.
Next Steps:
- Explore the Full Reference: Dive deeper to learn how to configure proxy sessions, target specific regions, or gather usage insights.
- Check Plan Limits: Monitor bandwidth and session counts to stay within your plan’s capacity.
- Stay Informed: Check our Changelog for updates & and new features. Share your opinion on feature requests.
- Contact Support: If you have any questions or run into issues, reach out to our support team at [email protected].