← Tools Reference

Webshare

Webshare integration (Developer Tools, Data). Imported from open-connector.

API key4 toolshttps://proxy.webshare.io
GET
webshare_get_profile
Get the Webshare account profile for the connected API key.

/api/v2/profile/

GET
webshare_list_proxies
List Webshare proxies with official mode, pagination, and filter options.

/api/v2/proxy/list/

13 parameters
ParamTypeRequiredDescription
modestringoptionalThe Webshare proxy list mode.
planIdstringoptionalThe Webshare plan ID to target. When omitted, Webshare uses the default plan.
pageintegeroptionalThe page number to return.
pageSizeintegeroptionalThe number of proxies to return per page.
country_code__instringoptionalComma-separated country codes used to filter proxies.
searchstringoptionalSearch phrase used to filter direct-mode proxies.
orderingstringoptionalComma-separated ordering fields such as -valid,proxy_address.
created_atstringoptionalProxy creation date filter accepted by Webshare.
proxy_addressstringoptionalA specific proxy address to filter by.
proxy_address__instringoptionalComma-separated proxy addresses to filter by.
validbooleanoptionalFilter proxies by validity.
asn_numberstringoptionalASN number used to filter direct-mode proxies.
asn_namestringoptionalASN name used to filter direct-mode proxies.
GET
webshare_get_proxy_config
Get the Webshare proxy configuration for a plan.

/api/v3/proxy/config

1 parameter
ParamTypeRequiredDescription
planIdstringrequiredThe Webshare plan ID whose proxy config should be returned.
GET
webshare_list_stats
List Webshare hourly proxy usage stats for an optional time window.

/api/v2/stats/

3 parameters
ParamTypeRequiredDescription
planIdstringoptionalThe Webshare plan ID to target. When omitted, Webshare uses the default plan.
timestamp__ltestringoptionalReturn stats with timestamps less than this value.
timestamp__gtestringoptionalReturn stats with timestamps greater than this value.