List API keys - ProxyScrape Docs

GET

account

api-keys

List API keys

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/api-keys \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/api-keys"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "permissions": [
        "<string>"
      ],
      "allowed_subaccounts": [
        "<string>"
      ],
      "allowed_ips": [
        "<string>"
      ],
      "expires_at": 123,
      "is_active": true,
      "last_used_at": 123,
      "token_preview": "<string>",
      "created_at": 123
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Failed to fetch API keys"
}

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Query Parameters

status

enum<string>

default:all

Filter by key status. all (default) returns active and inactive keys; active / inactive return only that status.

Available options:

all,

active,

inactive

string

Case-insensitive substring match against the key name.

page

integer

default:1

Page number (1-based). Used with limit.

Required range: x >= 1

limit

integer

Page size. When set to a value greater than 0, the response includes a meta object with pagination fields.

Required range: x >= 1

Response

List of API keys (no secrets). When limit > 0, includes pagination meta.

success

boolean

data

object[]

Show child attributes

meta

object

Present when limit > 0.

Show child attributes

Place a wallet-paid orderPlace a headless, wallet-paid order. The server forces `pay_with_credit=1` and `no_redirect=1` internally, so the order is debited from your wallet balance with no gateway redirect. `email`, `fname`, and `lname` are derived from the authenticated identity. You can omit them, or pass them explicitly to override. Permission: `account:api_ordering:write` (admin-grant-only — off by default for every account). Authenticate with the `api-token` header. The wallet balance must cover the order total at the moment the call lands.

List API keys

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/api-keys \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/api-keys"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "permissions": [
        "<string>"
      ],
      "allowed_subaccounts": [
        "<string>"
      ],
      "allowed_ips": [
        "<string>"
      ],
      "expires_at": 123,
      "is_active": true,
      "last_used_at": 123,
      "token_preview": "<string>",
      "created_at": 123
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Failed to fetch API keys"
}