Quickstart

Prerequisites

API access requires the Scale plan. You'll need access to the VantageKit dashboard to generate an API key.

Generate an API key

Go to Settings > API Keys in your VantageKit dashboard and click Create API Key.

Save your key

Your API key starts with vk_live_ and is only shown once. Copy it immediately and store it in an environment variable — never commit it to source code.

Make your first request

List your deal rooms with a single API call:

cURL

curl -s https://api.vantagekit.com/v1/deal-rooms \
  -H "Authorization: Bearer vk_live_YOUR_API_KEY" | jq

fetch.js

const response = await fetch('https://api.vantagekit.com/v1/deal-rooms', {
  headers: {
    'Authorization': 'Bearer vk_live_YOUR_API_KEY',
  },
})

if (!response.ok) {
  const error = await response.json()
  console.error(`API error ${response.status}: ${error.error?.message}`)
  process.exit(1)
}

const { data, meta } = await response.json()
console.log(`Found ${meta.pagination.total} deal rooms`)

request.py

import requests

response = requests.get(
    'https://api.vantagekit.com/v1/deal-rooms',
    headers={'Authorization': 'Bearer vk_live_YOUR_API_KEY'},
)
response.raise_for_status()

result = response.json()
print(f"Found {result['meta']['pagination']['total']} deal rooms")

Understand the response

Every response follows the same envelope:

Response envelope

{
  "data": [ ... ],
  "meta": {
    "apiVersion": "2026-04-01",
    "pagination": {
      "page": 1,
      "perPage": 20,
      "total": 3,
      "totalPages": 1
    }
  }
}