Smartproxy-API

Smartproxy-API copied to clipboard

List of contents

• Introduction
• Authentication
• Get sub users
• Create subuser
• Update subuser
• Get sub user traffic
• Delete subuser
• Get whitelisted IPs
• Delete subuser
• Get whitelisted IPs
• Add whitelisted IPs
• Delete whitelisted IP
• Get subscriptions
• Get endpoints
• Get endpoints by type
• License

Introduction

With Smartproxy API you will be able to access proxies and take full control over your account.

• Create, Update, Delete and set traffic limits for your proxy users
• Pull out reports for traffic usage
• Create and Delete whitelisted IPs to simplify authentication
• Filter and list all endpoints with ports
• Check the status of your current subscription

Need more API code examples or information? Visit our main documentation.
Looking for something else? Visit our General Repository for more fun.

Authentication

API Link: https://api.smartproxy.com/v1/auth

Request

POST /auth/

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
"user_id": "d3af2539-4259-4484-a355-062fd1111"
"token": "sdfdsfeXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyODI0LCJ1c2VybmFtZSI6InBhdWxpdXN0YXIiLCJleHAiOjE"
}

Take a note of or implement functionality to pass user_id and token parameters to other API calls as it will be required to navigate.

Examples

Get sub users

API Link: https://api.smartproxy.com/v1/users/{userId}/sub-users

Request

GET users/:userId/sub-users

Response

HTTP/1.1 200 OK
Content-Type: application/json
[
  0:{
    "id":24570
    "username":"name"
    "status":"active"
    "created_at":"2019-03-23 13:08"
    "traffic_limit":NULL
    "service_type":"residential_proxies"
  }
]

Examples

Create subuser

API Link: https://api.smartproxy.com/v1/users/{userId}/sub-users

Request

POST users/:userId/sub-users

Request body

{"username":"","password":"","service_type":""}

Response

HTTP/1.1 201 Created
Content-Type: application/json
{}

Examples

Update subuser

API Link: https://api.smartproxy.com/v1/users/{userId}/sub-users

Request

PUT users/:userId/sub-users

Request body

{"traffic_limit":0,"password":""}

Response

HTTP/1.1 201 Created
Content-Type: application/json
{}

Examples

Get sub user traffic

API Link: https://api.smartproxy.com/v1/users/{userId}/sub-users/{username}/traffic

Request

GET users/:userId/sub-users/:username/traffic

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
"traffic":0.04
}

Examples

Delete subuser

API Link: https://api.smartproxy.com/v1/users/{userId}/sub-users/{sub_user_id}

Request

DELETE users/:userId/sub-users/:sub_user_id

Response

HTTP/1.1 204 No Content
Content-Type: application/json
{}

Examples

Get whitelisted IPs

API Link: https://api.smartproxy.com/v1/users/{userId}/whitelisted-ips

Request

GET users/:userId/whitelisted-ips

Response

HTTP/1.1 200 OK
Content-Type: application/json
[
  0:{
    "id":69489
    "ip":"127.0.0.1"
    "enabled":true
    "created_at":"2019-05-22 12:44"
    }
]

Examples

Add whitelisted IPs

API Link: https://api.smartproxy.com/v1/users/{userId}/whitelisted-ips

Request

POST users/:userId/whitelisted-ips

Request body

{"IPAddressList":[null]}

Response

HTTP/1.1 200 OK
Content-Type: application/json
{}

Examples

Delete whitelisted IP

API Link: https://api.smartproxy.com/v1/users/{userId}/whitelisted-ips/{id}

Request

DELETE users/:userId/whitelisted-ips/:id

Response

HTTP/1.1 204 No Content
Content-Type: application/json
{}

Examples

Get subscriptions

API Link: https://api.smartproxy.com/v1/users/{userId}/subscriptions

Request

GET users/:userId/subscriptions

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
"traffic_limit":"50"
"traffic_per_period":"0.15"
"users_limit":3
"ip_address_limit":2
"valid_from":"2018-11-08"
"valid_until":"2019-06-30"
"service_type":"residential_proxies"
}

Examples

Get endpoints

API Link: https://api.smartproxy.com/v1/endpoints

Request

GET endpoints

Response

HTTP/1.1 200 OK
Content-Type: application/json
[
  0:{
    "type":"random"
    "available_locations":"148"
    "url":"endpoints/random"
  }
  1:{
    "type":"sticky"
    "available_locations":"62"
    "url":"endpoints/sticky"
  }
]

Examples

Get endpoints by type

API Link: https://api.smartproxy.com/v1/endpoints/{type}

Request

GET endpoints/:type

Response

HTTP/1.1 200 OK
Content-Type: application/json
[
  0:{
    "location":"Random"
    "hostname":"gate.smartproxy.com"
    "port_range":"7000"
  }
  1:{
    "location":"Canada"
    "hostname":"ca.smartproxy.com"
    "port_range":"20000"
  }
]

Examples

License

All code is released under MIT License

Need help?

Email - [email protected]
Live chat 24/7