Get account settings

GET

/settings

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/settings");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/settings"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.proxyrequest.com/api/v1/settings"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.proxyrequest.com/api/v1/settings"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/settings")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.proxyrequest.com/api/v1/settings',
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.proxyrequest.com/api/v1/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/settings")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/settings";

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url https://api.proxyrequest.com/api/v1/settings \
  --header 'Authorization: Bearer <token>'

Returns proxy gateway addresses, account usage totals, referral thresholds, and supported crypto currencies for the authenticated account.

Authorizations

BearerAuth
StaticAuth

Responses

200

The operation completed successfully.

application/json

object

gateways

required

Array<object>

object

required

string format: uuid

name

required

string

region

required

string

hostname

required

string

hostnames

required

Array<string>

port_http

required

integer

port_socks5

required

integer

port_auto

required

integer

port_haproxy

required

integer

spent_total

required

number format: double

orders_total

required

integer

orders_active

required

integer

data_available

required

integer

data_spent

required

integer

referrals

required

object

reward_balance_percentage

required

number format: double

reward_data_percentage

required

number format: double

reward_min_balance

required

number format: double

reward_min_data

required

number format: double

crypto

required

object

currencies

required

Array<string>

Examples

AccountSettings

Account settings

{
  "gateways": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440020",
      "name": "US East",
      "region": "us-east",
      "hostname": "proxy.thepremiumports.com",
      "hostnames": [
        "us-east-1.proxy.thepremiumports.com",
        "us-east-2.proxy.thepremiumports.com"
      ],
      "port_http": 8000,
      "port_socks5": 1080,
      "port_auto": 9000,
      "port_haproxy": 9000
    }
  ],
  "spent_total": 125.5,
  "orders_total": 4,
  "orders_active": 2,
  "data_available": 10737418240,
  "data_spent": 2147483648,
  "referrals": {
    "reward_balance_percentage": 10,
    "reward_data_percentage": 5,
    "reward_min_balance": 25,
    "reward_min_data": 1073741824
  },
  "crypto": {
    "currencies": [
      "BTC",
      "USDT"
    ]
  }
}

400

The request is malformed or violates a business rule.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

example

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ],
  "translation": "errors.request.invalid"
}

401

Authentication credentials are missing, expired, or invalid.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

{
  "detail": "Authentication credentials were not provided."
}

403

The authenticated account cannot perform this operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

{
  "detail": "You do not have permission to perform this action."
}

500

The service could not complete the operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

InternalServiceError

Internal service error

{
  "non_field_errors": [
    "Internal server error."
  ]
}