Illusory

https://www.illusory.io/docs/api-reference/
Admin
Illusory is a platform that provides API reference documentation and tools for developers to...
Tokens:40,239
Snippets:94
Trust Score:7.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Price Get Schema Example

Source: https://www.illusory.io/docs/api-reference/platform/price-get

An example illustrating the 'price-get' schema, showing user membership status, period-based pricing details (weekly and monthly), savings breakdown, and total costs.

```json
{
  "member": true,
  "periods": {
    "weekly": {
      "individual": {
        "VR-AU-D03C11FA": {
          "interval": 1,
          "standard": 99,
          "member": 89,
          "total": 89
        }
      },
      "bulk": {
        "individual": 1,
        "price": null
      },
      "total": {
        "standard": 99,
        "member": 89,
        "due": 89
      }
    },
    "monthly": {
      "individual": {
        "VR-AU-29A225F3": {
          "interval": 1,
          "standard": 279
        }
      }
    }
  },
  "savings": {
    "member": {
      "weekly": {
        "individual": 10,
        "total": 10
      },
      "monthly": {
        "individual": 50,
        "total": 150
      }
    },
    "bulk": {
      "weekly": {
        "individual": 0,
        "total": 0
      },
      "monthly": {
        "individual": 10,
        "total": 30
      }
    },
    "interval": 18,
    "total": 208
  },
  "total": {
    "standard": 936,
    "member": 776,
    "due": 728
  }
}
```

--------------------------------

### User Not Found Error Example (JSON)

Source: https://www.illusory.io/docs/api-reference/platform/funds-get

An example JSON payload representing a 'user-not-found' error. This demonstrates the structure with 'ok' set to false, user-specific data, and an error message.

```JSON
{
  "ok": false,
  "data": {
    "user_id": "user_1234567890"
  },
  "message": "User not found."
}
```

--------------------------------

### Get Stock API

Source: https://www.illusory.io/docs/api-reference/platform/stock-get

Retrieves the Illusory product stock information.

```APIDOC
## GET /websites/illusory_io_api-reference/stock

### Description
Retrieves the Illusory product stock.

### Method
GET

### Endpoint
/websites/illusory_io_api-reference/stock

### Parameters
#### Query Parameters
- **productId** (string) - Required - The ID of the product to retrieve stock for.

### Request Example
```
GET /websites/illusory_io_api-reference/stock?productId=XYZ123
```

### Response
#### Success Response (200)
- **stock_level** (integer) - The current stock level of the product.
- **last_updated** (string) - The timestamp when the stock information was last updated.

#### Response Example
```json
{
  "stock_level": 150,
  "last_updated": "2023-10-27T10:30:00Z"
}
```
```

--------------------------------

### Proxy Allocation Renew Schema Example

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-allocate-renew

An example demonstrating the structure of the request body for updating proxy allocation renew settings. It includes a list of proxies with their respective renewal configurations.

```json
{
  "proxies": {
    "time": [
      {
        "proxy_name": "IL-US-AU1-9999",
        "auto_renew": true,
        "interval": 1
      }
    ]
  }
}
```

--------------------------------

### GET /v1/proxies

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-list

Retrieves a list of available proxies. This endpoint requires authentication using a Master API key.

