TradeVPS

Trading VPS

These endpoints allow you to manage your trading VPS instances, including creating, listing, and removing VPS.

The VPS object

The VPS object contains all information about a Trading VPS instance, including its configuration and current status.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the VPS

  • Name
    name
    Type
    string
    Description

    Custom name for the VPS

  • Name
    sur
    Type
    string
    Description

    Secure Unique URL for VPS access

  • Name
    provider
    Type
    integer
    Description

    VPS provider identifier. See Provider Types

  • Name
    region
    Type
    integer
    Description

    Region identifier where VPS is deployed. See Region Types

  • Name
    cpu
    Type
    float
    Description

    CPU cores allocated (in vCPUs)

  • Name
    memory
    Type
    integer
    Description

    Memory allocated (in MB)

  • Name
    storage
    Type
    integer
    Description

    Storage space allocated

  • Name
    storage_class
    Type
    string
    Description

    Storage class type

  • Name
    auto_scale_cpu
    Type
    boolean
    Description

    CPU auto-scaling enabled status

  • Name
    auto_scale_memory
    Type
    boolean
    Description

    Memory auto-scaling enabled status

  • Name
    charge
    Type
    float
    Description

    Current usage charge

  • Name
    soft_limit
    Type
    float
    Description

    Soft resource limit

  • Name
    hard_limit
    Type
    float
    Description

    Hard resource limit

  • Name
    ip
    Type
    string
    Description

    VPS IP address

  • Name
    has_static_ip
    Type
    boolean
    Description

    Static IP assignment status

  • Name
    status
    Type
    integer
    Description

    Current VPS status. See Status Types

  • Name
    synced_at
    Type
    timestamp
    Description

    Last synchronization timestamp

  • Name
    created_at
    Type
    timestamp
    Description

    VPS creation timestamp

  • Name
    updated_at
    Type
    timestamp
    Description

    Last update timestamp

Example Response

{
  "id": "9eacf104-816e-48c1-af3b-b546ab97e326",
  "name": "MiX7pp",
  "sur": null,
  "provider": 9,
  "region": 2,
  "cpu": 0.5,
  "memory": 1024,
  "storage": null,
  "storage_class": null,
  "auto_scale_cpu": null,
  "auto_scale_memory": null,
  "charge": 0,
  "soft_limit": 0,
  "hard_limit": 0,
  "ip": null,
  "has_static_ip": false,
  "status": 2,
  "synced_at": null,
  "created_at": "2025-04-14T18:42:31.000000Z",
  "updated_at": "2025-04-14T18:42:32.000000Z"
}

Region Types

The region field indicates the geographical location where the VPS will be deployed. Here are the possible values:

  • Name
    NEW_YORK (0)
    Type
    Description

    New York, United States

  • Name
    AMSTERDAM (1)
    Type
    Description

    Amsterdam, Netherlands

  • Name
    FRANKFURT (2)
    Type
    Description

    Frankfurt, Germany

  • Name
    LONDON (3)
    Type
    Description

    London, United Kingdom

  • Name
    SAN_FRANCISCO (4)
    Type
    Description

    San Francisco, United States

  • Name
    SINGAPORE (5)
    Type
    Description

    Singapore

  • Name
    TORONTO (6)
    Type
    Description

    Toronto, Canada

  • Name
    BANGKOK (7)
    Type
    Description

    Bangkok, Thailand

  • Name
    HONG_KONG (8)
    Type
    Description

    Hong Kong

  • Name
    PARIS (9)
    Type
    Description

    Paris, France

  • Name
    SYDNEY (10)
    Type
    Description

    Sydney, Australia

  • Name
    TOKYO (11)
    Type
    Description

    Tokyo, Japan

  • Name
    MUMBAI (12)
    Type
    Description

    Mumbai, India

Provider Types

The provider field indicates the cloud provider where the VPS is hosted. Here are the possible values:

  • Name
    DIGITAL_OCEAN (0)
    Type
    Description

    DigitalOcean cloud provider

  • Name
    VULTR (1)
    Type
    Description

    Vultr cloud provider

  • Name
    LINODE (2)
    Type
    Description

    Linode cloud provider

  • Name
    AWS (3)
    Type
    Description

    Amazon Web Services (AWS) cloud provider

  • Name
    GOOGLE_CLOUD (4)
    Type
    Description

    Google Cloud Platform provider

  • Name
    AZURE (5)
    Type
    Description

    Microsoft Azure cloud provider

  • Name
    ALIBABA_CLOUD (6)
    Type
    Description

    Alibaba Cloud provider

  • Name
    CTRL_CLOUD (7)
    Type
    Description

    CtrlCloud provider

