API Documentation

Fund your account, generate a personal access token from your dashboard, and buy products programmatically. Create an account or log in to generate a token.

API Documentation

Base URL: https://proxyvendor.com/api

Authenticate every request with a personal access token, sent as a Bearer token:

Authorization: Bearer YOUR_TOKEN
Accept: application/json

All responses are JSON in the shape { "remark", "status", "message", "data" }. A request without a valid token returns HTTP 401. Requests are rate limited to 60 per minute per token.


GET /balance

Returns your current wallet balance.

curl https://proxyvendor.com/api/balance \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Accept: application/json"
{
    "remark": "balance",
    "status": "success",
    "message": { "success": ["Balance retrieved successfully"] },
    "data": { "balance": 25 }
}

GET /products

Lists purchasable products with their current stock. Paginated.

curl https://proxyvendor.com/api/products \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Accept: application/json"
GET /products/{id}

Returns a single product by id.


POST /purchase

Buys a product using your wallet balance. Each unit is deducted from your balance immediately and stock is reserved for you only — there is no way to reserve stock without paying for it.

ParameterTypeRequiredDescription
product_idintegerYesThe product to buy
qtyintegerNo, default 1Number of units to buy
referencestringNoYour reference for this purchase. It must be unique across your orders, up to 100 characters, using letters, numbers, dots, underscores, colons or hyphens.
curl https://proxyvendor.com/api/purchase \
    -X POST \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Accept: application/json" \
    -d "product_id=1&qty=1&reference=client-order-123"
{
    "remark": "purchase_complete",
    "status": "success",
    "message": { "success": ["Purchase completed successfully"] },
    "data": {
        "order_id": 12,
        "reference": "client-order-123",
        "balance": 15,
        "items": ["1.2.3.4:1000:user:pass"]
    }
}

Possible error remarks:

  • out_of_stock — not enough unsold units are left for this product
  • insufficient_balance — your wallet balance is lower than the total price

GET /orders

Lists your completed purchases. Paginated.

GET /orders/{id}

Returns one of your orders, including the purchased credentials for each item.

GET /orders/reference/{reference}

Looks up a completed purchase by the reference you supplied to POST /purchase. Returns the order and purchased credentials. References are scoped to your account.

curl -H "Authorization: Bearer YOUR_TOKEN" -H "Accept: application/json" https://proxyvendor.com/api/orders/reference/client-order-123

The response uses the same order details shape as GET /orders/{id}, including the reference, total amount, creation time and item details. A reference belonging to another account or an unknown reference returns HTTP 404.

Encountered any issue? learn more

Allow