```APIDOC
## GET /v1/proxies

### Description
Retrieves a list of proxies available for use. Authentication is required.

### Method
GET

### Endpoint
https://cmd.illusory.io/v1/proxies

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - The `Authorization` header is used to authenticate with the API using your `Master` API key. Value is of the format `Bearer YOUR_KEY_HERE`.

### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates whether the request was successful.
- **data** (array) - An array of proxy details. Each object in the array has the following properties:
  - **proxy_name** (string) - Unique identifier of the proxy server.
  - **nickname** (string | null) - Optional nickname for the proxy.
  - **isp** (string) - Name of the Internet Service Provider.
  - **period** (string) - Subscription period (e.g., `weekly`, `monthly`).
  - **auto_renew** (boolean) - Indicates whether the expiration auto-renews.
  - **auto_renew_interval** (integer) - The period interval for auto-renewal.
  - **added_at** (string) - Timestamp of when the proxy was added (ISO 8601 format).
  - **expires_at** (string) - Timestamp of when the proxy will expire (ISO 8601 format).
  - **network_status** (string) - Current status of the network (e.g., `online`, `offline`, `rebooting`).
  - **server_ip** (string) - The IP address of the proxy server.
  - **h_port** (integer) - The HTTP port for the proxy.
  - **s_port** (integer) - The SOCKS port for the proxy.
  - **auth_method** (string) - The authentication method used (e.g., `basic`).
  - **username** (string) - The username for proxy authentication.
  - **password** (string) - The password for proxy authentication.
  - **whitelist** (array | null) - A list of whitelisted IP addresses (if applicable).
  - **auto_change** (boolean) - Indicates if the IP address changes automatically.
  - **auto_change_time** (integer) - The interval in minutes for automatic IP changes.
  - **last_ip_change** (string) - Timestamp of the last IP address change (ISO 8601 format).
  - **last_reboot** (string) - Timestamp of the last proxy reboot (ISO 8601 format).
  - **traffic** (integer) - The amount of traffic used in bytes.
  - **h_threads** (integer) - The number of HTTP threads.
  - **s_threads** (integer) - The number of SOCKS threads.
  - **city** (string) - The city where the proxy server is located.
  - **state** (string) - The state where the proxy server is located.

#### Error Response (400)
- **ok** (boolean) - Indicates the request was unsuccessful (`false`).
- **data** (object) - Additional error data.
  - **proxy_name** (string) - Unique identifier of the proxy server.
- **message** (string) - Error message describing the issue.

### Response Example
#### Success Response (200)
```json
{
  "ok": true,
  "data": [
    {
      "proxy_name": "ILL-US-AU1-9999",
      "nickname": null,
      "isp": "Verizon",
      "period": "weekly",
      "auto_renew": false,
      "auto_renew_interval": 1,
      "added_at": "2050-12-04T17:43:16.407+00:00",
      "expires_at": "2050-12-14T23:23:09.792+00:00",
      "network_status": "online",
      "server_ip": "198.765.543.21",
      "h_port": 12345,
      "s_port": 67890,
      "auth_method": "basic",
      "username": "john",
      "password": "wick05",
      "whitelist": null,
      "auto_change": false,
      "auto_change_time": 0,
      "last_ip_change": "2050-12-04T17:51:40.339+00:00",
      "last_reboot": "2050-12-04T17:51:40.339+00:00",
      "traffic": 60156561622,
      "h_threads": 99,
      "s_threads": 0,
      "city": "Austin",
      "state": "TX"
    }
  ]
}
```

#### Error Response Example (400)
```json
{
  "ok": false,
  "data": {
    "proxy_name": "ILL-US-AU1-9999"
  },
  "message": "Proxy not found"
}
```
```

--------------------------------

### OpenAPI GET /v1/proxies Endpoint Definition

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-list

Defines the GET /v1/proxies endpoint using OpenAPI 3.0 specification. It includes details on the server URL, authentication (Bearer token), request/response schemas, and examples for successful and error responses.

