Datacenter & ISP Proxies

Operations for datacenter and ISP proxies

Get active proxies by order

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

order_idintegerRequired

Responses

200

Proxy list

application/json

successbooleanRequired

order_tagstring · nullableOptional

403

Method is unavailable for this order

application/json

get

/user/api/proxies/active

GET /user/api/proxies/active?order_id=1 HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": [
    {
      "ip": "text",
      "username": "text",
      "password": "text",
      "http_port": 1,
      "socks_port": 1,
      "until": "text",
      "status": "text"
    }
  ],
  "order_tag": "text"
}

Set del-np (per-IP deletion)

post

Only for Datacenter & ISP proxies. After updating, the order quantity and price_paid are recalculated.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Body

Responses

200

Success

application/json

successbooleanOptional

messagestringOptional

400

Validation error / not DC-ISP / keep=0

application/json

post

/user/api/orders/{order_id}/del-np/set

POST /user/api/orders/{order_id}/del-np/set HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "items": [
    {
      "ip": "1.2.3.4",
      "value": true
    }
  ]
}

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

Set IP OS-fingerprint signature

post

Sets the OS-fingerprint signature for one or more proxy IPs. Requires the p0f_slots add-on to be active on the order.

Each IP that receives a signature permanently occupies one slot. Changing the OS value on an IP that already has a signature does not consume an extra slot.

Available signature values:

Value

ios

iOS

macos

macOS

android

Android

linux

Linux

win10

Windows 10

win11

Windows 11

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Body

Responses

200

Success

application/json

successbooleanOptional

messagestringOptional

updatedintegerOptional

Number of IPs updated

400

Validation error or not enough slots

application/json

post

/user/api/orders/{order_id}/signature/set

POST /user/api/orders/{order_id}/signature/set HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "items": [
    {
      "ip": "1.2.3.4",
      "signature": "win10"
    }
  ]
}

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

Calculate add-on price

get

Returns the price preview for purchasing additional units of a given add-on for an active datacenter/ISP order. Currently the only supported add-on key is p0f_slots — OS-fingerprint signature slots.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Order ID

Query parameters

addon_keystringRequired

Add-on identifier (e.g. p0f_slots)

Example: p0f_slots

add_qtyinteger · min: 1Required

Number of units to add

Example: 2

Responses

200

Price preview

application/json

successbooleanOptional

addon_keystringOptional

catalog_idintegerOptional

price_per_unitintegerOptional

Price per unit in cents

current_qtyintegerOptional

add_qtyintegerOptional

new_qtyintegerOptional

add_totalintegerOptional

Total charge for this purchase in cents

get

/user/api/orders/{order_id}/addons/calculate

GET /user/api/orders/{order_id}/addons/calculate?addon_key=p0f_slots&add_qty=2 HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Price preview

{
  "success": true,
  "addon_key": "text",
  "catalog_id": 1,
  "price_per_unit": 1,
  "current_qty": 1,
  "add_qty": 1,
  "new_qty": 1,
  "add_total": 1
}

Purchase an add-on

post

Immediately charges the wallet and adds the requested number of add-on units to the order. The order must be active. The only currently available add-on key is p0f_slots.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Order ID

Body

addon_keystringRequiredExample: p0f_slots

add_qtyinteger · min: 1RequiredExample: 2

Responses

200

Add-on purchased

application/json

successbooleanOptional

messagestringOptional

addons_price_paidintegerOptional

Cumulative add-on cost for this order (cents)

post

/user/api/orders/{order_id}/addons/purchase

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

{
  "addon_key": "p0f_slots",
  "add_qty": 2
}

200

Add-on purchased

{
  "success": true,
  "message": "text",
  "addons_price_paid": 1,
  "addons": [
    {
      "addon_key": "p0f_slots",
      "catalog_id": 1,
      "qty": 1,
      "price_per_unit": 1,
      "pending": {
        "action": "cancel",
        "next_qty": 1
      }
    }
  ]
}

Schedule add-on downgrade for next renewal

post

Schedules a downgrade of an add-on to take effect on the next renewal cycle. The new quantity must be lower than the current one. The change is stored as a pending marker and applied automatically when the order renews.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Order ID

Body

addon_keystringRequiredExample: p0f_slots

actionstring · enumRequiredExample: downgradePossible values:

next_qtyinteger · min: 1Required

Target quantity after renewal. Must be less than current qty.

Example: 1

Responses

200

Downgrade scheduled

application/json

successbooleanOptional

messagestringOptional

post

/user/api/orders/{order_id}/addons/schedule

POST /user/api/orders/{order_id}/addons/schedule HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "addon_key": "p0f_slots",
  "action": "downgrade",
  "next_qty": 1
}

200

Downgrade scheduled

{
  "success": true,
  "message": "text",
  "addons": [
    {
      "addon_key": "p0f_slots",
      "catalog_id": 1,
      "qty": 1,
      "price_per_unit": 1,
      "pending": {
        "action": "cancel",
        "next_qty": 1
      }
    }
  ]
}

Cancel a scheduled downgrade

post

Removes the pending downgrade that was set via the schedule endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Order ID

Body

addon_keystringRequiredExample: p0f_slots

Responses

200

Pending downgrade cleared

application/json

successbooleanOptional

messagestringOptional

post

/user/api/orders/{order_id}/addons/schedule/cancel

POST /user/api/orders/{order_id}/addons/schedule/cancel HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "addon_key": "p0f_slots"
}

200

Pending downgrade cleared

{
  "success": true,
  "message": "text",
  "addons": [
    {
      "addon_key": "p0f_slots",
      "catalog_id": 1,
      "qty": 1,
      "price_per_unit": 1,
      "pending": {
        "action": "cancel",
        "next_qty": 1
      }
    }
  ]
}

PreviousSoftware solutions for enabling WebRTC NextResidential Proxies

Last updated 8 days ago

Was this helpful?