Status Types

The status field indicates the current state of the VPS. Here are the possible values:

  • Name
    CREATED (0)
    Type
    info
    Description

    VPS has been created (Default status)

  • Name
    WAITING_PAYMENT (1)
    Type
    warning
    Description

    Waiting for payment confirmation

  • Name
    QUEUE (2)
    Type
    info
    Description

    VPS is in deployment queue

  • Name
    DEPLOYING (3)
    Type
    warning
    Description

    VPS is being deployed

  • Name
    INSTALLING (4)
    Type
    warning
    Description

    Software installation in progress

  • Name
    RUNNING (5)
    Type
    success
    Description

    VPS is active and running

  • Name
    FINISHED (6)
    Type
    success
    Description

    VPS setup completed successfully

  • Name
    CANCELED (7)
    Type
    danger
    Description

    VPS deployment was canceled

  • Name
    BLOCKED (8)
    Type
    danger
    Description

    VPS has been blocked

GET/my/trading/vps

List Trading VPS

Retrieve a list of all trading VPS instances.

Query Parameters

  • Name
    per_page
    Type
    integer
    Description

    Number of records per page (1-100)

  • Name
    page
    Type
    integer
    Description

    Page number for pagination

  • Name
    search
    Type
    string
    Description

    Search term to filter results

  • Name
    sort_by
    Type
    string
    Description

    Field to sort by (created_at, name, project_id, status, provider, region)

  • Name
    sort_direction
    Type
    string
    Description

    Sort direction (asc, desc)

  • Name
    status
    Type
    string
    Description

    Filter by VPS status. Multiple values supported as comma-separated (e.g., "1,2,3"). See Status Types

  • Name
    region
    Type
    string
    Description

    Filter by region. Multiple values supported as comma-separated (e.g., "1,2,3"). See Region Types

  • Name
    provider
    Type
    string
    Description

    Filter by provider. Multiple values supported as comma-separated (e.g., "1,2,3"). See Provider Types

  • Name
    project_id
    Type
    string
    Description

    Filter by project ID. Multiple values supported as comma-separated (e.g., "9eacf104-816e-48c1-af3b-b546ab97e326,7d793789-f34b-4760-9618-c7a8f6eadd45")

  • Name
    date_from
    Type
    string
    Description

    Start date for filtering (YYYY-MM-DD)

  • Name
    date_to
    Type
    string
    Description

    End date for filtering (YYYY-MM-DD)

Request

GET
/my/trading/vps
curl -X GET "https://api.tradevps.net/v1/my/trading/vps?per_page=20&page=1&sort_by=created_at&sort_direction=desc" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Response 200