```yaml
paths:
  path: /v1/proxies
  method: get
  servers:
    - url: https://cmd.illusory.io
  request:
    security:
      - title: bearerAuth
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
              description: >-
                The `Authorization` header is used to authenticate with the API
                using your `Master` API key. Value is of the format `Bearer
                YOUR_KEY_HERE`.
          cookie: {}
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              ok:
                allOf:
                  - type: boolean
                    description: Indicates whether the request was successful e.g., `true`
              data:
                allOf:
                  - type: array
                    description: An array of proxy details
                    items:
                      $ref: '#/components/schemas/proxy-get'
            refIdentifier: '#/components/schemas/proxy-list'
        examples:
          example:
            value:
              ok: true
              data:
                - proxy_name: ILL-US-AU1-9999
                  nickname: null
                  isp: Verizon
                  period: weekly
                  auto_renew: false
                  auto_renew_interval: 1
                  added_at: '2050-12-04T17:43:16.407+00:00'
                  expires_at: '2050-12-14T23:23:09.792+00:00'
                  network_status: online
                  server_ip: 198.765.543.21
                  h_port: 12345
                  s_port: 67890
                  auth_method: basic
                  username: john
                  password: wick05
                  whitelist: null
                  auto_change: false
                  auto_change_time: 0
                  last_ip_change: '2050-12-04T17:51:40.339+00:00'
                  last_reboot: '2050-12-04T17:51:40.339+00:00'
                  traffic: 60156561622
                  h_threads: 99
                  s_threads: 0
                  city: Austin
                  state: TX
        description: Server response
    '400':
      application/json:
        schemaArray:
          - type: object
            properties:
              ok:
                allOf:
                  - type: boolean
                    description: Indicates the request was unsuccessful e.g., `false`
              data:
                allOf:
                  - type: object
                    description: Additional error data
                    properties:
                      proxy_name:
                        type: string
                        description: Unique identifier of the proxy server
              message:
                allOf:
                  - type: string
                    description: Error message
            refIdentifier: '#/components/schemas/Error'
            example:
              ok: false
              data:
                proxy_name: ILL-US-AU1-9999
              message: Proxy not found
        examples:
          example:
            value:
              ok: false
              data:
                proxy_name: ILL-US-AU1-9999
              message: Proxy not found
        description: Unexpected error
  deprecated: false
  type: path
components:
  schemas:
    proxy-get:
      type: object
      properties:
        proxy_name:
          type: string
          description: Unique identifier of the proxy server
          example: ILL-US-AU1-9999
        nickname:
          type: string
          description: Optional nickname for the user or proxy.
          example: null
          nullable: true
        isp:
          type: string
          description: Name of the Internet Service Provider
          example: Verizon
        period:
          type: string
          description: Subscription period, e.g., `weekly`, `monthly`
          example: weekly
        auto_renew:
          type: boolean
          description: Indicates whether the expiration auto-renews
          example: false
        auto_renew_interval:
          type: integer
          description: The period interval for auto-renewal
          example: 1
        added_at:
          type: string
          format: date-time
          description: Timestamp of when the proxy was added
          example: '2050-12-04T17:43:16.407+00:00'
        expires_at:
          type: string
          format: date-time
          description: Timestamp of when the proxy will expire
          example: '2050-12-14T23:23:09.792+00:00'
        network_status:
          type: string
          description: >-
            Current status of the network, e.g., `online`, `offline`,
            `rebooting`
          example: online
        server_ip:

```

--------------------------------

### Error Response Handling

Source: https://www.illusory.io/docs/api-reference/platform/funds-get

Details on how the API handles error responses, including common error structures and examples.

```APIDOC
## Error Response Handling

### Description
This section outlines the structure of error responses returned by the API. It includes details about common error codes, their meanings, and the expected format of the error payload.

### Error Structure
Errors are typically returned with a `400` status code and a JSON payload containing details about the failure.

#### Common Error Fields
- **ok** (boolean) - Indicates the request was unsuccessful (e.g., `false`).
- **data** (object) - Additional error data, which may include specific details like `user_id`.
- **message** (string) - A human-readable error message.

### Error Example (User Not Found)

#### Response Example
```json
{
  "ok": false,
  "data": {
    "user_id": "user_1234567890"
  },
  "message": "User not found."
}
```
```

--------------------------------

### GET /v1/stock

Source: https://context7.com/context7/illusory_io_api-reference/llms.txt

Returns real-time inventory levels for each ISP across all available cities showing exact proxy counts and availability status.

```APIDOC
## Get Stock Availability

Returns real-time inventory levels for each ISP across all available cities showing exact proxy counts and availability status.

### Method
GET

### Endpoint
`/v1/stock`

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the operation was successful.
- **message** (string) - A confirmation message.
- **data** (array) - A list of objects, each representing stock availability in a city.
  - **city** (string) - The name of the city.
  - **state** (string) - The state of the city.
  - **att** (integer) - Number of AT&T proxies available.
  - **verizon** (integer) - Number of Verizon proxies available.
  - **tmobile** (integer) - Number of T-Mobile proxies available.
  - **status** (string) - The availability status (e.g., 'available', 'out').
  - **open** (boolean) - Indicates if the city is open for proxy provisioning.
  - **visible** (boolean) - Indicates if the city is visible in the stock list.

#### Response Example
```json
{
  "ok": true,
  "message": "Retrieved stock successfully.",
  "data": [
    {
      "city": "Austin",
      "state": "TX",
      "att": 0,
      "verizon": 39,
      "tmobile": 0,
      "status": "available",
      "open": true,
      "visible": true
    },
    {
      "city": "Cleveland",
      "state": "OH",
      "att": 0,
      "verizon": 1,
      "tmobile": 0,
      "status": "available",
      "open": true,
      "visible": true
    },
    {
      "city": "Los Angeles",
      "state": "CA",
      "att": 0,
      "verizon": 0,
      "tmobile": 0,
      "status": "out",
      "open": true,
      "visible": true
    }
  ]
}
```
```

--------------------------------

### API Pricing Response (JSON)

Source: https://context7.com/context7/illusory_io_api-reference/llms.txt

