Developer resources

Documentation.

API Reference

Full REST API for managing your proxy account programmatically.

Authentication: The web API routes below use a valid browser session cookie. The separate proxy-service API on port 4000 accepts Authorization: Bearer bm_xxx. Base URL: https://proxy.bluesminds.com

User

GET/api/userAuth: Session

Get current user profile

Response

{
  "id": "clx...",
  "name": "John Doe",
  "email": "john@example.com",
  "creditsBalance": 25.00,
  "tier": "starter",
  "createdAt": "2026-06-01T00:00:00Z"
}
PATCH/api/userAuth: Session

Update user profile (name)

Request Body

{ "name": "New Name" }

Response

{ "id": "...", "name": "New Name", ... }

API Keys

GET/api/keysAuth: Session

List all active API keys

Response

[
  {
    "id": "key_...",
    "name": "Production",
    "prefix": "bm_a1b2c3d4",
    "lastUsedAt": null,
    "createdAt": "2026-06-01T00:00:00Z"
  }
]
POST/api/keysAuth: Session

Create a new API key

Request Body

{ "name": "My Key" }

Response

{
  "id": "key_...",
  "name": "My Key",
  "prefix": "bm_x1y2z3",
  "key": "bm_...full_key...",
  "createdAt": "2026-06-01T00:00:00Z"
}
DELETE/api/keys/:idAuth: Session

Revoke an API key

Response

{ "success": true }

Usage & Billing

GET/api/usageAuth: Session

Get current usage stats

Response

{
  "creditsBalance": 18.50,
  "tier": "starter",
  "bandwidthUsedGb": 12.4,
  "requestCount": 14523
}
GET/api/billingAuth: Session

Get billing history & balance

Response

{
  "creditsBalance": 18.50,
  "tier": "starter",
  "billingRecords": [...]
}

Proxy generation

POST/api/proxy/generateAuth: Session + same origin

Generate scoped BluesMinds relay credentials

Request Body

{ "proxy_type": "res", "country": "us", "protocol": "http", "session_id": "checkout01", "ttl": 3600 }

Response

{
  "proxy_url": "http://res-us-Lsid-checkout01-TTL-3600:...@172.65.145.196:3389",
  "username": "res-us-Lsid-checkout01-TTL-3600",
  "host": "172.65.145.196:3389"
}