Quick Start Guide

Get up and running with the Market VPSBot API in minutes.

Step 1: Get Your API Key

1. Log in to your account at market.vpsbot.io
2. Navigate to API Keys management
3. Create a new API key with a descriptive name

Save the returned api_key value securely. See the Authentication Guide for details.

Step 2: Browse Items

Fetch all items currently for sale:

Node.js

const axios = require('axios');

const client = axios.create({
  baseURL: 'https://market.vpsbot.io/api',
  headers: { 'x-api-key': 'YOUR_API_KEY' }
});

async function listItems() {
  const { data } = await client.get('/items', {
    params: { game_id: 730 }
  });
  console.log(`Found ${data.data.length} items for sale`);
  return data.data;
}

listItems();

cURL

curl -X GET "https://market.vpsbot.io/api/items?game_id=730" \
  -H "x-api-key: YOUR_API_KEY"

Step 3: Search for Specific Items

Find items by market hash name:

Node.js

async function searchItems() {
  const { data } = await client.post('/items/search', {
    market_hash_names: ['AK-47 | Redline (Field-Tested)'],
    phases: null
  });
  console.log('Search results:', data.data);
  return data.data;
}

searchItems();

cURL

curl -X POST "https://market.vpsbot.io/api/items/search" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"market_hash_names": ["AK-47 | Redline (Field-Tested)"]}'

Step 4: Buy an Item

Purchase an item by asset ID:

Node.js

async function buyItem() {
  const { data } = await client.post('/items/buy', {
    asset_id: '12345678901',
    game_id: 730,
    trade_url: 'https://steamcommunity.com/tradeoffer/new/?partner=XXXXX&token=YYYYY',
    price: 1500,
    custom_id: 'my-order-001'
  });
  console.log('Trade created:', data.data);
  return data.data;
}

buyItem();

cURL

curl -X POST "https://market.vpsbot.io/api/items/buy" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "12345678901",
    "game_id": 730,
    "trade_url": "https://steamcommunity.com/tradeoffer/new/?partner=XXXXX&token=YYYYY",
    "price": 1500,
    "custom_id": "my-order-001"
  }'

Step 5: Track Your Trades

Check the status of your trades:

Node.js

async function getTrades() {
  const { data } = await client.get('/trades', {
    params: {
      limit: 10,
      offset: 0
    }
  });
  console.log(`Total trades: ${data.data.total}`);
  data.data.trades.forEach(t => {
    console.log(`Trade ${t.trade_id}: ${t.status}`);
  });
}

getTrades();

cURL

curl -X GET "https://market.vpsbot.io/api/trades?limit=10&offset=0" \
  -H "x-api-key: YOUR_API_KEY"

Step 6: Check Your Balance

Node.js

async function getBalance() {
  const { data } = await client.get('/wallet/balance');
  console.log(`Balance: ${data.data.balance}`);
  console.log(`Frozen: ${data.data.frozen_balance}`);
}

getBalance();

cURL

curl -X GET "https://market.vpsbot.io/api/wallet/balance" \
  -H "x-api-key: YOUR_API_KEY"

Next Steps

• Review the Items API for all available item operations
• Check the Trades API for trade history and filtering
• Explore the Deprecated API Backward Compatibility if migrating from the deprecated API
• Read the Authentication Guide for detailed auth options

For support, contact us via Telegram.