Example JSON response detailing the pricing breakdown for proxy configurations. This structure outlines costs per period (weekly, monthly), distinguishing between individual and bulk pricing, and also showing member-specific rates and total savings. It provides a comprehensive financial overview for requested proxy services.

```json
{
  "ok": true,
  "message": "Retrieved pricing details successfully.",
  "data": {
    "member": true,
    "periods": {
      "weekly": {
        "individual": {
          "VR-AU-D03C11FA": {
            "interval": 1,
            "standard": 99,
            "member": 89,
            "total": 89
          }
        },
        "bulk": {
          "individual": 1,
          "price": null
        },
        "total": {
          "standard": 99,
          "member": 89,
          "due": 89
        }
      },
      "monthly": {
        "individual": {
          "VR-AU-29A225F3": {
            "interval": 1,
            "standard": 279,
            "member": 229,
            "total": 219
          },
          "AT-CL-4AABB4B5": {
            "interval": 2,
            "standard": 279,
            "member": 229,
            "total": 438
          }
        },
        "bulk": {
          "individual": 2,
          "price": 219
        },
        "total": {
          "standard": 837,
          "member": 687,
          "due": 657
        }
      }
    },
    "savings": {
      "member": {
        "weekly": {
          "individual": 10,
          "total": 10
        },
        "monthly": {
          "individual": 50,
          "total": 150
        }
      },
      "bulk": {
        "weekly": {
          "individual": 0,
          "total": 0
        },
        "monthly": {
          "individual": 10,
          "total": 30
        }
      },
      "interval": 18,
      "total": 208
    },
    "total": {
      "standard": 936,
      "member": 776,
      "due": 728
    }
  }
}
```

--------------------------------

### Get Stock Availability by ISP and City

Source: https://context7.com/context7/illusory_io_api-reference/llms.txt

Returns real-time inventory levels for proxy servers across different ISPs and cities. Provides exact proxy counts and availability status for each location. The response is an array of objects, each detailing a city's stock.

```bash
curl https://cmd.illusory.io/v1/stock \
  -H "Authorization: Bearer zpka_12345"
```

--------------------------------

### GET /v1/stock

Source: https://www.illusory.io/docs/api-reference/platform/stock-get

Retrieves stock data for various server locations. This endpoint requires authentication via a Bearer token.

```APIDOC
## GET /v1/stock

### Description
Retrieves stock information from various server locations. This endpoint is used to fetch details about available stock, including city, state, quantities of different carriers, status, and visibility.

### Method
GET

### Endpoint
https://cmd.illusory.io/v1/stock

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates whether the request was successful.
- **message** (string) - A success message detailing the outcome of the request.
- **data** (array) - An array of objects, where each object contains stock details for a specific city.
  - **city** (string) - The city where the server is located.
  - **state** (string) - The abbreviated state where the server is located.
  - **att** (integer) - Amount of AT&T stock available.
  - **verizon** (integer) - Amount of Verizon stock available.
  - **tmobile** (integer) - Amount of T-Mobile stock available.
  - **status** (string) - Current status of the stock (e.g., `available`, `out`, `coming_soon`).
  - **open** (boolean) - Indicates whether the stock is open for purchase.
  - **visible** (boolean) - Indicates whether the stock is visible on the website.

#### Response Example
```json
{
  "ok": true,
  "message": "Retrieved stock successfully.",
  "data": [
    {
      "city": "Austin",
      "state": "TX",
      "att": 0,
      "verizon": 39,
      "tmobile": 0,
      "status": "available",
      "open": true,
      "visible": true
    },
    {
      "city": "Cleveland",
      "state": "OH",
      "att": 0,
      "verizon": 1,
      "tmobile": 0,
      "status": "available",
      "open": true,
      "visible": true
    }
  ]
}
```
```

--------------------------------

### Server Configuration Details

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-list

This section details the various properties that describe a server's configuration and status within the Illusory.io platform. It includes network settings, authentication methods, traffic data, and location information.