{
  "ok": true,
  "msg": "Trading VPS fetched",
  "data": [
    {
      "id": "9eacf104-816e-48c1-af3b-b546ab97e326",
      "name": "MiX7pp",
      "sur": null,
      "provider": 9,
      "region": 2,
      "cpu": 0.5,
      "memory": 1024,
      "storage": null,
      "storage_class": null,
      "auto_scale_cpu": null,
      "auto_scale_memory": null,
      "charge": 0,
      "soft_limit": 0,
      "hard_limit": 0,
      "ip": null,
      "has_static_ip": false,
      "status": 2,
      "synced_at": null,
      "created_at": "2025-04-14T18:42:31.000000Z",
      "updated_at": "2025-04-14T18:42:32.000000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "last_page": 3,
    "per_page": 15,
    "total": 31,
    "first_page_url": "https://api.tradevps.net/v1/my/trading/vps?page=1",
    "from": 1,
    "last_page_url": "https://api.tradevps.net/v1/my/trading/vps?page=3",
    "links": "<nav role=\"navigation\" aria-label=\"Pagination Navigation\" class=\"flex items-center justify-between\">\n        <div class=\"flex justify-between flex-1 sm:hidden\">\n                            <span class=\"relative inline-flex items-center px-4 py-2 text-sm font-medium text-gray-500 bg-white border border-gray-300 cursor-default leading-5 rounded-md dark:text-gray-600 dark:bg-gray-800 dark:border-gray-600\">\n                    &laquo; Previous\n                </span>\n            \n                            <a href=\"https://api.tradevps.net/v1/my/trading/vps?page=2\" class=\"relative inline-flex items-center px-4 py-2 ml-3 text-sm font-medium text-gray-700 bg-white border border-gray-300 leading-5 rounded-md hover:text-gray-500 focus:outline-none focus:ring ring-gray-300 focus:border-blue-300 active:bg-gray-100 active:text-gray-700 transition ease-in-out duration-150 dark:bg-gray-800 dark:border-gray-600 dark:text-gray-300 dark:focus:border-blue-700 dark:active:bg-gray-700 dark:active:text-gray-300\">\n                    Next &raquo;\n                </a>\n                    </div>\n\n        <div class=\"hidden sm:flex-1 sm:flex sm:items-center sm:justify-between\">\n            <div>\n                <p class=\"text-sm text-gray-700 leading-5 dark:text-gray-400\">\n                    Showing\n                                            <span class=\"font-medium\">1</span>\n                        to\n                        <span class=\"font-medium\">15</span>\n                                        of\n                    <span class=\"font-medium\">31</span>\n                    results\n                </p>\n            </div>\n\n            <div>\n                <span class=\"relative z-0 inline-flex rtl:flex-row-reverse shadow-sm rounded-md\">\n                    \n                                            <span aria-disabled=\"true\" aria-label=\"&amp;laquo; Previous\">\n                            <span class=\"relative inline-flex items-center px-2 py-2 text-sm font-medium text-gray-500 bg-white border border-gray-300 cursor-default rounded-l-md leading-5 dark:bg-gray-800 dark:border-gray-600\" aria-hidden=\"true\">\n                                <svg class=\"w-5 h-5\" fill=\"currentColor\" viewBox=\"0 0 20 20\">\n                                    <path fill-rule=\"evenodd\" d=\"M12.707 5.293a1 1 0 010 1.414L9.414 10l3.293 3.293a1 1 0 01-1.414 1.414l-4-4a1 1 0 010-1.414l4-4a1 1 0 011.414 0z\" clip-rule=\"evenodd\" />\n                                </svg>\n                            </span>\n                        </span>\n                    \n                    \n                                            \n                        \n                        \n                                                                                                                        <span aria-current=\"page\">\n                                        <span class=\"relative inline-flex items-center px-4 py-2 -ml-px text-sm font-medium text-gray-500 bg-white border border-gray-300 cursor-default leading-5 dark:bg-gray-800 dark:border-gray-600\">1</span>\n                                    </span>\n                                                                                                                                <a href=\"https://api.tradevps.net/v1/my/trading/vps?page=2\" class=\"relative inline-flex items-center px-4 py-2 -ml-px text-sm font-medium text-gray-700 bg-white border border-gray-300 leading-5 hover:text-gray-500 focus:z-10 focus:outline-none focus:ring ring-gray-300 focus:border-blue-300 active:bg-gray-100 active:text-gray-700 transition ease-in-out duration-150 dark:bg-gray-800 dark:border-gray-600 dark:text-gray-400 dark:hover:text-gray-300 dark:active:bg-gray-700 dark:focus:border-blue-800\" aria-label=\"Go to page 2\">\n                                        2\n                                    </a>\n                                                                                                                                <a href=\"https://api.tradevps.net/v1/my/trading/vps?page=3\" class=\"relative inline-flex items-center px-4 py-2 -ml-px text-sm font-medium text-gray-700 bg-white border border-gray-300 leading-5 hover:text-gray-500 focus:z-10 focus:outline-none focus:ring ring-gray-300 focus:border-blue-300 active:bg-gray-100 active:text-gray-700 transition ease-in-out duration-150 dark:bg-gray-800 dark:border-gray-600 dark:text-gray-400 dark:hover:text-gray-300 dark:active:bg-gray-700 dark:focus:border-blue-800\" aria-label=\"Go to page 3\">\n                                        3\n                                    </a>\n                                                                                                        \n                    \n                                            <a href=\"https://api.tradevps.net/v1/my/trading/vps?page=2\" rel=\"next\" class=\"relative inline-flex items-center px-2 py-2 -ml-px text-sm font-medium text-gray-500 bg-white border border-gray-300 rounded-r-md leading-5 hover:text-gray-400 focus:z-10 focus:outline-none focus:ring ring-gray-300 focus:border-blue-300 active:bg-gray-100 active:text-gray-500 transition ease-in-out duration-150 dark:bg-gray-800 dark:border-gray-600 dark:active:bg-gray-700 dark:focus:border-blue-800\" aria-label=\"Next &amp;raquo;\">\n                            <svg class=\"w-5 h-5\" fill=\"currentColor\" viewBox=\"0 0 20 20\">\n                                <path fill-rule=\"evenodd\" d=\"M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z\" clip-rule=\"evenodd\" />\n                            </svg>\n                        </a>\n                                    </span>\n            </div>\n        </div>\n    </nav>\n",
    "next_page_url": "https://api.tradevps.net/v1/my/trading/vps?page=2",
    "prev_page_url": null
  }
}
POST/my/trading/vps

Deploy Trading VPS

Create a new Trading VPS instance.

Request Body

  • Name
    name
    Type
    string
    Description

    Custom name for the VPS (3-255 characters)

  • Name
    region
    Type
    integer
    Description

    Region identifier where VPS will be deployed. See Region Types

  • Name
    cpu
    Type
    decimal
    Description

    CPU cores to allocate (up to 3 decimal places)

  • Name
    memory
    Type
    integer
    Description

    Memory to allocate (in MB)

  • Name
    project_id
    Type
    string
    Description

    Project identifier to associate with the VPS

  • Name
    password
    Type
    string
    Description

    VPS access password (5-255 characters)

Request

POST
/my/trading/vps
curl -X POST https://api.tradevps.net/v1/my/trading/vps \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-trading-vps",
    "region": 2,
    "cpu": 0.5,
    "memory": 1024,
    "project_id": "project-123",
    "password": "secure-password"
  }'

