# ProxyScrape Docs

> ProxyScrape API documentation. Use the API to get proxy lists and manage your account with API keys.

## Docs

- [ProxyScrape API](https://docs.proxyscrape.com/api-overview.md): Use the ProxyScrape API to get free proxy lists and manage your account programmatically.
- [Create API key](https://docs.proxyscrape.com/api-reference/create-api-key.md): Create a new API key with a name, permissions, and optional scopes (allowed_subaccounts, allowed_ips, expires_at). The full 64-character token is returned **only once** in this response — store it securely. Permission: `account:apikeys:create`.
- [Countries available (datacenter)](https://docs.proxyscrape.com/api-reference/datacenter/countries-available-datacenter.md): List countries available for the datacenter subaccount. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.
- [Datacenter overview](https://docs.proxyscrape.com/api-reference/datacenter/datacenter-overview.md): Get datacenter subscription overview for a subaccount: plan details, proxy count, status, and expiration. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.
- [Datacenter usage](https://docs.proxyscrape.com/api-reference/datacenter/datacenter-usage.md): Get bandwidth and request usage for the datacenter subaccount. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.
- [Get datacenter proxy list](https://docs.proxyscrape.com/api-reference/datacenter/get-datacenter-proxy-list.md): Get the datacenter proxy list for a subaccount. Filter by country, protocol, format, and status. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.
- [Manage IP whitelist](https://docs.proxyscrape.com/api-reference/datacenter/manage-ip-whitelist.md): Manage the IP whitelist for the datacenter subaccount. Use the `type` query parameter: `get` to list IPs, `add` to add IPs, `remove` to remove IPs, `set` to replace all IPs. Permission: one of `datacenter_shared:read/write/delete` or `datacenter_dedicated:read/write/delete`.
- [Usage requests](https://docs.proxyscrape.com/api-reference/datacenter/usage-requests.md): Get recent API usage requests for the datacenter subaccount. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.
- [Get allowed permissions](https://docs.proxyscrape.com/api-reference/get-allowed-permissions.md): Returns the flat list of permissions you may grant to API keys. Use this to populate a permissions UI or validate the `permissions` array when creating a key. Permission: `account:apikeys:read`.
- [Get API key](https://docs.proxyscrape.com/api-reference/get-api-key.md): Get a single API key by its UUID. Returns metadata only — the secret is never returned after creation. Permission: `account:apikeys:read`.
- [Get permission context](https://docs.proxyscrape.com/api-reference/get-permission-context.md): Returns the permission structure and allowed permissions for your account. Use this to build permission selection UIs or validate permissions before creating a key. Permission: `account:apikeys:read`.
- [List API keys](https://docs.proxyscrape.com/api-reference/list-api-keys.md): List all API keys for the account. Returns key metadata (id, name, permissions, scopes, expiry) but never the secret. Permission: `account:apikeys:read`.
- [List subaccounts](https://docs.proxyscrape.com/api-reference/list-subaccounts.md): List all subaccounts for the authenticated account. Each subaccount has its own products (datacenter, residential, etc.). Permission: `subaccount:read`.
- [Get proxy list](https://docs.proxyscrape.com/api-reference/public-api/get-proxy-list.md): Returns a list of free proxies. Use query parameters to filter by protocol, country, timeout, anonymity, and more. Results can be displayed in the browser or returned for download.
- [Regenerate API key](https://docs.proxyscrape.com/api-reference/regenerate-api-key.md): Regenerate the secret for an API key. The old secret stops working immediately. The new 64-character secret is returned **only in this response** — store it securely. You cannot regenerate the key you are currently using. Permission: `account:apikeys:regenerate`.
- [Countries](https://docs.proxyscrape.com/api-reference/residential-unlimited/countries.md): List available countries for residential unlimited proxies. Permission: `residential_unlimited:read`.
- [Residential unlimited overview](https://docs.proxyscrape.com/api-reference/residential-unlimited/residential-unlimited-overview.md): Get residential unlimited subscription overview: plan, status, connection details. Permission: `residential_unlimited:read`.
- [Statistics](https://docs.proxyscrape.com/api-reference/residential-unlimited/statistics.md): Get usage statistics for the residential unlimited subaccount. Permission: `residential_unlimited:read`.
- [Update password](https://docs.proxyscrape.com/api-reference/residential-unlimited/update-password.md): Update the password for the residential unlimited subaccount. Permission: `residential_unlimited:write`.
- [Create subuser](https://docs.proxyscrape.com/api-reference/residential/create-subuser.md): Create a new residential subuser with a username and password. Permission: `residential:write`.
- [Delete subuser](https://docs.proxyscrape.com/api-reference/residential/delete-subuser.md): Delete a residential subuser. Permission: `residential:delete`.
- [Get subuser(s)](https://docs.proxyscrape.com/api-reference/residential/get-subusers.md): List all residential subusers for a subaccount. Permission: `residential:read`.
- [Reset subuser password](https://docs.proxyscrape.com/api-reference/residential/reset-subuser-password.md): Reset the password for a residential subuser. Permission: `residential:write`.
- [Residential countries](https://docs.proxyscrape.com/api-reference/residential/residential-countries.md): List available countries for residential proxies. Permission: `residential:read`.
- [Residential login info](https://docs.proxyscrape.com/api-reference/residential/residential-login-info.md): Get login credentials for the residential subaccount. Permission: `residential:read`.
- [Residential overview](https://docs.proxyscrape.com/api-reference/residential/residential-overview.md): Get residential subscription overview: plan, bandwidth used/remaining, status. Permission: `residential:read`.
- [Subuser response time status](https://docs.proxyscrape.com/api-reference/residential/subuser-response-time-status.md): Get response time status for residential subusers. Permission: `residential:read`.
- [Subuser statistic](https://docs.proxyscrape.com/api-reference/residential/subuser-statistic.md): Get usage statistics for a residential subuser. Permission: `residential:read`.
- [Subuser uptime status](https://docs.proxyscrape.com/api-reference/residential/subuser-uptime-status.md): Get uptime status for residential subusers. Permission: `residential:read`.
- [Subuser usage](https://docs.proxyscrape.com/api-reference/residential/subuser-usage.md): Get bandwidth usage for a residential subuser. Permission: `residential:read`.
- [Subuser usage requests](https://docs.proxyscrape.com/api-reference/residential/subuser-usage-requests.md): Get recent API usage requests for a residential subuser. Permission: `residential:read`.
- [Update subuser](https://docs.proxyscrape.com/api-reference/residential/update-subuser.md): Update a residential subuser's username or password. Permission: `residential:write`.
- [Revoke API key](https://docs.proxyscrape.com/api-reference/revoke-api-key.md): Permanently revoke an API key. The key can no longer be used for authentication. You cannot revoke the key you are currently using — use a different key. Permission: `account:apikeys:delete`.
- [Create SERP API subuser](https://docs.proxyscrape.com/api-reference/serp-api/create-serp-api-subuser.md): Create a new SERP API subuser with a username and password. Permission: `serp_api:write`.
- [Delete SERP API subuser](https://docs.proxyscrape.com/api-reference/serp-api/delete-serp-api-subuser.md): Delete a SERP API subuser. Permission: `serp_api:delete`.
- [Get SERP API subuser(s)](https://docs.proxyscrape.com/api-reference/serp-api/get-serp-api-subusers.md): List SERP API subusers for a subaccount. Permission: `serp_api:read`.
- [Reset SERP API subuser password](https://docs.proxyscrape.com/api-reference/serp-api/reset-serp-api-subuser-password.md): Reset the password for a SERP API subuser. Permission: `serp_api:write`.
- [SERP API overview](https://docs.proxyscrape.com/api-reference/serp-api/serp-api-overview.md): Get SERP API subscription overview: plan, credits used/remaining, status. Permission: `serp_api:read`.
- [SERP API search](https://docs.proxyscrape.com/api-reference/serp-api/serp-api-search.md): Execute a SERP API search query. Returns search engine results. Permission: `serp_api:write`.
- [Update SERP API subuser](https://docs.proxyscrape.com/api-reference/serp-api/update-serp-api-subuser.md): Update a SERP API subuser's username or password. Permission: `serp_api:write`.
- [Countries available for subaccount](https://docs.proxyscrape.com/api-reference/subaccounts/countries-available-for-subaccount.md): List countries available for a subaccount. Use these country codes when filtering proxy lists or configuring locations. Permission: `subaccount:read`.
- [Get subaccount preferences](https://docs.proxyscrape.com/api-reference/subaccounts/get-subaccount-preferences.md): Get preferences for a subaccount (label, visibility). Permission: `subaccount:read`.
- [Update subaccount preferences](https://docs.proxyscrape.com/api-reference/subaccounts/update-subaccount-preferences.md): Update subaccount preferences such as label or is_hidden. Permission: `subaccount:write`.
- [Update API key](https://docs.proxyscrape.com/api-reference/update-api-key.md): Update an API key's name, permissions, allowed_subaccounts, allowed_ips, expires_at, or is_active. The response includes an `updated_fields` array showing which fields changed. Permission: `account:apikeys:update`.
- [Authentication](https://docs.proxyscrape.com/api/account/authentication.md): Send your API key in the api-token header and use the correct base URL and path prefix.
- [Create a key](https://docs.proxyscrape.com/api/account/create.md): Create your first API key from the dashboard; create additional keys via the dashboard or the API.
- [Errors](https://docs.proxyscrape.com/api/account/errors.md): HTTP 401 and 403 and standard error shape for Account API requests.
- [Manage keys](https://docs.proxyscrape.com/api/account/lifecycle.md): View, edit, regenerate, and revoke API keys from the dashboard or API.
- [Account API overview](https://docs.proxyscrape.com/api/account/overview.md): What API keys are and how they work across ProxyScrape products.
- [Permission reference](https://docs.proxyscrape.com/api/account/permission-reference.md): Reference of product (2-part) and account API key (3-part) permissions.
- [Permissions](https://docs.proxyscrape.com/api/account/permissions.md): How API key permissions work, how to choose them in the dashboard, and how to discover them via the API.
- [Scopes and restrictions](https://docs.proxyscrape.com/api/account/scopes-restrictions.md): Limit API key access with subaccount scoping, IP restrictions, and expiration.

## OpenAPI Specs

- [openapi-account](https://docs.proxyscrape.com/openapi-account.json)
- [openapi-public](https://docs.proxyscrape.com/openapi-public.json)
- [openapi](https://docs.proxyscrape.com/openapi.json)