```APIDOC
## Server Configuration Object

### Description
Represents the detailed configuration and status of a server, including network parameters, authentication credentials, traffic statistics, and geographical location.

### Properties

#### ip_address (string) - Description: IP address of the server. Example: `198.765.543.21`

#### h_port (integer) - Description: Port number for HTTP connections. Example: `12345`

#### s_port (integer) - Description: Port number for SOCKS5 connections. Example: `67890`

#### auth_method (string) - Description: Authentication method. Can be `basic` or `whitelist`. Example: `basic`

#### username (string) - Description: Username for authentication. Example: `john`

#### password (string) - Description: Password for authentication. Example: `wick05`

#### whitelist (string, nullable: true) - Description: List of whitelisted IP addresses or domains, can be `null`. Example: `null`

#### auto_change (boolean) - Description: Indicates whether the IP changes automatically. Example: `false`

#### auto_change_time (integer) - Description: Time interval for automatic IP change, in minutes. Example: `0`

#### last_ip_change (string, format: date-time) - Description: Timestamp of the last IP change. Example: `'2050-12-04T17:51:40.339+00:00'`

#### last_reboot (string, format: date-time) - Description: Timestamp of the last server reboot. Example: `'2050-12-04T17:51:40.339+00:00'`

#### traffic (integer) - Description: Total network traffic in bytes. Example: `60156561622`

#### h_threads (integer) - Description: Number of active HTTP threads. Example: `99`

#### s_threads (integer) - Description: Number of active SOCKS5 threads. Example: `0`

#### city (string) - Description: The city where the server is located. Example: `Austin`

#### state (string) - Description: The abbreviated state where the server is located. Example: `TX`

### Response Example
```json
{
  "ip_address": "198.765.543.21",
  "h_port": 12345,
  "s_port": 67890,
  "auth_method": "basic",
  "username": "john",
  "password": "wick05",
  "whitelist": null,
  "auto_change": false,
  "auto_change_time": 0,
  "last_ip_change": "2050-12-04T17:51:40.339+00:00",
  "last_reboot": "2050-12-04T17:51:40.339+00:00",
  "traffic": 60156561622,
  "h_threads": 99,
  "s_threads": 0,
  "city": "Austin",
  "state": "TX"
}
```
```

--------------------------------

### Deploy New Proxies

Source: https://context7.com/context7/illusory_io_api-reference/llms.txt

Provisions one or more new proxy servers with specified ISP, location, and billing period. This POST request requires a JSON payload detailing the proxy configurations. Authentication is mandatory.

```bash
curl -X POST https://cmd.illusory.io/v1/proxies/deploy \
  -H "Authorization: Bearer zpka_12345" \
  -H "Content-Type: application/json" \
  -d '{
    "proxies": [
      {
        "isp": "Verizon",
        "location": "Austin",
        "interval": 1,
        "period": "weekly"
      },
      {
        "isp": "AT&T",
        "location": "Cleveland",
        "interval": 2,
        "period": "monthly"
      }
    ]
  }'
```

--------------------------------

### Get Proxy

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-get

Retrieves the details of a specific proxy server using its ID.

```APIDOC
## GET /websites/illusory_io_api-reference/proxies/{proxy_id}

### Description
Retrieves the details of a proxy server.

### Method
GET

### Endpoint
/websites/illusory_io_api-reference/proxies/{proxy_id}

### Parameters
#### Path Parameters
- **proxy_id** (string) - Required - The unique identifier of the proxy to retrieve.

### Response
#### Success Response (200)
- **proxy_details** (object) - An object containing the details of the proxy.
  - **id** (string) - The unique identifier of the proxy.
  - **ip_address** (string) - The IP address of the proxy.
  - **port** (integer) - The port number of the proxy.
  - **type** (string) - The type of the proxy (e.g., HTTP, SOCKS5).
  - **country** (string) - The country where the proxy is located.

#### Response Example
```json
{
  "proxy_details": {
    "id": "proxy_123",
    "ip_address": "192.168.1.1",
    "port": 8080,
    "type": "HTTP",
    "country": "USA"
  }
}
```
```

--------------------------------

### POST /v1/price

Source: https://context7.com/context7/illusory_io_api-reference/llms.txt

Computes detailed pricing breakdowns for proxy configurations, including individual costs, bulk discounts, membership savings, and interval reductions.

