SDK API reference

This reference is generated from the public surface of each official SDK. Configure a client, choose a resource, and compare the same method across every supported language.

Generated SDK documentation

One API, three official SDKs

Choose a resource from the SDK Reference menu. Each method compares signatures, parameters, return values and exceptions across all supported languages.

JavaScript / TypeScript

@proxyrequest/sdk · v4.1.0

npm install @proxyrequest/sdk

Python

proxyrequest-sdk · v4.1.0

python -m pip install proxyrequest-sdk

PHP

proxyrequest/php-sdk · v4.1.0

composer require proxyrequest/php-sdk

JavaScript / TypeScriptPythonPHP

Configure the client

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

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

Configure the client

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"
)

Configure the client

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

use ProxyRequest\Client;
use ProxyRequest\Dto;

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

Reference

Browse by resource

ClientConfiguration and resource accessorsAPI Keys3 methodsAffiliates3 methodsAnalytics6 methodsAuthorization6 methodsCoupons8 methodsInvoices6 methodsLocations10 methodsNews1 methodsOrders5 methodsPackages2 methodsProfile8 methodsProviders1 methodsProxies1 methodsRewards2 methodsSettings1 methodsTelegram dashboard4 methodsUsers10 methodsWebhooks4 methodsModelsDTOs, enums and generated typesErrors and helpersExceptions and utility classes