list()
List available proxy packages
Returns public packages and private packages already assigned to the authenticated account, including pricing and targeting capabilities.
Signature
client.packages.list(options: PackagesListOptions = {}): Promise<PackagesListResponse>Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
alias | string | Optional | — |
limit | number | Optional | Number of results to return per page. |
offset | number | Optional | The initial index from which to return the results. |
ordering | string | Optional | Which field to use when ordering the results. |
pricingUnit | string | Optional | Unit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy |
search | string | Optional | Case-insensitive partial search across Package fields: `name` and `alias`. Separate multiple terms with spaces or commas; every term must match at least one listed field. |
type | string | Optional | * `static` - Static * `residential` - Residential |
acceptLanguage | string | Optional | Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. |
Example
const result = await client.packages.list();Returns
PaginatedPackageListThe operation completed successfully.
typePaginatedPackageList4fields
countnumbernextstringpreviousstringresultsPackage[]typePackage19fields
idstringnamestringaliasstringtypeProxyTypeEnumenumProxyTypeEnum0fields
* `static` - Static * `residential` - Residential
No fields.
ordernumberis_continent_targetingbooleanis_country_targetingbooleanis_region_targetingbooleanis_city_targetingbooleanis_asn_targetingbooleanfeaturesstring[]descriptionstringpricingPricingEnumenumPricingEnum0fields
* `fixed` - Fixed * `range` - Range
No fields.
pricing_unitPricingUnitEnumenumPricingUnitEnum0fields
* `data` - Data * `proxy` - Proxy
No fields.
billing_cyclenumberbilling_modelRecord<string, unknown>commission_ratestringcommission_typeCommissionTypeEnumenumCommissionTypeEnum0fields
* `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed
No fields.
targeting_optionsTargetingOptionstypeTargetingOptions25fields
packagestringsplit_charstringvalue_charstringcontinentstringcountrystringregionstringcitystringasnstringispstringusernamestringpoolstringlocationstringlocation_formatstringsessionstringsession_mode_tagstringsession_ttlstringsession_ttl_formatnumberosstringos_combinedbooleanos_split_charstringos_linuxstringos_windowsstringos_iosstringos_macosstringos_androidstringThrows
ApiErrorNormalized API, transport, and response processing failure.
kind: "validation"The request arguments or business rules are invalid.kind: "authentication"Authentication credentials are missing, expired, or invalid.kind: "permission"The authenticated account cannot perform this operation.kind: "network"The request could not reach ProxyRequest.kind: "unexpected"The response could not be decoded or did not match the SDK contract.
Advanced variants
client.packages.listWithResponse(options): Promise<ApiResponse<PackagesListResponse>>Returns response status, headers, ETag and idempotency metadata with the decoded data.
Signature
client.packages.list(*, alias: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, pricing_unit: PackagesListPricingUnit | Unset=UNSET, search: str | Unset=UNSET, type_: PackagesListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedPackageListawait async_client.packages.list(*, alias: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, pricing_unit: PackagesListPricingUnit | Unset=UNSET, search: str | Unset=UNSET, type_: PackagesListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedPackageListParameters
| Name | Type | Requirement | Description |
|---|---|---|---|
alias | str | Optional | — |
limit | int | Optional | Number of results to return per page. |
offset | int | Optional | The initial index from which to return the results. |
ordering | str | Optional | Which field to use when ordering the results. |
pricing_unit | str | Optional | Unit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy |
search | str | Optional | Case-insensitive partial search across Package fields: `name` and `alias`. Separate multiple terms with spaces or commas; every term must match at least one listed field. |
type | str | Optional | * `static` - Static * `residential` - Residential |
accept_language | str | Optional | Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. |
Example
result = client.packages.list()Async example
result = await async_client.packages.list()Returns
PaginatedPackageListThe operation completed successfully.
classPaginatedPackageList4fields
countintresultslist[Package]classPackage19fields
namestraliasstrfeatureslist[Any]billing_cycleintbilling_modelPackageBillingModelmapPackageBillingModel1field
[key: str]Anytargeting_optionsTargetingOptionsclassTargetingOptions25fields
packagestrsplit_charstrvalue_charstrcontinentstrcountrystrregionstrcitystrasnstrispstrusernamestrpoolstrlocationstrlocation_formatstrsessionstrsession_mode_tagstrsession_ttlstrsession_ttl_formatintosstros_combinedboolos_split_charstros_linuxstros_windowsstros_iosstros_macosstros_androidstridstrtype_ProxyTypeEnumenumProxyTypeEnum0fields
No fields.
orderintis_continent_targetingboolis_country_targetingboolis_region_targetingboolis_city_targetingboolis_asn_targetingbooldescriptionstrpricingPricingEnumenumPricingEnum0fields
No fields.
pricing_unitPricingUnitEnumenumPricingUnitEnum0fields
No fields.
commission_ratestrcommission_typeCommissionTypeEnumenumCommissionTypeEnum0fields
No fields.
next_None | strpreviousNone | strThrows
ApiErrorNormalized API, transport, and response processing failure.
ErrorKind.VALIDATIONThe request arguments or business rules are invalid.ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.ErrorKind.NETWORKThe request could not reach ProxyRequest.ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.
Advanced variants
client.packages.list_with_response(*, alias: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, pricing_unit: PackagesListPricingUnit | Unset=UNSET, search: str | Unset=UNSET, type_: PackagesListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedPackageList]Returns response status, headers, ETag and idempotency metadata with the decoded data.
Signature
$client->packages()->list($alias = null, $limit = null, $offset = null, $ordering = null, $pricingUnit = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
alias | string | Optional | — |
limit | int | Optional | Number of results to return per page. |
offset | int | Optional | The initial index from which to return the results. |
ordering | string | Optional | Which field to use when ordering the results. |
pricingUnit | string | Optional | Unit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy |
search | string | Optional | Case-insensitive partial search across Package fields: `name` and `alias`. Separate multiple terms with spaces or commas; every term must match at least one listed field. |
type | string | Optional | * `static` - Static * `residential` - Residential |
acceptLanguage | string | Optional | Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English. |
Example
$result = $client->packages()->list();Returns
PaginatedPackageListThe operation completed successfully.
classPaginatedPackageList4fields
countintnextstringpreviousstringresults[Package[]](Package.md)classPackage19fields
idstringnamestringaliasstringtypeProxyTypeEnumenumProxyTypeEnum0fields
* `static` - Static * `residential` - Residential
No fields.
orderintisContinentTargetingboolisCountryTargetingboolisRegionTargetingboolisCityTargetingboolisAsnTargetingboolfeaturesarray<mixed>descriptionstringpricingPricingEnumenumPricingEnum0fields
* `fixed` - Fixed * `range` - Range
No fields.
pricingUnitPricingUnitEnumenumPricingUnitEnum0fields
* `data` - Data * `proxy` - Proxy
No fields.
billingCycleintbillingModelarray<string,mixed>commissionRatefloatcommissionTypeCommissionTypeEnumenumCommissionTypeEnum0fields
* `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed
No fields.
targetingOptionsTargetingOptionsclassTargetingOptions25fields
packagestringsplitCharstringvalueCharstringcontinentstringcountrystringregionstringcitystringasnstringispstringusernamestringpoolstringlocationstringlocationFormatstringsessionstringsessionModeTagstringsessionTtlstringsessionTtlFormatintosstringosCombinedboolosSplitCharstringosLinuxstringosWindowsstringosIosstringosMacosstringosAndroidstringThrows
ApiExceptionNormalized API, transport, and response processing failure.
ErrorKind::ValidationThe request arguments or business rules are invalid.ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.ErrorKind::PermissionThe authenticated account cannot perform this operation.ErrorKind::NetworkThe request could not reach ProxyRequest.ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.
InvalidArgumentExceptionA required argument is missing or violates a local SDK constraint.
local validationThe request was rejected before it was sent.
Advanced variants
$client->packages()->listWithResponse($alias = null, $limit = null, $offset = null, $ordering = null, $pricingUnit = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponseReturns an ApiResponse with decoded data and HTTP metadata.
$client->packages()->listWithHttpInfo($alias = null, $limit = null, $offset = null, $ordering = null, $pricingUnit = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])Returns the OpenAPI Generator response tuple.
$client->packages()->listAsync($alias = null, $limit = null, $offset = null, $ordering = null, $pricingUnit = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])Returns a Guzzle promise for the decoded result.
$client->packages()->listAsyncWithHttpInfo($alias = null, $limit = null, $offset = null, $ordering = null, $pricingUnit = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])Returns a Guzzle promise for the response tuple.
$client->packages()->listRequest($alias = null, $limit = null, $offset = null, $ordering = null, $pricingUnit = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])Builds the PSR-7 request without sending it.