Quick Start Guide

Create an Account

Sign up for PaperExchange to get your 3-day free trial. No credit card required. Payment required after trial to continue.

Generate an API Key

Go to your dashboard and create an API key. Give it a descriptive name like "Trading Bot" or "Strategy Test".

Make Your First Request

Test your API key by fetching market prices:

curl -X POST https://api.paperx.co/v1/exchanges/hyperliquid/info \
  -H "Content-Type: application/json" \
  -H "X-API-Key: pe_your_api_key" \
  -d '{"type": "allMids"}'

import requests

API_KEY = "pe_your_api_key"
BASE_URL = "https://api.paperx.co"

# Get all mid prices
response = requests.post(
    f"{BASE_URL}/v1/exchanges/hyperliquid/info",
    headers={"X-API-Key": API_KEY},
    json={"type": "allMids"}
)

prices = response.json()
print("BTC: $" + prices['BTC'])
print("ETH: $" + prices['ETH'])

const API_KEY = "pe_your_api_key";
const BASE_URL = "https://api.paperx.co";

// Get all mid prices
const response = await fetch(`${BASE_URL}/v1/exchanges/hyperliquid/info`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": API_KEY,
  },
  body: JSON.stringify({ type: "allMids" }),
});

const prices = await response.json();
console.log(`BTC: $${prices.BTC}`);

Place Your First Trade

Now let's place a paper trade. This example buys 0.01 BTC:

import requests

API_KEY = "pe_your_api_key"
BASE_URL = "https://api.paperx.co"

# Place a limit buy order for BTC
response = requests.post(
    f"{BASE_URL}/v1/exchanges/hyperliquid/exchange",
    headers={"X-API-Key": API_KEY},
    json={
        "action": {
            "type": "order",
            "orders": [{
                "a": 0,           # Asset index (0 = BTC)
                "b": True,        # Buy
                "p": "85000",     # Limit price
                "s": "0.01",      # Size
                "r": False,       # Not reduce-only
                "t": {"limit": {"tif": "Gtc"}}  # Good till cancel
            }]
        }
    }
)

result = response.json()
print(result)

# Check if filled
if "filled" in str(result):
    print("Order filled!")
elif "resting" in str(result):
    print("Order resting on book")

Check Your Position

After your trade fills, check your account state:

# Get account state
response = requests.post(
    f"{BASE_URL}/v1/exchanges/hyperliquid/info",
    headers={"X-API-Key": API_KEY},
    json={"type": "clearinghouseState"}
)

state = response.json()
print("Account Value: $" + state['marginSummary']['accountValue'])
print("Withdrawable: $" + state['withdrawable'])

# Print positions
for pos in state.get('assetPositions', []):
    p = pos['position']
    print(p['coin'] + ": " + p['szi'] + " @ " + p['entryPx'])