```APIDOC
## POST /v1/price

### Description
Computes detailed pricing breakdowns for proxy configurations including individual costs, bulk discounts, membership savings, and interval reductions.

### Method
POST

### Endpoint
https://cmd.illusory.io/v1/price

### Parameters
#### Request Body
- **proxies** (array) - Required - An array of proxy configuration objects.
  - **isp** (string) - Required - The Internet Service Provider.
  - **location** (string) - Required - The desired geographic location.
  - **interval** (integer) - Required - The number of proxies to provision.
  - **period** (string) - Required - The billing period (e.g., 'weekly', 'monthly').

### Request Example
```json
{
  "proxies": [
    {
      "isp": "Verizon",
      "location": "Austin",
      "interval": 1,
      "period": "weekly"
    },
    {
      "isp": "Verizon",
      "location": "Austin",
      "interval": 1,
      "period": "monthly"
    },
    {
      "isp": "AT&T",
      "location": "Cleveland",
      "interval": 2,
      "period": "monthly"
    }
  ]
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the result of the request.
- **data** (object) - Contains pricing and savings details.
  - **member** (boolean) - Indicates if the user is a member.
  - **periods** (object) - Pricing details broken down by billing period.
    - **weekly** (object) - Pricing for weekly periods.
    - **monthly** (object) - Pricing for monthly periods.
  - **savings** (object) - Details on available savings (member, bulk, interval).
  - **total** (object) - Overall cost breakdown.

#### Response Example
```json
{
  "ok": true,
  "message": "Retrieved pricing details successfully.",
  "data": {
    "member": true,
    "periods": {
      "weekly": {
        "individual": {
          "VR-AU-D03C11FA": {
            "interval": 1,
            "standard": 99,
            "member": 89,
            "total": 89
          }
        },
        "bulk": {
          "individual": 1,
          "price": null
        },
        "total": {
          "standard": 99,
          "member": 89,
          "due": 89
        }
      },
      "monthly": {
        "individual": {
          "VR-AU-29A225F3": {
            "interval": 1,
            "standard": 279,
            "member": 229,
            "total": 219
          },
          "AT-CL-4AABB4B5": {
            "interval": 2,
            "standard": 279,
            "member": 229,
            "total": 438
          }
        },
        "bulk": {
          "individual": 2,
          "price": 219
        },
        "total": {
          "standard": 837,
          "member": 687,
          "due": 657
        }
      }
    },
    "savings": {
      "member": {
        "weekly": {
          "individual": 10,
          "total": 10
        },
        "monthly": {
          "individual": 50,
          "total": 150
        }
      },
      "bulk": {
        "weekly": {
          "individual": 0,
          "total": 0
        },
        "monthly": {
          "individual": 10,
          "total": 30
        }
      },
      "interval": 18,
      "total": 208
    },
    "total": {
      "standard": 936,
      "member": 776,
      "due": 728
    }
  }
}
```
```

--------------------------------

### GET /v1/proxies/{proxyName}

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-get

Retrieves detailed information about a specific proxy server using its unique name.

```APIDOC
## GET /v1/proxies/{proxyName}

### Description
Retrieves detailed information about a specific proxy server using its unique name.

### Method
GET

### Endpoint
`/v1/proxies/{proxyName}`

### Parameters
#### Path Parameters
- **proxyName** (string) - Required - Unique identifier of the proxy server.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates whether the request was successful.
- **data** (object) - Contains the proxy details.
  - **proxy_name** (string) - Unique identifier of the proxy server.
  - **nickname** (string | null) - Optional nickname for the proxy.
  - **isp** (string) - Name of the Internet Service Provider.
  - **period** (string) - Subscription period (e.g., `weekly`, `monthly`).
  - **auto_renew** (boolean) - Indicates if expiration auto-renews.
  - **auto_renew_interval** (integer) - The period interval for auto-renewal.
  - **added_at** (string) - Timestamp of when the proxy was added.
  - **expires_at** (string) - Timestamp of when the proxy will expire.
  - **network_status** (string) - Current network status (e.g., `online`, `offline`).
  - **server_ip** (string) - The IP address of the proxy server.
  - **h_port** (integer) - High port number.
  - **s_port** (integer) - Low port number.
  - **auth_method** (string) - Authentication method used.
  - **username** (string) - Username for authentication.
  - **password** (string) - Password for authentication.
  - **whitelist** (array | null) - List of whitelisted IPs.
  - **auto_change** (boolean) - Indicates if the IP changes automatically.
  - **auto_change_time** (integer) - Time interval for automatic IP changes.
  - **last_ip_change** (string) - Timestamp of the last IP change.
  - **last_reboot** (string) - Timestamp of the last reboot.
  - **traffic** (integer) - Data traffic usage in bytes.
  - **h_threads** (integer) - High threads count.
  - **s_threads** (integer) - Low threads count.
  - **city** (string) - City where the proxy is located.
  - **state** (string) - State where the proxy is located.

#### Response Example
```json
{
  "ok": true,
  "data": {
    "proxy_name": "ILL-US-AU1-9999",
    "nickname": null,
    "isp": "Verizon",
    "period": "weekly",
    "auto_renew": false,
    "auto_renew_interval": 1,
    "added_at": "2050-12-04T17:43:16.407+00:00",
    "expires_at": "2050-12-14T23:23:09.792+00:00",
    "network_status": "online",
    "server_ip": "198.765.543.21",
    "h_port": 12345,
    "s_port": 67890,
    "auth_method": "basic",
    "username": "john",
    "password": "wick05",
    "whitelist": null,
    "auto_change": false,
    "auto_change_time": 0,
    "last_ip_change": "2050-12-04T17:51:40.339+00:00",
    "last_reboot": "2050-12-04T17:51:40.339+00:00",
    "traffic": 60156561622,
    "h_threads": 99,
    "s_threads": 0,
    "city": "Austin",
    "state": "TX"
  }
}
```

#### Error Response (400)
- **ok** (boolean) - Indicates the request was unsuccessful.
- **data** (object) - Additional error data.
  - **proxy_name** (string) - Unique identifier of the proxy server.
- **message** (string) - Error message.

#### Error Response Example
```json
{
  "ok": false,
  "data": {
    "proxy_name": "ILL-US-AU1-9999"
  },
  "message": "Proxy not found"
}
```
```

--------------------------------

### Deploy New Proxies

Source: https://context7.com/context7/illusory_io_api-reference/llms.txt

Provisions one or more new proxy servers with specified ISP, location, and billing period configurations.

```APIDOC
## POST /v1/proxies/deploy

### Description
Provisions one or more new proxy servers with specified ISP, location, and billing period configurations.

### Method
POST

### Endpoint
/v1/proxies/deploy

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **proxies** (array) - Required - A list of proxy configurations to deploy.
  - **isp** (string) - Required - The Internet Service Provider for the proxy (e.g., "Verizon", "AT&T").
  - **location** (string) - Required - The city where the proxy should be located (e.g., "Austin", "Cleveland").
  - **interval** (integer) - Optional - The billing interval in months (e.g., 1 for monthly, 12 for yearly).
  - **period** (string) - Optional - The billing period (e.g., "weekly", "monthly", "yearly"). Defaults to "monthly" if not specified.

### Request Example
```bash
curl -X POST https://cmd.illusory.io/v1/proxies/deploy \
  -H "Authorization: Bearer zpka_12345" \
  -H "Content-Type: application/json" \
  -d '{
    "proxies": [
      {
        "isp": "Verizon",
        "location": "Austin",
        "interval": 1,
        "period": "weekly"
      },
      {
        "isp": "AT&T",
        "location": "Cleveland",
        "interval": 2,
        "period": "monthly"
      }
    ]
  }'
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **message** (string) - A confirmation message about the deployment request.
- **data** (object) - Deployment details.
  - **user_id** (string) - The ID of the user who initiated the deployment.
  - **total** (integer) - The total number of proxies requested for deployment.

#### Response Example
```json
{
  "ok": true,
  "message": "Sent deploy request successfully. Your proxies should be deployed shortly to your dashboard.",
  "data": {
    "user_id": "user_1234567890",
    "total": 25
  }
}
```
```

--------------------------------

### Error Handling

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-allocate

Details common error responses, including proxy not found and insufficient funds.

```APIDOC
## Error Responses

### Error Response (404 Proxy Not Found)
- **ok** (boolean) - Indicates the request was unsuccessful.
- **data** (object) - Contains information about the proxy.
  - **proxy_name** (string) - The name of the proxy that was not found.
- **message** (string) - Error message.

#### Response Example
```json
{
  "ok": false,
  "data": {
    "proxy_name": "ILL-US-AU1-9999"
  },
  "message": "Proxy not found"
}
```

### Error Response (402 User Low Funds)
- **ok** (boolean) - Indicates the request was unsuccessful.
- **data** (object) - Additional error data.
  - **funds** (integer) - Amount of funds available.
  - **due** (integer) - Amount due.
- **message** (string) - Error message.

#### Response Example
```json
{
  "ok": false,
  "data": {
    "funds": 40,
    "due": 2198
  },
  "message": "Insufficient funds. Please add funds to your wallet."
}
```
```

--------------------------------

### POST /v1/proxies/deploy

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-deploy

Deploys proxies based on the provided configuration. This endpoint allows you to specify the internet service provider, location, interval, and period for each proxy deployment.

```APIDOC
## POST /v1/proxies/deploy

### Description
Deploys proxies based on the provided configuration. This endpoint allows you to specify the internet service provider, location, interval, and period for each proxy deployment.

### Method
POST

### Endpoint
https://cmd.illusory.io/v1/proxies/deploy

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **proxies** (array) - Required - List of proxies to deploy. Each item should include `isp`, `location`, `interval` and `period`.
  - **isp** (string) - Required - Internet Service Provider
  - **location** (string) - Required - City of the proxy server. e.g., `Austin`
  - **interval** (integer) - Required - Interval for deployment period. e.g., `2` weeks.
  - **period** (string) - Required - Deployment period, e.g., 'weekly'. Enum: `hourly`, `daily`, `weekly`, `monthly`, `yearly`

### Request Example
```json
{
  "proxies": [
    {
      "isp": "Verizon",
      "location": "Austin",
      "interval": 1,
      "period": "weekly"
    },
    {
      "isp": "AT&T",
      "location": "Cleveland",
      "interval": 2,
      "period": "monthly"
    }
  ]
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates whether the request was successful e.g., `true`
- **message** (string) - Success message
- **data** (object) - Additional data related to the deployment.

#### Response Example
```json
{
  "ok": true,
  "message": "Sent deploy request successfully. Your proxies should be deployed shortly to your dashboard.",
  "data": {
    "user_id": "user_1234567890",
    "total": 25
  }
}
```

#### Error Response (400)
- **ok** (boolean) - Indicates the request was unsuccessful e.g., `false`
- **data** (object) - Additional error data.
  - **proxy_name** (string) - Unique identifier of the proxy server
- **message** (string) - Error message

#### Error Response Example
```json
{
  "ok": false,
  "data": {
    "proxy_name": "ILL-US-AU1-9999"
  },
  "message": "Proxy not found"
}
```
```

--------------------------------

### GET /v1/proxies/changeip/{limitedApiKey}/{proxyName}

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-change-ip-link

Changes the external mobile IP using a link and `Limited` API key.

```APIDOC
## GET /v1/proxies/changeip/{limitedApiKey}/{proxyName}

### Description
Changes the external mobile IP using a link and `Limited` API key.

### Method
GET

### Endpoint
https://cmd.illusory.io/v1/proxies/changeip/{limitedApiKey}/{proxyName}

### Parameters
#### Path Parameters
- **limitedApiKey** (string) - Required - Replace `{limitedApiKey}` in the url path with `YOUR_LIMITED_API_KEY`.
- **proxyName** (string) - Required - Replace `{proxyName}` in the url path with `YOUR_PROXY`.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates whether the request was successful e.g., `true`
- **message** (string) - Success message
- **data** (object) - Contains proxy change IP information
  - **proxy_name** (string) - Unique identifier of the proxy server
  - **last_ip_change** (string) - Timestamp of when the proxy IP was last changed

#### Response Example
```json
{
  "ok": true,
  "message": "Reset proxy command sent to device successfully.",
  "data": {
    "proxy_name": "ILL-US-AU1-9999",
    "last_ip_change": "2050-12-04T17:43:16.407+00:00"
  }
}
```

#### Error Response (400)
- **ok** (boolean) - Indicates the request was unsuccessful e.g., `false`
- **data** (object) - Additional error data
  - **proxy_name** (string) - Unique identifier of the proxy server
- **message** (string) - Error message

#### Response Example
```json
{
  "ok": false,
  "data": {
    "proxy_name": "ILL-US-AU1-9999"
  },
  "message": "Proxy not found"
}
```
```

--------------------------------

### Proxy Deployment

Source: https://www.illusory.io/docs/api-reference/proxies/proxy-deploy

This section details the API endpoint for deploying a proxy, including the request body structure and expected user and total amount information.

```APIDOC
## POST /websites/illusory_io_api-reference/proxy-deploy

### Description
Deploys a proxy, requiring user identification and the total amount to be deducted from the user's Illusory Wallet.

### Method
POST

### Endpoint
/websites/illusory_io_api-reference/proxy-deploy

### Parameters
#### Request Body
- **user_id** (string) - Required - Unique identifier of the user
- **total** (integer) - Required - Total amount to be deducted from your Illusory Wallet.

### Request Example
```json
{
  "user_id": "user_1234567890",
  "total": 25
}
```

### Response
#### Success Response (200)
(Success response details not provided in the input text)

#### Response Example
(Success response example not provided in the input text)
```
Tokens:
Raw