Proxy Server API

Introduction

The Webshare API follows the principles of Representational State Transfer (REST) architecture. It has been designed to provide predictable resource-oriented URLs, accept JSON-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes, authentication, and verbs.

One of the key features of the Webshare API is its support for backwards compatibility, which ensures that any changes made to the API are always backwards compatible. This means that clients using previous versions of the API will not be affected by the updates.

In addition to its features, the Webshare API also provides language examples. You can find these code examples on the every feature's page. To switch between the two programming languages, use the tabs located in the top right corner.

By leveraging the Webshare API, developers can easily integrate Webshare's functionality into their applications, allowing them to enhance their users' experience and increase the efficiency of their workflow.

Authentication

Authenticated Request Example.

Webshare API uses token to allow access to the API. You will receive token after a successful login request. Alternatively, you can register a new Webshare API key at our API keys (opens in a new tab) page.

Webshare API expects for the token to be included in all API requests to the server in a header that looks like the following: Authorization: Token <TOKEN>

import requests
 
requests.get(
  "https://proxy.webshare.io/api/v2/profile/",
  headers={ "Authorization": "Token Log In" }
)

Pagination

The Webshare API uses pagination on some of its resource endpoints. The following GET query parameters are used to determine the current page and the page_size.

Some APIs which has streaming activity may opt to use starting_after instead of the page field. In either case, the page_size field is available.

Request parameters

You can add the request parameters as part of your URL.

Response format

Response is in JSON object format with the following fields.

Example

import requests
 
response = requests.get(
  "https://proxy.webshare.io/api/v2/proxy/list/?page=4&page_size=10"
)
 
response.json()

{
  "count": 35,
  "next": null,
  "previous": "https://proxy.webshare.io/api/v2/proxy/list/?page=3&page_size=10",
  "results": [
    { ... },
    { ... },
    { ... },
  ]
}

Rate Limits

The Webshare API uses rate limits for various endpoints.

Filtering & Ordering

The Webshare API uses filtering, search and ordering on list resource endpoints. The following GET query parameters are used to determine the ordering and filtering.

Ordering

You can order a list resource endpoint by some fields available in the instance object. For example, integer and date fields can be commonly used for ordering.

You can combine multiple ordering fields and change ASC/DESC order.

Request parameters

You can add the request parameters as part of your URL.

Examples

import requests
 
response = requests.get(
  "https://proxy.webshare.io/api/v2/payment/transaction/?ordering=status,-created_at"
)
 
response.json()

Filtering

You can filter list resource endpoints by exact, greater than, less than and contains methods.

Exact match

Match the field to the given value. Can be used for any field type.

?status=completed

Multi match

Match the field to the given value. Can be used for any field type. Multiple values can be comma separated.

?status__in=completed,refunded

Greater than

Retrieve the fields with greater than given value. Can be used for datetime and number fields.

`?amount__gt=1337`

Less than

Retrieve the fields with less than given value. Can be used for datetime and number fields.

`?amount__lt=1337`

Contains match

Check if the given value is in the field. Can be used for string fields only.

`?status__contains=completed`

Examples

import requests
 
response = requests.get(
  "https://proxy.webshare.io/api/payment/transaction/?status=completed,refunded&amount__lt=1337"
)
 
response.json()

Search

You can perform text search on resource endpoints. Generally, only the text fields will be included as part of the search.

import requests
 
response = requests.get(
  "https://proxy.webshare.io/api/v2/payment/transaction/?search=Free"
)
 
response.json()

Errors

The Webshare API uses the following error codes:

Federated Access

Add the X-Webshare-Federated-Access header to your API calls to retrieve data as a particular user.

import requests
 
response = requests.get("https://proxy.webshare.io/api/v2/profile/", headers={
    "Authorization": "Token Log In",
    "X-Webshare-Federated-Access": "<User ID>"
})
response.json()