API Documentation

API Access

API Base URL:

https://www.ipcook.com/

Authentication

All requests require authentication using an API key passed in the HTTP headers.

Use the jwt-token obtained from the Login API.

Data Format

All request and response payloads are in JSON format.

Headers

Response

Account Information

Login

API

• Address: /api/account/login

• Method: POST

Success Response

{
    "code": 0,
    "msg": "success",
    "data": {
    "uid": 10086,
    "jwt-token": "ey06eXAi01JKV10i1C1hb6c101JIUzI1N19.ey9pG3M101JodHRw01BvYxBplnJIZ6hhdGlwLmWvb581LC1hdNQ101JodHRwczovL31JZ6hhdGlwLmWvb581LC1pYXQ10jE3MzK30TEx0DIsImV4CC16MTcz0TC50MMMiuXZGF8YS16eyJ1aMQ10jEMWBg2LC1hY2WvdW501joIZmFu23FqQ6tvb21ZXkuY29tIn19.3-bTMmzqjFg0t_sHzlftRwRxMrlv-zb96NFro0qxaHU",
    "expire_at": 1739798382  }
}

Request Parameters

Response Data

User Info

API

• Address: /api/user/info

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "uid": 123456,
    "account": "raymond083",
    "email": "[email protected]",
    "token": "aaabbbccc", // api_token    "balance": 92499, // Unit: US Cents    "traffic_left": 8080, // Unit: MB    "trial_status": 1, // Trial eligibility: 1: Eligible; 0: Not eligible    "commission_rate": 0.03 // Cryptocurrency fee rate  }
}

Response Data

Traffic Data API

Dashboard Traffic Usage

API

• Address: /api/traffic/usage

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "x": [
      "2025-04-21",
      "2025-04-22",
      "2025-04-23",
      "2025-04-24",
      "2025-04-25",
      "2025-04-26",
      "2025-04-27",
      "2025-04-28"    ],
    "y": [
      15.05, // Unit: Mb      0,
      95.78,
      14.42,
      0,
      0,
      0,
      0    ]
  }
}

Request Parameters

Response Data

Traffic Change Log

API

• Address: /api/traffic/changelog

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "type": "Allocation", // Value range: ['Used', 'Add', 'Allocation', 'Recycle']        "amount": 80000,
        "after": 142230,
        "remark": "FromUidHaiadqa5iaw",
        "date_time": "2025-07-24 04:01:09"      },
      {
        "type": "Allocation",
        "amount": 20000,
        "after": 62230,
        "remark": "FromUidHaiadqa5iaw",
        "date_time": "2025-07-24 04:01:09"      }
    ],
    "total": 56  }
}

Request Parameters

Response Data

Traffic Details

API

• Address: /api/traffic/details

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 1,
    "list": [
      {
        "time": "2025-04-21",
        "uid": 8561510800,
        "geo": "US",
        "region": "",
        "count": "15.05 MB",
        "username": "[email protected]"      }
    ]
  }
}

Request Parameters

Response Data

Traffic Package List

API

• Address: /api/order/pricemenu

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": [
    {
      "id": 101,
      "title": "1GB",
      "traffic_gb": 1,
      "per_gb_price": 320,
      "price": 320,
      "recommend_tips": "",
      "default_checked": 0,
      "is_top": 1 // Whether pinned: 1=Yes; 0=No    }
  ]
}

Response Data

Traffic Order List(Paginated)

API

• Address: /api/order/packages

• Method: GET

Request Parameters

Note: old likely intended to be order_id or oid.

Response Data

Dynamic IP API

Dynamic Gateway List

API

• Address: /api/dynamic/gateways

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "host": "geo.redhatip.com",
      "port": 32345    }
  ]
}

Response Data

Dynamic Geo List

API

• Address: /api/dynamic/stock

• Method: GET

Success Response

