API

API keys and permissions

An API key acts on the account from a program or an AI client within the permissions given to it. A key cannot change the password or email, delete the account or make other keys.

Updated 22 November 2026

Making a key#

  1. Open API keys in the dashboard

    API keys, then Create key.

  2. Choose a name and permissions

    Set a daily limit if the key may buy. Optionally set an end date and a list of allowed IP addresses.

  3. Confirm with the account password

    Accounts that sign in with Google confirm with a 6-digit code sent to the account email. The code is valid for 10 minutes.

  4. Copy the key

    The key is shown once. Proxya keeps only its hash and cannot show it again.

A key starts with proxya_ and is 53 characters long. The prefix lets secret scanners recognise a key published by mistake.

Permissions#

A key holds one or more of four permissions. An endpoint that needs a permission the key does not hold answers 403.

PermissionOpens
readBalance, orders, prices, stock, residential traffic, whitelist and fingerprint state. Proxy logins, passwords and links come back empty, and the order has credentials_hidden: true.
credentialsEverything that lets the holder connect through the proxies: logins, passwords and links, residential proxy generation, mobile VPN configs, adding an address to the IP whitelist and IP authorisation of mobile devices.
purchaseNew orders, renewals and restores, paid from the balance within the key's daily limit.
manageSettings that grant no access: a new proxy password (shown only to a key that also has credentials), mobile IP rotation, OS fingerprint, order notes, removing an address from the whitelist.

Daily limit#

  • A key with the purchase permission must have a daily limit from 1 to 100,000 USD.
  • The limit counts what the key was charged in any 24 hours. A refund does not return the amount to the limit.
  • A purchase that would exceed the limit is refused with 400 and nothing is charged.
  • Purchases in the dashboard do not count towards any key's limit.

End date and allowed IPs#

  • End date: 30, 90, 180 or 365 days, or none. After it the key answers 401.
  • Allowed IPs: up to 20 addresses or networks in CIDR form, IPv4 and IPv6. A request from another address answers 403.
  • If a script reaches the API through a proxy, the API sees the address of the proxy. Add that address, or send API requests without the proxy.

Notifications and the request log#

  • When a key is made, the account gets a dashboard notification and an email with the key's name, permissions and the address it was made from.
  • When a key is first used from a new address, the account gets a dashboard notification, up to 5 a day.
  • Every request with a key is logged with its time, method, path, status and address. The log is on the key's row in the dashboard and is kept for 90 days.

Revoking a key#

Revoke on the key's row stops the key at once. Requests already running complete, new ones answer 401.

Every key of the account is revoked automatically when the password is changed in the dashboard, reset by the email link or reset by support. Setting the first password of an account that signs in with Google does not revoke keys.

Storing a key#

  • Keep the key in an environment variable or a secret store, not in code or in a repository.
  • Give each program its own key with only the permissions it needs.
  • Set a daily limit that covers normal use and no more.
  • If a key may have leaked, revoke it and make a new one.

Up to 10 active keys per account.

Didn't find the answer?

Support answers in the chat on this site around the clock. On Telegram the reply usually comes fastest, and a ticket gets an answer by email.