{
  "info": {
    "name": "AeonProxy API v1",
    "description": "The AeonProxy API is a JSON REST API at `https://aeonproxy.com/api/v1`. It works with the same account, traffic and logins as the dashboard: a proxy list you generate here works on the gateway at once, a sub-user you create shows up in the dashboard, and traffic you buy is in the same balance.\n\nSet the apiKey variable to the key from Settings → API. Reference: https://aeonproxy.com/docs/api",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://aeonproxy.com/api/v1"
    },
    {
      "key": "apiKey",
      "value": ""
    }
  ],
  "item": [
    {
      "name": "Account",
      "description": "Balance, traffic left on each product, the main proxy login and its password.",
      "item": [
        {
          "name": "Check the API",
          "request": {
            "method": "GET",
            "header": [],
            "description": "Answers without a key. Use it in health checks and to see the API version.\n\nhttps://aeonproxy.com/docs/api/account#get-status",
            "auth": {
              "type": "noauth"
            },
            "url": {
              "raw": "{{baseUrl}}/status",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "status"
              ]
            }
          }
        },
        {
          "name": "Get the account",
          "request": {
            "method": "GET",
            "header": [],
            "description": "The balance, the traffic you have bought and used per product, the number of sub-users and active orders. Traffic counts in GB (1 GB = 10⁹ bytes), money in US dollars.\n\nhttps://aeonproxy.com/docs/api/account#get-account",
            "url": {
              "raw": "{{baseUrl}}/me",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "me"
              ]
            }
          }
        },
        {
          "name": "Get proxy credentials",
          "request": {
            "method": "GET",
            "header": [],
            "description": "The main proxy login of one product, the gateway host and ports, and the traffic left. Append [targeting keys](https://aeonproxy.com/docs#targeting) to `username` (`-cc-us`, `-sid-…`), or let [Generate a proxy list](https://aeonproxy.com/docs/api/proxy-list#generate-proxy-list) build the lines.\n\nhttps://aeonproxy.com/docs/api/account#get-credentials",
            "url": {
              "raw": "{{baseUrl}}/credentials?product=residential",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "credentials"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                }
              ]
            }
          }
        },
        {
          "name": "Rotate the proxy password",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Gives the main login of one product a new password. The old one stops working at once, in every proxy line that uses it; sub-users keep theirs.\n\nhttps://aeonproxy.com/docs/api/account#rotate-password",
            "url": {
              "raw": "{{baseUrl}}/credentials/password",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "credentials",
                "password"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"product\": \"residential\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Locations",
      "description": "Every country, region, city, ISP and carrier you can target, with the value to put in the proxy login.",
      "item": [
        {
          "name": "List countries",
          "request": {
            "method": "GET",
            "header": [],
            "description": "Countries with exits on the product right now. `code` is what `country` and the `-cc-` key take.\n\nhttps://aeonproxy.com/docs/api/locations#list-countries",
            "url": {
              "raw": "{{baseUrl}}/locations/countries?product=residential",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "locations",
                "countries"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                }
              ]
            }
          }
        },
        {
          "name": "List regions",
          "request": {
            "method": "GET",
            "header": [],
            "description": "States, provinces or nations of one country. The slug goes into the `-st-` key: `ap_…-cc-us-st-newyork`.\n\nhttps://aeonproxy.com/docs/api/locations#list-regions",
            "url": {
              "raw": "{{baseUrl}}/locations/regions?product=residential&country=us",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "locations",
                "regions"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "country",
                  "value": "us"
                }
              ]
            }
          }
        },
        {
          "name": "List cities",
          "request": {
            "method": "GET",
            "header": [],
            "description": "Cities of one country, filtered by `search` and paged with `limit` and `offset` (the United States alone has thousands). `count` is the number of matches before paging. The slug goes into the `-city-` key.\n\nhttps://aeonproxy.com/docs/api/locations#list-cities",
            "url": {
              "raw": "{{baseUrl}}/locations/cities?product=residential&country=us&search=san&limit=3",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "locations",
                "cities"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "country",
                  "value": "us"
                },
                {
                  "key": "search",
                  "value": "san"
                },
                {
                  "key": "limit",
                  "value": "3"
                }
              ]
            }
          }
        },
        {
          "name": "List ISPs and carriers",
          "request": {
            "method": "GET",
            "header": [],
            "description": "Home ISPs (residential) or mobile carriers (mobile) of one country. Residential logins take the slug in `-isp-`, mobile ones in `-car-`. An empty list means the country has no network targeting yet.\n\nhttps://aeonproxy.com/docs/api/locations#list-isps",
            "url": {
              "raw": "{{baseUrl}}/locations/isps?product=residential&country=us",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "locations",
                "isps"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "country",
                  "value": "us"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Proxy lists",
      "description": "Ready proxy lines for your scraper, antidetect browser or bot: up to 500 per call, in the format your tool reads.",
      "item": [
        {
          "name": "Generate a proxy list",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Returns `count` lines as JSON, each split into host, port, username and password and joined in your `format`. Send `\"output\": \"text\"` to get plain text, one line per row.\n\nhttps://aeonproxy.com/docs/api/proxy-list#generate-proxy-list",
            "url": {
              "raw": "{{baseUrl}}/proxy-list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "proxy-list"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"product\": \"residential\",\n  \"country\": \"us\",\n  \"region\": \"new york\",\n  \"session\": \"sticky\",\n  \"ttl\": 30,\n  \"count\": 3\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Download a proxy list",
          "request": {
            "method": "GET",
            "header": [],
            "description": "The same generator with the parameters in the query string, for tools that only fetch a URL and for `curl … > proxies.txt`. With `output=text` the answer is plain text. URL-encode `format`: `user%3Apass%40host%3Aport`.\n\nhttps://aeonproxy.com/docs/api/proxy-list#download-proxy-list",
            "url": {
              "raw": "{{baseUrl}}/proxy-list?product=residential&country=us&region=newyork&ttl=30&count=3&format=user:pass@host:port&output=text",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "proxy-list"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "country",
                  "value": "us"
                },
                {
                  "key": "region",
                  "value": "newyork"
                },
                {
                  "key": "ttl",
                  "value": "30"
                },
                {
                  "key": "count",
                  "value": "3"
                },
                {
                  "key": "format",
                  "value": "user:pass@host:port"
                },
                {
                  "key": "output",
                  "value": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Sub-users",
      "description": "Separate logins for team members, projects and applications, each with its own traffic limit.",
      "item": [
        {
          "name": "List sub-users",
          "request": {
            "method": "GET",
            "header": [],
            "description": "All sub-users, or those of one product.\n\nhttps://aeonproxy.com/docs/api/sub-users#list-sub-users",
            "url": {
              "raw": "{{baseUrl}}/sub-users?product=residential",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "sub-users"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                }
              ]
            }
          }
        },
        {
          "name": "Create a sub-user",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}"
              }
            ],
            "description": "Creates a login with a random password. The name is stored in lower case, with anything other than letters, digits and dashes turned into dashes. Send an `Idempotency-Key` header to retry safely.\n\nhttps://aeonproxy.com/docs/api/sub-users#create-sub-user",
            "url": {
              "raw": "{{baseUrl}}/sub-users",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "sub-users"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"product\": \"residential\",\n  \"name\": \"scraper-eu\",\n  \"limit_gb\": 5\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get a sub-user",
          "request": {
            "method": "GET",
            "header": [],
            "description": "One sub-user with its login, password, limit and the traffic it has used.\n\nhttps://aeonproxy.com/docs/api/sub-users#get-sub-user",
            "url": {
              "raw": "{{baseUrl}}/sub-users/311",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "sub-users",
                "311"
              ]
            }
          }
        },
        {
          "name": "Update a sub-user",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "description": "Renames a sub-user or changes its limit; send only the fields to change. The login and password stay the same. Lowering the limit below what it has used stops it at once.\n\nhttps://aeonproxy.com/docs/api/sub-users#update-sub-user",
            "url": {
              "raw": "{{baseUrl}}/sub-users/311",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "sub-users",
                "311"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"limit_gb\": 10\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a sub-user",
          "request": {
            "method": "DELETE",
            "header": [],
            "description": "Deletes the login: its proxy lines stop working at once. The traffic it used stays used; nothing is refunded to the account.\n\nhttps://aeonproxy.com/docs/api/sub-users#delete-sub-user",
            "url": {
              "raw": "{{baseUrl}}/sub-users/311",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "sub-users",
                "311"
              ]
            }
          }
        },
        {
          "name": "Rotate a sub-user password",
          "request": {
            "method": "POST",
            "header": [],
            "description": "Gives the sub-user a new password; the old one stops working at once.\n\nhttps://aeonproxy.com/docs/api/sub-users#rotate-sub-user-password",
            "url": {
              "raw": "{{baseUrl}}/sub-users/311/password",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "sub-users",
                "311",
                "password"
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Usage",
      "description": "Traffic, requests and success rate by hour or by day, for the last 30 days.",
      "item": [
        {
          "name": "Get usage",
          "request": {
            "method": "GET",
            "header": [],
            "description": "A series of points, one per hour (`24h`) or per day (`7d`, `30d`), with totals. Points without traffic are included with zeros, so the series has no gaps. `success_rate` is a percentage, or `null` without requests.\n\nhttps://aeonproxy.com/docs/api/usage#get-usage",
            "url": {
              "raw": "{{baseUrl}}/usage?product=residential&period=7d",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "usage"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "period",
                  "value": "7d"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Orders",
      "description": "Price quotes with your discounts, traffic purchases from the balance, and your order history.",
      "item": [
        {
          "name": "List orders",
          "request": {
            "method": "GET",
            "header": [],
            "description": "Orders newest first. `type` is `traffic` (bought), `trial`, `bonus` (the first top-up bonus) or `ips` (ISP and datacenter IPs). Traffic orders show `gb_left`; the total of an account's active orders is in [Get the account](https://aeonproxy.com/docs/api/account#get-account).\n\nhttps://aeonproxy.com/docs/api/orders#list-orders",
            "url": {
              "raw": "{{baseUrl}}/orders?product=residential&status=active",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "orders"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "status",
                  "value": "active"
                }
              ]
            }
          }
        },
        {
          "name": "Get an order",
          "request": {
            "method": "GET",
            "header": [],
            "description": "One order. ISP and datacenter orders also list their IPs with ports.\n\nhttps://aeonproxy.com/docs/api/orders#get-order",
            "url": {
              "raw": "{{baseUrl}}/orders/5120",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "orders",
                "5120"
              ]
            }
          }
        },
        {
          "name": "Get a price",
          "request": {
            "method": "GET",
            "header": [],
            "description": "What a purchase would cost right now: the tier rate, the discount that applies and whether the balance covers it. Nothing is charged.\n\nhttps://aeonproxy.com/docs/api/orders#get-price",
            "url": {
              "raw": "{{baseUrl}}/traffic/price?product=residential&gb=10",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "traffic",
                "price"
              ],
              "query": [
                {
                  "key": "product",
                  "value": "residential"
                },
                {
                  "key": "gb",
                  "value": "10"
                }
              ]
            }
          }
        },
        {
          "name": "Buy traffic",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}"
              }
            ],
            "description": "Charges the balance and adds the traffic to the product. Send an `Idempotency-Key` header (any unique string up to 64 characters): if the connection drops, send the same request with the same key and you get the first answer back instead of a second purchase. Up to 10 purchases per minute.\n\nhttps://aeonproxy.com/docs/api/orders#buy-traffic",
            "url": {
              "raw": "{{baseUrl}}/traffic/purchase",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "traffic",
                "purchase"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"product\": \"residential\",\n  \"gb\": 10\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    }
  ]
}