{
    "code": 0,
    "msg": "success",
    "data": {
    "uid": 10086,
    "jwt-token": "ey06eXAi01JKV10i1C1hb6c101JIUzI1N19.ey9pG3M101JodHRw01BvYxBplnJIZ6hhdGlwLmWvb581LC1hdNQ101JodHRwczovL31JZ6hhdGlwLmWvb581LC1pYXQ10jE3MzK30TEx0DIsImV4CC16MTcz0TC50MMMiuXZGF8YS16eyJ1aMQ10jEMWBg2LC1hY2WvdW501joIZmFu23FqQ6tvb21ZXkuY29tIn19.3-bTMmzqjFg0t_sHzlftRwRxMrlv-zb96NFro0qxaHU",
    "expire_at": 1739798382  }
}

Request Parameters

Response Data

Dynamic Geo-City List

API

• Address: /api/dynamic/citys

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 80804,
      "name": "Dallas",
      "enname": "Dallas"    },
    {
      "id": 80805,
      "name": "Houston",
      "enname": "Houston"    }
  ]
}

Request Parameters

Response Data

Dynamic Username/Password List

API

• Address: /api/auth/sub_list

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 123456,
      "username": "1",
      "password": "1",
      "traffic_left": 12120, // Remaining traffic Unit: MB, divide by 1000 for GB      "traffic_used": 0,     // Used traffic Unit: MB, divide by 1000 for GB      "remark": "",
      "add_time": 1741148830,
    },
    {
      "id": "a1adqa5iks",
      "username": "12345678891111126",
      "password": "12345678891111135",
      "traffic_left": 20,
      "traffic_used": 0,
      "remark": "111",
      "add_time": 1741160175,
    }
  ]
}

Response Data

Auth API

Add Auth

API

• Address: /api/auth/passadd

• Method: POST

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "aiadqa5i5d"  }
}

Request Parameters

Response Data

Delete Auth

API

• Address: /api/auth/passdelete

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Request Parameters

Update Auth

API

• Address: /api/auth/passupdate

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Request Parameters

Allocate Traffic to Auth

API

• Address: /api/auth/trafficupdate

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": []
}

Request Parameters

Fetch Dynamic IPs (Link/Auth)

API

• Address: /api/dynamic/genips

• Method: GET

Request Parameters

Update Auth Remark

API

• Address: /api/auth/remarkupdate

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Request Parameters

Whitelist API

Fetch Dynamic IPs

API

• Address: /api/dynamic/whiteipget

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": [
    "127.0.0.1:1111",
    "127.0.0.1:1122",
    "127.0.0.1:1133",
    "127.0.0.1:1144",
    "127.0.0.1:1155"  ]
}

Request Parameters

Response Data

Add Whitelist IP

API

• Address: /api/auth/whiteipadd

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": []
}

Request Parameters

Update Whitelist IP Remark

API

• Address: /api/auth/whiteipupdate

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Request Parameters

Whitelist IP List

API

• Address: /api/auth/whiteipget

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 13,
    "list": [
      {
        "ip": "127.0.0.1:1111",
        "remark": "hello",
        "add_time": 1740139633      },
      {
        "ip": "127.0.0.1:1122",
        "remark": "hello",
        "add_time": 1740139836      },
      {
        "ip": "127.0.0.1:1133",
        "remark": "hello",
        "add_time": 1740139886      },
      {
        "ip": "127.0.0.1:1144",
        "remark": "hello",
        "add_time": 1740139788      }
    ]
  }
}

Request Parameters

Response Data

Delete Whitelist IP

API

• Address: /api/auth/whiteipdelete

• Method: GET

Success Response

{
  "code": 0,
  "msg": "success",
  "data": []
}

Request Parameters

Bandwidth API

Bandwidth Order List

API

• Address: /api/order/bandwidth

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": {
    "total": 0,
    "list": [        // Order list
      {
        "id": 126918259,             // Order ID
        "pay_type": "balance", // Payment method
        "price": 35000,        // Order amount, in cents
        "add_time": 1692345600,// Order timestamp
        "bandwidth": 100,      // Effective bandwidth
        "day": 30,             // Days
        "status": 1            // Status: 0 Unpaid, 1 Paid, 3 Refunded
      }
    ]
  }
}

