Retrieve Token

Retrieves a single residential token's information, optionally with usage statistics. Residential tokens always authenticate with generated username/password credentials.

POST/resi/token

Authentication

Basic username/password authentication

Request Body

Field	Type	Required	Description
token	string	Required	The token to retrieve information for
usage	boolean	Optional	Whether to include usage statistics in the response. Defaults to false if not specified. If "usage" is set to false, the response will not include the "usage" array. Default: false

token

Required

Type:string

Description:

The token to retrieve information for

usage

Optional

Type:boolean

Description:

Whether to include usage statistics in the response. Defaults to false if not specified. If "usage" is set to false, the response will not include the "usage" array.

Default:false

Code Example

NodeJS

const axios = require('axios');

const url = "https://api.unknownproxies.com/api/v1/resi/token";
const headers = {
  "Authorization": "Basic dXNlcjpwYXNz",
  "Content-Type": "application/json"
};
const data = {
  "token": "your-token-here",
  "usage": "your-usage-here"
};

try {
  const response = await axios.post(url, {
    headers,
    data
  });
  console.log(response.data);
} catch (error) {
  console.error('Error:', error.response?.data || error.message);
}

Python

import requests
import json

url = "https://api.unknownproxies.com/api/v1/resi/token"
headers = {
    "Authorization": "Basic dXNlcjpwYXNz",
    "Content-Type": "application/json"
}
data = {
  "token": "your-token-here",
  "usage": "your-usage-here"
}

response = requests.post(
    url,
    headers=headers,
    json=data
)

print(response.json())

PHP

<?php
$url = "https://api.unknownproxies.com/api/v1/resi/token";
$headers = [
    "Authorization: Basic dXNlcjpwYXNz",
    "Content-Type: application/json"
];
$data = {
  "token": "your-token-here",
  "usage": "your-usage-here"
};

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.google.gson.Gson;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        
        String url = "https://api.unknownproxies.com/api/v1/resi/token";
        String auth = "Basic dXNlcjpwYXNz";
        
        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", auth)
            .header("Content-Type", "application/json");
        
        // Add request body if needed
        String jsonBody = {
  "token": "your-token-here",
  "usage": "your-usage-here"
};
        
        HttpRequest request = requestBuilder
            .post(HttpRequest.BodyPublishers.ofString(jsonBody))
            .build();
        
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.Net.Http.Headers;
using Newtonsoft.Json;

public class Program
{
    public static async Task Main()
    {
        using var client = new HttpClient();
        
        var url = "https://api.unknownproxies.com/api/v1/resi/token";
        
        // Set basic auth
        var authToken = Convert.ToBase64String(Encoding.UTF8.GetBytes("user:pass"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", authToken);
        
        
        var data = new {
            // Define your request object here
        };
        var json = JsonConvert.SerializeObject(data);
        var content = new StringContent(json, Encoding.UTF8, "application/json");
        
        var response = await client.postAsync(url, content);
        var result = await response.Content.ReadAsStringAsync();
        
        Console.WriteLine(result);
    }
}

cURL

curl -X POST "https://api.unknownproxies.com/api/v1/resi/token" \
  -H "Authorization: Basic dXNlcjpwYXNz" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "your-token-here",
  "usage": "your-usage-here"
}'

Javascript

const response = await fetch("https://api.unknownproxies.com/api/v1/resi/token", {
  method: "POST",
  headers: {
    "Authorization": "Basic dXNlcjpwYXNz",
    "Content-Type": "application/json"
  },
  body: {
    "token": "your-token-here",
    "usage": "your-usage-here"
  }
});

const data = await response.json();
console.log(data);

Go

package main

import (
    "bytes"
    "encoding/base64"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://api.unknownproxies.com/api/v1/resi/token"
    reqBody := `
{
  "token": "your-token-here",
  "usage": "your-usage-here"
}
`

    var body io.Reader
    if reqBody != "" {
        var buf bytes.Buffer
        if err := json.Compact(&buf, []byte(reqBody)); err == nil {
            body = bytes.NewBuffer(buf.Bytes())
        } else {
            body = bytes.NewBuffer([]byte(reqBody))
        }
    }

    req, _ := http.NewRequest("POST", url, body)
    token := base64.StdEncoding.EncodeToString([]byte("user:pass"))
    req.Header.Set("Authorization", "Basic "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Response Example

{
  "token": "zu8sBXS4gkh7",
  "username": "kGyohRda",
  "authType": "user",
  "password": "bkXBberMQ7",
  "durationHours": 750,
  "status": "active",
  "createdAt": 1752251968,
  "updatedAt": 1754843968,
  "dataUsage": 11574848653,
  "dataLimit": 100000000000,
  "usage": [
    {
      "date": "2025-10-31",
      "usage": 10000000
    },
    {
      "date": "2025-10-30",
      "usage": 222000
    },
    {
      "date": "2025-10-29",
      "usage": 333000
    }
  ],
  "allowedPools": ["us-s", "us-r", "tickets-us-s", "tickets-us-r", "ca-s", "ca-r", "gb-s", "gb-r"]
}

Usage Statistics

When you set the usage parameter to true, the response will include a usage array containing daily data usage statistics. This is helpful for tracking bandwidth consumption over time.

Token Case Sensitivity

Token identifiers are case-sensitive. For example, ABC123def456 is different from abc123DEF456. Make sure to use the exact case when specifying a token in API requests.

Related Operations

After retrieving a token, you can:

• Modify Residential Token - Update password rotations, allowed pools, or token limits
• Delete Residential Token - Permanently deactivate the token
• List All Residential Tokens - View all tokens filtered by status

To understand the complete token data structure, see the Residential Token Schema documentation.