🔌API Reference

Comprehensive REST and WebSocket APIs for integrating with 0QP protocol.

Base URLs

Production

• REST API: https://api.0qp.finance/v1

• WebSocket: wss://ws.0qp.finance/v1

• GraphQL: https://graph.0qp.finance/v1

Testnet

• REST API: https://testnet-api.0qp.finance/v1

• WebSocket: wss://testnet-ws.0qp.finance/v1

Authentication

API Key Authentication

# Include API key in header
curl -H "X-API-Key: your_api_key_here" \
     -H "Content-Type: application/json" \
     https://api.0qp.finance/v1/trading/pairs

Rate Limits

Endpoint Type	Rate Limit	Window
Public Data	100 requests	1 minute
Private Trading	50 requests	1 minute
WebSocket	10 connections	Per IP

Trading Endpoints

Get Trading Pairs

GET /trading/pairs

{
  "success": true,
  "data": [
    {
      "symbol": "0QP_ETH",
      "baseAsset": "0QP",
      "quoteAsset": "ETH",
      "status": "TRADING",
      "price": "0.00123",
      "volume24h": "1234567.89",
      "change24h": "2.45"
    }
  ]
}

Get Order Book

GET /trading/orderbook?symbol=0QP_ETH&limit=100

Response:

{
  "success": true,
  "data": {
    "symbol": "0QP_ETH",
    "bids": [
      ["0.00122", "1000.0"],
      ["0.00121", "2500.0"]
    ],
    "asks": [
      ["0.00124", "800.0"],
      ["0.00125", "1200.0"]
    ]
  }
}

Create order

POST /trading/order

Request:

{
  "symbol": "0QP_ETH",
  "side": "BUY",
  "type": "MARKET",
  "quantity": "100.0"
}

Response:

{
  "success": true,
  "data": {
    "orderId": "12345",
    "symbol": "0QP_ETH",
    "side": "BUY",
    "quantity": "100.0",
    "executedPrice": "0.00123",
    "status": "FILLED",
    "txHash": "0xabc..."
  }
}

Staking Endpoints Get Staking Info

GET /staking/info

Response:

{
  "success": true,
  "data": {
    "totalStaked": "50000000",
    "currentAPY": "14.2",
    "totalRewards": "7500000",
    "stakingRatio": "50.0"
  }
}

Stake Tokens

POST /staking/stake

Request:

{
  "amount": "1000",
  "lockDuration": 90
}

Get User Staking

GET /staking/user/{address}

AI Strategy Endpoints Get Recommendations

GET /ai/recommendations?address={wallet_address}

Response:

{
  "success": true,
  "data": {
    "strategy": "ARBITRAGE",
    "confidence": 0.85,
    "expectedReturn": "2.3",
    "riskScore": "LOW",
    "description": "Cross-chain arbitrage opportunity between ETH and BSC"
  }
}

Execute Strategy

POST /ai/execute

Request:

{
  "strategy": "ARBITRAGE",
  "amount": "1000",
  "riskLevel": "MEDIUM",
  "autoExecute": true
}

WebSocket API Connection

const ws = new WebSocket('wss://ws.0qp.finance/v1');

ws.onopen = function() {
    console.log('Connected to 0QP WebSocket');
};

Subscribe to Price Updates

// Subscribe message
const subscribeMsg = {
    method: 'SUBSCRIBE',
    params: ['0QP_ETH@ticker', '0QP_BTC@ticker']
};
ws.send(JSON.stringify(subscribeMsg));

// Price update response
{
  "stream": "0QP_ETH@ticker",
  "data": {
    "symbol": "0QP_ETH",
    "price": "0.00123",
    "change": "2.45",
    "volume": "1234567"
  }
}

Subscribe to Order Updates

// Requires authentication
const authMsg = {
    method: 'AUTH',
    params: ['your_api_key']
};
ws.send(JSON.stringify(authMsg));

// Subscribe to personal orders
const orderSub = {
    method: 'SUBSCRIBE',
    params: ['orders']
};
ws.send(JSON.stringify(orderSub));

SDKs and Libraries JavaScript/TypeScript SDK

npm install @0qp/sdk

import { ZeroQPClient } from '@0qp/sdk';

const client = new ZeroQPClient({
    apiKey: 'your_api_key',
    network: 'ethereum'
});

// Get trading pairs
const pairs = await client.trading.getPairs();

// Create market order
const order = await client.trading.createOrder({
    symbol: '0QP_ETH',
    side: 'BUY',
    type: 'MARKET',
    quantity: '100'
});

// Stake tokens
const staking = await client.staking.stake({
    amount: '1000',
    lockDuration: 90
});

Python SDK

pip install zqp-python

from zqp import ZQPClient

client = ZQPClient(api_key='your_api_key')

# Get AI recommendations
recommendations = client.ai.get_recommendations(
    wallet='0x...'
)

# Execute trading strategy
result = client.ai.execute_strategy(
    strategy='arbitrage',
    amount=1000,
    risk_level='medium'
)

Error Handling Error Response Format

{
  "success": false,
  "error": {
    "code": 1001,
    "message": "Invalid API key",
    "details": "Please check your API key and try again"
  }
}

Common Error Codes

Common Error Codes

Code	Description	Solution
1001	Invalid API key	Check authentication
1002	Rate limit exceeded	Slow down requests
2001	Insufficient balance	Add funds to wallet
2002	Invalid symbol	Check trading pair
3001	AI service unavailable	Try again later

GraphQL API Endpoint

POST https://graph.0qp.finance/v1/graphql

Example Query

query TradingData($symbol: String!) {
  tradingPair(symbol: $symbol) {
    symbol
    price
    volume24h
    orderBook {
      bids
      asks
    }
  }
  
  userStaking(address: $address) {
    totalStaked
    rewards
    apy
  }
}

Integration Examples Simple Trading Bot

const { ZeroQPClient } = require('@0qp/sdk');

const client = new ZeroQPClient({
    apiKey: process.env.ZQP_API_KEY
});

async function arbitrageBot() {
    const recommendations = await client.ai.getRecommendations();
    
    if (recommendations.strategy === 'ARBITRAGE' && 
        recommendations.confidence > 0.8) {
        
        const result = await client.ai.executeStrategy({
            strategy: 'ARBITRAGE',
            amount: 1000,
            autoExecute: true
        });
        
        console.log('Arbitrage executed:', result);
    }
}

setInterval(arbitrageBot, 30000); // Check every 30 seconds