Response 200

{
  "ok": true,
  "msg": "Trading VPS initialed",
  "data": {
    "id": "9ead0126-d546-4cfb-b309-47dcf40e3f44",
    "name": "s5JcIK",
    "sur": null,
    "provider": 9,
    "region": 2,
    "cpu": 0.5,
    "memory": 1024,
    "storage": null,
    "storage_class": null,
    "auto_scale_cpu": null,
    "auto_scale_memory": null,
    "charge": 0,
    "soft_limit": 0,
    "hard_limit": 0,
    "ip": null,
    "has_static_ip": null,
    "ip_version": null,
    "metapylot_token": null,
    "status": 0,
    "synced_at": null,
    "created_at": "2025-04-14T19:27:38.000000Z",
    "updated_at": "2025-04-14T19:27:39.000000Z"
  }
}
GET/my/trading/vps/show/{vps_id}

Get VPS Details

Retrieve details for a specific Trading VPS instance.

URL Parameters

  • Name
    vps_id
    Type
    string
    Description

    The unique identifier of the VPS

Request

GET
/my/trading/vps/show/{vps_id}
curl -X GET https://api.tradevps.net/v1/my/trading/vps/show/9ead0126-d546-4cfb-b309-47dcf40e3f44 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Response 200

{
  "ok": true,
  "msg": "Trading VPS fetched",
  "data": {
    "id": "9ead0126-d546-4cfb-b309-47dcf40e3f44",
    "name": "s5JcIK",
    "sur": null,
    "provider": 9,
    "region": 2,
    "cpu": 0.5,
    "memory": 1024,
    "storage": null,
    "storage_class": null,
    "auto_scale_cpu": null,
    "auto_scale_memory": null,
    "charge": 0,
    "soft_limit": 0,
    "hard_limit": 0,
    "ip": null,
    "has_static_ip": false,
    "ip_version": null,
    "metapylot_token": null,
    "status": 2,
    "synced_at": null,
    "created_at": "2025-04-14T19:27:38.000000Z",
    "updated_at": "2025-04-14T19:27:39.000000Z"
  }
}
POST/my/trading/vps/change-password/{vps_id}

Change VPS Password

Change the password for a specific Trading VPS instance.

URL Parameters

  • Name
    vps_id
    Type
    string
    Description

    The unique identifier of the VPS

Request Body

  • Name
    account_password
    Type
    string
    Description

    Your TradeVPS account password for verification

  • Name
    new_password
    Type
    string
    Description

    New password for the VPS (5-255 characters)

Request

POST
/my/trading/vps/change-password/{vps_id}
curl -X POST https://api.tradevps.net/v1/my/trading/vps/change-password/9ead0126-d546-4cfb-b309-47dcf40e3f44 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "account_password": "your-account-password",
    "new_password": "new-vps-password"
  }'

Response

{
  "ok": true,
  "msg": "VPS password changed successfully",
  "data": null
}