# Public API

Source: https://docs.evomi.com/public-api/

Welcome to the **Evomi Proxy Provider API**. This API allows you to manage and access your proxy credentials programmatically using a secure API key. You can use this API to:

- Retrieve your proxy credentials.
- Access detailed information about your proxy products.

Our API is designed to be easy to integrate into your applications, providing you with the flexibility to handle proxy management and data access seamlessly.

## Who is this API for?

This API is intended for users who have an account with Evomi and wish to automate the management of their proxy services. Whether you are a developer, system administrator, or advanced user, this API allows you to access and manage your proxies programmatically.

To use the API, you must have an active account with Evomi and an API key. If you're new to the platform, please visit our [dashboard](https://my.evomi.com) and sign up to get started.

## Key Features

- **Retrieve Proxy Credentials:** Get detailed information about your proxy credentials for different proxy types (e.g., Residential Proxies, Mobile Proxies).
- **Balance Information:** Monitor the available bandwidth for each of your proxies.
- **Endpoint Details:** Access proxy endpoint and port details for integration with your applications.

## Getting Started

To get started with the Evomi Public API, you need to obtain an API key from your dashboard. Follow the steps below:

1. **Log in** to your account at [Evomi Dashboard](https://my.evomi.com/settings/api).
2. **Navigate to Settings** > **API**.
3. Copy your **API Key**.

Once you have your API key, you can authenticate and access the proxy data available in your account.

For more details on how to authenticate and use the API, visit the [Authentication](/public-api/authentication/) page.

If you need help with any part of the process, our support team is available to assist you.

For more information, check out our documentation on:

- [Authentication](/public-api/authentication/)
- [Get Proxy Data](/public-api/endpoints/default/)

## Pages in this section

- [Public API Authentication](https://docs.evomi.com/public-api/authentication/index.md): The Public API takes a personal key for your own resources or a team key for a workspace.
- [Get Proxy Data](https://docs.evomi.com/public-api/endpoints/default/index.md): GET /public returns every proxy product on your account with its credentials, balance and endpoint details, which is what you need to wire proxies into an application.
- [Bandwidth Usage](https://docs.evomi.com/public-api/endpoints/bandwidth-usage/index.md): Query proxy bandwidth and request statistics via GET /public/usage, matching the Evomi dashboard history charts.
- [Targeting Options](https://docs.evomi.com/public-api/endpoints/settings/index.md): GET /public/settings lists the targeting each proxy product accepts, countries, cities, regions, ISPs and continents, so you can build proxy strings that resolve.
- [Session Rotation](https://docs.evomi.com/public-api/endpoints/rotate_session/index.md): GET /public/rotatesession forces a new IP for a sticky session while keeping the same session ID.
- [Generate Proxies](https://docs.evomi.com/public-api/endpoints/generate/index.md): GET /public/generate builds proxy strings for a product with your geo-targeting and session parameters, in the list format your tool expects.
- [Get Scraper Data](https://docs.evomi.com/public-api/endpoints/scraper/index.md): GET /public/scraper returns your Scraper API key, remaining credits, concurrency limit and the scraper endpoint URL.
- [Get Browser Data](https://docs.evomi.com/public-api/endpoints/browser/index.md): GET /public/browser returns your Browser API key, remaining credits, concurrency limit, maximum session length and the WebSocket endpoint URL.