Request Parameters

Response Data

Get Bandwidth Product Renewal or Upgrade Quote

API

• Address: /api/order/checkBandwidthRenew

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": {
    "total_price": 74667,          // Total payable price (including fee), in cents
    "amount": 74667,               // Actual payment amount, in cents
    "exchange_rate": 1,            // Exchange rate
    "currency": "USD",             // Currency
    "commission_rate": "0%",       // Fee rate
    "commission_price": 0,         // Fee, in cents
    "order_id": "102401234567",    // Order cache ID; pass as o when paying
    "day": 32,                     // Total billed days (price-difference days rounded up + renewal days)
    "renew_day": 30,               // Renewal days (> 0 only when renewing; 0 when only upgrading)
    "cur_bandwidth": 100,          // Current (original) bandwidth, Mbps
    "bandwidth": 200,              // Effective bandwidth (after upgrade, or current), Mbps
    "slotting_allowance": 0,       // Channel fee, in cents
    "old_expire_time": 1787222928, // Original expiration time
    "expire_time": 1787222928,     // New expiration time
    "old_unit_price": 200,         // Original unit price
    "unit_price": 0,               // Unit price, in cents
    "remaining_days": 2,           // Price-difference days
    "raw_price": 74667,            // Original price (no discount), in cents
    "deduct": 0                    // Remaining value of the old cycle deducted when renewing across tiers (integer cents); 0 if not across tiers
  }
}

Request Parameters

Response Data

Get Bandwidth Product Purchase Quote

API

• Address: /api/order/checkBandwidth

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": {
    "total_price": 36050,         // Total payable price (fee included), in cents
    "amount": 36050,              // Actual payment amount (in the corresponding currency)
    "exchange_rate": 1,           // Exchange rate (not 1 for non-USD currencies)
    "currency": "USD",            // Currency (USD/RUB/EUR/CNY, etc.)
    "discount_rate": 0.03,        // Discount rate (0~1)
    "discount": 1050,             // Total discount amount, in cents (= period_discount + coupons_discount)
    "period_discount": 0,         // Duration discount amount, in cents (always 0 for bandwidth products)
    "coupons_discount": 1050,     // Coupon code discount amount, in cents
    "commission_rate": "3%",      // Payment fee rate (string)
    "commission_price": 1050,     // Fee amount, in cents
    "order_id": "102401234567",   // Order cache ID; pass as o to the payment API
    "day": 30,                    // Days
    "bandwidth": 100,             // Purchased bandwidth, Mbps
    "unit_price": 1167,           // Unit price, in cents
    "slotting_allowance": 0,      // Channel fee, in cents (> 0 for some payment methods)
    "raw_price": 35000            // Original price (excluding discount/fee), in cents
  }
}

Request Parameters

Response Data

Bandwidth Usage Chart

API

• Address: /api/bandwidth/bwusage

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": [
    {
      "time": "08-23 16",   // Date tick
      "bandwidth": 0,       // Bandwidth value
      "unit": "Gbps"        // Unit
    },
    {
      "time": "08-23 17",
      "bandwidth": 0,
      "unit": "Gbps"
    }
  ]
}

Request Parameters

Response Data

Bandwidth Usage Details

API

• Address: /api/bandwidth/bwlogs

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": {
    "total": 1,
    "list": [
      {
        "date": "",        // Date
        "uid": 0,          // User ID
        "username": 0,     // Username
        "bw": 0,           // Bandwidth
        "unit": "Mbps"     // Unit
      }
    ]
  }
}

Request Parameters

Response Data

User Bandwidth Info

API

• Address: /api/dynamic/bandwidthInfo

• Method: GET

Success Response

