Quick Start

Get from zero to your first API call in under 5 minutes

This guide walks you through making your first BaseVol API call.

Step 1: Create an Account

Connect your wallet at basevol.com and deposit USDC to start trading.

Step 2: Generate an API Key

Go to the API Keys page on the BaseVol dashboard
Click Create API Key
Set a name and select permissions (READ, TRADE)
Optionally configure IP whitelisting
Copy and securely store your API key — it is only shown once

Your API key is only displayed once at creation. Store it securely and never share it publicly.

Step 3: Make Your First Request (Public)

Fetch the list of available products. No authentication required.

curl https://api.basevol.com/api/v1/market/products

Response:

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "BTC",
      ...
    }
  ]
}

Step 4: Make an Authenticated Request

Fetch your account information using the X-API-Key header.

curl -H "X-API-Key: bvk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://api.basevol.com/api/v1/account

const response = await fetch("https://api.basevol.com/api/v1/account", {
  headers: { "X-API-Key": "bvk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" },
});
const data = await response.json();
console.log(data);

Step 5: Place Your First Order

Place a 1-Hour option order. Requires an API key with TRADE permission.

curl -X POST https://api.basevol.com/api/v1/orders/1hour \
  -H "X-API-Key: bvk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "epoch": 1000,
    "productId": 1,
    "strike": 50000,
    "type": "limit",
    "position": "over",
    "unit": 10,
    "price": 50
  }'

import requests

headers = {
    "X-API-Key": "bvk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "Content-Type": "application/json",
}

payload = {
    "epoch": 1000,
    "productId": 1,
    "strike": 50000,
    "type": "limit",
    "position": "over",
    "unit": 10,
    "price": 50,
}

response = requests.post(
    "https://api.basevol.com/api/v1/orders/1hour",
    headers=headers,
    json=payload,
)
print(response.json())

const response = await fetch("https://api.basevol.com/api/v1/orders/1hour", {
  method: "POST",
  headers: {
    "X-API-Key": "bvk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    epoch: 1000,
    productId: 1,
    strike: 50000,
    type: "limit",
    position: "over",
    unit: 10,
    price: 50,
  }),
});
const data = await response.json();
console.log(data);

Next Steps

Authentication API Reference Building a Trading Bot

PreviousAPI NextAuthentication

Last updated 5 months ago