body img:not(#navbar *) {
    border-radius: 16px;
  }

window.dataLayer = window.dataLayer || [];
function gtag() {
  dataLayer.push(arguments);
}
gtag('js', new Date());

gtag('config', 'G-SF51CFVSB6');

Search Subdivision entries using various filters.
This endpoint allows users to query subdivisions based on specific attributes.


Search Subdivision

APIPrivateKey & APIPublicKey

Ping Proxies Documentation

Your comprehensive guide to Ping Proxies services, tools, and resources

Introduction

How to create and verify your Ping Proxies account

Account Registration

Discover and purchase proxy services from the Ping Proxies dashboard

Products & Purchasing

Welcome to the Ping Proxies API documentation

API Introduction

Authentication

Understanding the Ping Proxies API structure, URL patterns, HTTP methods, and data formats

Structure

Understanding and handling errors in the Ping Proxies API

Error Handling

Understanding and working with API rate limits

Rate Limiting

Working with paginated responses in the Ping Proxies API

Pagination

Controlling result order with the sort_by parameter in the Ping Proxies API

Sorting

Advanced filtering with operators in the Ping Proxies API

Filter Operators

Using and working with metadata in the Ping Proxies API

Metadata

Understanding the Customer object and its role in the Ping Proxies API

Customer

Understanding the Proxy User object and its role in the Ping Proxies API

Proxy User

Understanding the Service object and its role in the Ping Proxies API

Service

Understanding the Service Adjustment object and its role in the Ping Proxies API

Service Adjustment

Understanding the Proxy object and its role in the Ping Proxies API

Proxy

Understanding the Residential Ledger object and its role in the Ping Proxies API

Residential Ledger

Understanding the Log Summary object and its role in the Ping Proxies API

Log Summary

Understanding the Log object and its role in the Ping Proxies API

Understanding the Product object and its role in the Ping Proxies API

Product

Understanding the ASN object and its role in the Ping Proxies API

Understanding the Continent object and its role in the Ping Proxies API

Continent

Understanding the Country object and its role in the Ping Proxies API

Country

Understanding the Subdivision object and its role in the Ping Proxies API

Subdivision

Understanding the City object and its role in the Ping Proxies API

City

This guide explains the different proxy types available through Ping Proxies, helping you choose the right option for your needs.

Proxy Types Overview

Understanding and managing residential bandwidth allocation in the Ping Proxies API

Residential Bandwidth

Understanding the analytics, logging, and tracking systems in the Ping Proxies API

Analytics and Usage Tracking

Understanding billing cycles and the credit system in the Ping Proxies API

Billing Cycles & Credit System

Understanding how proxy objects relate to geographic and network entities in the Ping Proxies API

Common Object Relationships

Understanding and choosing between different proxy authentication methods

Proxy Authentication Types

Understanding the service adjustment audit trail in the Ping Proxies API

Service Adjustments Explained

Collection of practical examples for the Ping Proxies API

Scenarios

Retrieves the profile of the currently authenticated customer, along with their credit balance.


Retrieve Current Customer

Retrieves a specific Proxy based on the provided ID for the current user's account, ensuring
that only proxies associated with the customer services and in use are returned.


Retrieve Proxy

Search Proxies on the customer account using various filters.


Search Proxies

This endpoint is for editing an existing proxy in the system using the provided `proxy_id`. It allows updating Proxy Specific Authentication username or password.


Proxy Edit

This endpoint retrieves a list of proxies assigned to the current user (or a specified
customer) based on the proxy IDs.

This endpoint is intentionally a POST even though it only retrieves data since it needs to larger lists of UUIDs.


Generate Proxy List By ID

This endpoint retrieves a list of available proxies for a user based on provided search parameters.
The search parameters allow the user to filter the proxies based on protocol, version, format, and associated service ID.
The function returns proxies in various formats suitable for different purposes.


Generate Proxy List By Search

This endpoint allows you to create a new proxy user.

The `proxy_user_id` and `proxy_user_password` can be provided or, if omitted, will be randomly generated.