{
  "code": 0,
  "msg": "Success",
  "data": {
    "username": "12vdxer1C437wn",   // Account
    "password": "12vdxer1C437wn", // Password
    "port": 0,                     // Port
    "bandwidth": 100,              // Bandwidth specification
    "expire_time": 1789812030,     // Expiration time
    "domains": [                   // Gateway domain list

    ]

  }
}

Response Data

Update Bandwidth Account Password

API

• Address: /api/dynamic/changeBandwidthPwd

• Method: POST

Success Response

{
  "code": 0,
  "msg": "success",
  "data": []
}

Request Parameters

Response Data

Static API

Static Proxy Plans

API

• Address: /api/static/priceMenu

• Method: GET

Success Response

{
    "code": 0,
    "msg": "Success",
    "data": {
        "only_num": 0,
         "stock": {    //Regional Inventory     Region ID: Inventory Quantity
            "6": 506,
            "3": 243,
            "1": 1008,
            "9": 496,
            "15": 252,
            "2": 253,
            "8": 253,
            "4": 253,
            "5": 1
        },
        "proxy_packages": [   //Number of Plans
            {
                "name": "1 IPs",
                "amount": 1,
                "discount": 1.6,
                "discount_tips": "+60%",
                "status":1 
            }
        ],
        "day_packages": [  // Duration plans (>= 10)
            {
                "name": "5d",
                "amount": 5,
                "discount": 1,
                "discount_tips": "0%",
                "status":1
            }
        ],
        "day_packages_less10": [ // Duration plans (<= 9)
            {
                "name": "30d",
                "amount": 30,
                "discount": 1,
                "discount_tips": "0%",
                "status":1
            }
        ]
    }
}

Request Parameters

Response Data

Purchase static resources in multiple regions (checkIP)

API

• Address: /api/order/checkIp

• Method: POST

Success Response

{
    "code": 0,
    "msg": "Success",
    "data": {
        "sub_orders": [    //Details on purchasing from multiple regions
            {
                "area_id": 1, //Region ID
                "number": 5, //Purchase Quantity
                "location": "US" //Region Name
            },
            {
                "area_id": 3,
                "number": 3,
                "location": "CA"
            },
            {
                "area_id": 0,
                "number": 2,
                "location": "Random"
            }
        ],
        "total_price": 1164, //Fees to be paid (unit: cents)
        "amount": 1164, //Fees to be paid. Unit: Hong Kong cents (HK cents) depending on the currency.
        "exchange_rate": 1, //Exchange rate
        "currency": "USD", //Currency
        "discount_rate": 0.03, //Discount percentage
        "discount": 36, //Discount Amount (Unit: cents)
        "period_discount": 36, //Duration Discount (unit: cents)
        "coupons_discount": 0,//Coupon discount (unit: cents)
        "commission_rate": "0%",//Commission rate
        "commission_price": 0,//Transaction fee (unit: cents)
        "order_id": "469911732178462097330108518", //Order number
        "day": 30, // Days
        "number": 10, //Quantity
        "slotting_allowance": 0, //Access fee
        "unit_price": 4, //Unit price
        "raw_price": 1200 //Original price
    }
}

Request Parameters

Response Data

Multi-Region Static IP Resource Purchase – Pay

API

• Address: api/order/payip

• Method: GET

Success Response

{
    "code": 0,
    "msg": "Success",
    "data": []
}

Request Parameters

Response Data

Proxy list

API

• Address: api/static/iplist

• Method: GET

Success Response

{
    "code": 0,
    "msg": "Success",
    "data": {
        "total": 1,
        "list": [
            {
                "proxy_id": 12569758, //proxy id
                "ip": "154.56.47.2", //ip
                "port": 30123, //port
                "username": "12gfUPWHZGxZG", //Proxy username
                "password": "12gfUPWHZGxZG", //Proxy password
                "remark": "", //remark 
                "status": 1, // Status: 1 Available, 2 Inactive, 3 Expired, 5 Error
                "expire_time": 1756786560,
                "area": "US-Washington/Seattle"
            }
        ]
    }
}

Request Parameters

Response Data