General

General operations (profile, orders, reference data)

Create and pay for an order

post

Purchase by product name, location, and cycle. For Datacenter/ISP, location is required. For Standart Residential Proxy, location is not required.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Success

application/json

successbooleanRequiredExample: true

messagestringRequiredExample: Order paid successfully

order_idintegerRequired

400

Validation/balance error/insufficient stock

application/json

401

Unauthorized

application/json

post

/user/api/orders/purchase

POST /user/api/orders/purchase HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "product": "Datacenter Proxy",
  "location": "DE",
  "cycle": "monthly",
  "quantity": 10,
  "auto_renewal": true
}

{
  "success": true,
  "message": "Order paid successfully",
  "order_id": 1
}

Calculate order price

get

Calculates price by product name, cycle name and quantity. Uses the same validation rules as purchase (allowed billing cycles, promo rules).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

productstringRequiredExample: Datacenter Proxy

locationstring · nullableOptionalExample: DE

cyclestring · nullableOptionalExample: monthly

quantityinteger · nullableOptionalExample: 10

promo_codestring · nullableOptionalExample: SAVE10

Responses

200

Success

application/json

original_priceintegerOptional

final_priceintegerOptional

discount_percentintegerOptional

400

Validation error

application/json

401

Unauthorized

application/json

get

/user/api/orders/calculate

GET /user/api/orders/calculate?product=Datacenter+Proxy HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "original_price": 1,
  "final_price": 1,
  "discount_percent": 1
}

Change the order billing cycle

post

Changes the billing cycle by cycle name. Only for Datacenter & ISP proxies. If the promo code is not available for the selected cycle, it will be automatically reset.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Body

cyclestringRequiredExample: monthly

Responses

200

Success

application/json

successbooleanOptional

messagestringOptional

order_idintegerOptional

original_priceintegerOptional

final_priceintegerOptional

discount_percentintegerOptional

400

Invalid product or cycle

application/json

401

Unauthorized

application/json

403

Cycle is not available for this user

application/json

post

/user/api/orders/change-billing-cycle/{order_id}

POST /user/api/orders/change-billing-cycle/{order_id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "cycle": "monthly"
}

{
  "success": true,
  "message": "text",
  "order_id": 1,
  "original_price": 1,
  "final_price": 1,
  "discount_percent": 1
}

Change order auto-renewal

post

Enable/disable auto-renewal. Only for Datacenter & ISP proxies.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Query parameters

auto_renewalbooleanRequiredExample: true

Responses

200

Success

application/json

successbooleanOptional

messagestringOptional

400

Invalid product for this operation

application/json

401

Unauthorized

application/json

post

/user/api/orders/edit-auto-renewal/{order_id}

POST /user/api/orders/edit-auto-renewal/{order_id}?auto_renewal=true HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text"
}

Get products and their cycles

get

Returns API products with the names of available cycles.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Product list

application/json

successbooleanRequired

get

/user/api/proxies/products

GET /user/api/proxies/products HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Product list

{
  "success": true,
  "products": [
    {
      "name": "text",
      "description": "text",
      "location": "text",
      "cycles": [
        "text"
      ]
    }
  ]
}

Get the available number of proxies

get

Returns the total available quantity for all products.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

application/json

countrystringRequired

productstringRequired

amountintegerRequired

get

/user/api/proxies/available-count

GET /user/api/proxies/available-count HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

[
  {
    "country": "text",
    "product": "text",
    "amount": 1
  }
]

User information

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Profile data

application/json

emailstringRequired

active_ordersintegerRequired

wallet_balanceintegerRequired

in cents

get

/user/api/me

GET /user/api/me HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Profile data

{
  "email": "text",
  "active_orders": 1,
  "wallet_balance": 1
}

Order list

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstringRequired

active | on-hold | cancelled | all

offsetintegerOptional

Result offset (default 0)

Example: 0

limitinteger · min: 1 · max: 100Optional

Page size (1..100, default 20)

Example: 20

Responses

200

Order list

application/json

successbooleanRequired

countintegerOptional

Number of orders in the current result set

prevstring · nullableOptional

Previous page URI

nextstring · nullableOptional

Next page URI

get

/user/api/orders

GET /user/api/orders?status=text HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Order list

{
  "success": true,
  "orders": [
    {
      "order_id": 1,
      "product_id": 1,
      "product_name": "text",
      "cycle_id": 1,
      "cycle_name": "text",
      "expires_at": "text",
      "auto_renewal": true,
      "tag": "text"
    }
  ],
  "count": 1,
  "prev": "text",
  "next": "text"
}

Get order information

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

Order information

application/json

successbooleanRequired

get

/user/api/orders/{id}

GET /user/api/orders/{id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Order information

{
  "success": true,
  "order": {
    "order_id": 1,
    "product_name": "text",
    "cycle_name": "text",
    "quantity": 1,
    "price_paid": 1,
    "addons_price_paid": 1,
    "addons": [
      {
        "addon_key": "p0f_slots",
        "catalog_id": 1,
        "qty": 1,
        "price_per_unit": 1,
        "pending": {
          "action": "cancel",
          "next_qty": 1
        }
      }
    ],
    "p0f_slots_available": 1,
    "p0f_slots_used": 1,
    "p0f_slots_next": 1,
    "status": "text",
    "created_at": "text",
    "expires_at": "text",
    "promo_code": "text",
    "auto_renewal": true,
    "tag": "text"
  }
}

Renew order

post

Renewal is available only when order status is on-hold.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

Success

application/json

successbooleanRequired

400

Insufficient balance/validation

application/json

post

/user/api/orders/{id}/renew

POST /user/api/orders/{id}/renew HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

Change order tag

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Body

tagstringRequiredExample: none

Responses

200

Success

application/json

successbooleanRequired

post

/user/api/orders/{id}/tag

POST /user/api/orders/{id}/tag HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "tag": "none"
}

200

Success

{
  "success": true
}

PreviousResidential Proxies NextModels

Last updated 8 days ago

Was this helpful?