Additional considerations when creating a Proxy User:
- `proxy_user_is_strict_security`: If true, the Proxy User requires an IP address authentication list.
- `restricted_service_ids`: A list of service IDs that the user is restricted to, if service restriction is enabled.
- `ip_address_authentications` must be a list of valid IP addresses. Each IP address can only be used by one Proxy User.
- `proxy_user_residential_bytes_limit`: An integer limiting residential traffic (must not be negative).


Create Proxy User

Retrieves a specific Proxy User based on the provided ID for the current user's account.


Retrieve Proxy User

Search Proxy Users on the customer account using various filters.


Search Proxy Users

This endpoint allows a user to edit an existing Proxy User entry by providing the necessary `proxy_user_id`.


Edit Proxy User

Allows a user to delete an existing proxy user associated with their account.
Proxy users that are set as account default can not be deleted,
and already deleted proxy users can not be deleted again.


Delete Proxy User Record

This endpoint creates a list of residential proxies based on filter parameters.
The search parameters allow the user to filter the proxies by location, session type, and format (e.g., http, socks5, socks5h).


Generated Residential List

This endpoint provides a detailed summary of a residential service.
It returns information such as service details, usage statistics, and associated proxy users.


Retrieve Residential Service Summary

Retrieves a specific Residential Ledger based on the provided ID for the current user's account.


Retrieve Residential Ledger

Search for entries in the Residential Ledger using various filters.


Search Residential Ledger

Retrieves a specific Service based on the provided ID for the current user's account.
If the 'show_proxies' parameter is set to 'True', it will also fetch proxies associated
with each service and add them to the result.


Retrieve Service

Search Services on the customer account using various filters.


Search Services

Allows a user to edit the details of an existing service.
This can include changes in payment method, adjusting automatic collection,
and marking for cancellation at the end of a period.


Edit Service

Allows the authenticated user to cancel a specific service associated with their account.
The user provides a service_id and optionally a cancel feedback and comment.


Cancel Service

Retrieves a specific Service Adjustment based on the provided ID for the current user's account.
The returned adjustment provides details about any modifications or updates made to the user's service.


Retrieve Service Adjustment

Search Service Adjustments on the customer account using various filters.


Search Service Adjustments

This endpoint returns a simplified product list that is both visible
and enabled for API checkouts. It helps clients to quickly identify and
purchase available products without any search or pagination parameters.
Ideal for basic API-based purchasing.


Retrieve Simplified Product Checkout Catalog

This endpoint allows a user to generate a quote for a service via the API. You can either specify
a `product_code` directly or use the traditional combination of `product_type`, `country_id`, and
`product_protocol`.


Generate Checkout Quote

This endpoint creates a checkout for the authenticated user based on the provided data. It supports
different payment platforms, promotional codes, and can handle both one-time and recurring payments.
You can either specify a `product_code` directly or supply the traditional combination of
`product_type`, `country_id`, and `product_protocol`.

**Important considerations**
- If `product_code` is provided alongside `product_type`/`country_id`/`product_protocol`, their values must match the actual product attributes.
- If the invoice amount remaining is `0`, it means your available credit fully covered the cost and the service is considered immediately paid.
- If the invoice needs payment, you will be returned an `invoice_url` to complete checkout.


Create Checkout

This endpoint analyzes proxy usage for a given customer within a specified time range
and groups them by one of four discrete intervals: `minute`, `hour`, `day`, or `month`.

You can either

1. Provide a `preset` parameter, which automatically sets period and interval
   (e.g. `last_day`, `last_hour`, etc.)
2. OR, manually specify your own time range (`period_start`, `period_end`) plus `interval`

You can also filter by `hostname`, `network`, `proxy_user_id`, and `service_id`.
Service ID can only be filtered if period is within 7 days and interval is hour or less.
Hostname filters are disallowed if searching older than 90 days.


Customer

Proxy

Proxy User

Residential

Residential Ledger

Service

Service Adjustment

Checkout

Analytics

Product

ASN

Continent

Country

Subdivision

City

Search Subdivision

Authorizations

Query Parameters

Response