Client

SDK Reference

Client configuration

Install one SDK, create a client and access its resource objects.

JavaScript / TypeScriptPythonPHP

@proxyrequest/sdkv4.1.0 · Node.js 22 or later

npm install @proxyrequest/sdk

import { ProxyRequestClient } from "@proxyrequest/sdk";

const client = ProxyRequestClient.withApiKey("{api_key}", {
  baseUrl: "https://{api_host}/api/v1",
});

class

ProxyRequestClient

Authenticated or anonymous client exposing all API resources.

new ProxyRequestClient(options?: ClientOptions)ProxyRequestClient.withApiKey(apiKey, options?)ProxyRequestClient.withBearerToken(token, options?)ProxyRequestClient.anonymous(options?)client.request(method, path, options?): Promise<Response>client.downloadInvoicePdf(id, request?): Promise<FileDownload>

Resource accessors

• readonly apiKeys: APIKeysResource
• readonly affiliates: AffiliatesResource
• readonly analytics: AnalyticsResource
• readonly authorization: AuthorizationResource
• readonly coupons: CouponsResource
• readonly invoices: InvoicesResource
• readonly locations: LocationsResource
• readonly news: NewsResource
• readonly orders: OrdersResource
• readonly packages: PackagesResource
• readonly profile: ProfileResource
• readonly providers: ProvidersResource
• readonly proxies: ProxiesResource
• readonly rewards: RewardsResource
• readonly settings: SettingsResource
• readonly telegram: TelegramDashboardResource
• readonly users: UsersResource
• readonly webhooks: WebhooksResource

proxyrequest-sdkv4.1.0 · Python 3.11 or later

python -m pip install proxyrequest-sdk

from proxyrequest_sdk import Client
from proxyrequest_sdk import models

client = Client.with_api_key(
    "{api_key}", base_url="https://{api_host}/api/v1"
)

from proxyrequest_sdk import AsyncClient
from proxyrequest_sdk import models

async_client = AsyncClient.with_api_key(
    "{api_key}", base_url="https://{api_host}/api/v1"
)

class

Client

Synchronous client exposing all API resources.

Client.with_api_key(api_key, *, base_url=...)Client.with_bearer_token(token, *, base_url=...)Client.anonymous(*, base_url=...)client.request(method, path, ...) -> httpx.Responseclient.paginate(fetch_page, ...) -> Iterator[Item]client.download_invoice_pdf(invoice_id) -> FileDownloadclient.close() -> None

Resource accessors

• api_keys: APIKeysResource
• affiliates: AffiliatesResource
• analytics: AnalyticsResource
• authorization: AuthorizationResource
• coupons: CouponsResource
• invoices: InvoicesResource
• locations: LocationsResource
• news: NewsResource
• orders: OrdersResource
• packages: PackagesResource
• profile: ProfileResource
• providers: ProvidersResource
• proxies: ProxiesResource
• rewards: RewardsResource
• settings: SettingsResource
• telegram: TelegramDashboardResource
• users: UsersResource
• webhooks: WebhooksResource

class

AsyncClient

Asynchronous client with the same resource surface.

AsyncClient.with_api_key(api_key, *, base_url=...)AsyncClient.with_bearer_token(token, *, base_url=...)AsyncClient.anonymous(*, base_url=...)await async_client.request(method, path, ...) -> httpx.Responseasync_client.paginate(fetch_page, ...) -> AsyncIterator[Item]await async_client.download_invoice_pdf(invoice_id) -> FileDownloadawait async_client.close() -> None

Resource accessors

• api_keys: AsyncAPIKeysResource
• affiliates: AsyncAffiliatesResource
• analytics: AsyncAnalyticsResource
• authorization: AsyncAuthorizationResource
• coupons: AsyncCouponsResource
• invoices: AsyncInvoicesResource
• locations: AsyncLocationsResource
• news: AsyncNewsResource
• orders: AsyncOrdersResource
• packages: AsyncPackagesResource
• profile: AsyncProfileResource
• providers: AsyncProvidersResource
• proxies: AsyncProxiesResource
• rewards: AsyncRewardsResource
• settings: AsyncSettingsResource
• telegram: AsyncTelegramDashboardResource
• users: AsyncUsersResource
• webhooks: AsyncWebhooksResource

proxyrequest/php-sdkv4.1.0 · 64-bit PHP 8.5 or later

composer require proxyrequest/php-sdk

<?php
require __DIR__ . '/vendor/autoload.php';

use ProxyRequest\Client;
use ProxyRequest\Dto;

$client = Client::withApiKey(
    '{api_key}', 'https://{api_host}/api/v1'
);

class

Client

Configured client exposing all API resources.

Client::withApiKey($apiKey, $baseUri)Client::withBearerToken($token, $baseUri)Client::anonymous($baseUri)Client::builder()$client->paginate($pageFetcher, $limit, $offset): Paginator$client->downloadInvoicePdf($invoiceId): FileDownload$client->raw($method, $path, $query, $json, $headers): ResponseInterface

Resource accessors

• affiliates(): AffiliatesResource
• analytics(): AnalyticsResource
• apiKeys(): APIKeysResource
• coupons(): CouponsResource
• telegram(): TelegramDashboardResource
• invoices(): InvoicesResource
• locations(): LocationsResource
• authorization(): AuthorizationResource
• news(): NewsResource
• orders(): OrdersResource
• packages(): PackagesResource
• profile(): ProfileResource
• providers(): ProvidersResource
• proxies(): ProxiesResource
• rewards(): RewardsResource
• settings(): SettingsResource
• users(): UsersResource
• webhooks(): WebhooksResource