API Reference

Complete reference for all BaseVol API v1 endpoints.

Base URL

https://api.basevol.com/api/v1

Response Format

All successful responses follow this structure:

{
  "success": true,
  "data": { ... }
}

Paginated responses include additional pagination info:

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "size": 10,
    "totalCount": 50,
    "totalPages": 5
  }
}

Endpoint Overview

Public Endpoints (No Authentication)

Method	Endpoint	Description
GET	/market/products	List all products
GET	/market/products/:productId	Get product by ID
GET	/market/time	Get server time
GET	/rounds/1hour/current	Current 1-hour epoch
GET	/rounds/1hour	Get 1-hour round
GET	/rounds/1hour/products	1-hour products with rounds
GET	/rounds/1day/current	Current 1-day epoch
GET	/rounds/1day	Get 1-day round
GET	/rounds/1day/products	1-day products with rounds

Authenticated Endpoints (API Key Required)

Method	Endpoint	Permission	Description
GET	/account	READ	Get account info
GET	/account/balance	READ	Get balance
GET	/account/api-usage	READ	Get API usage stats
GET	/orders/1hour/position	READ	Get 1-hour positions
GET	/orders/1hour/position/filled	READ	Get 1-hour filled positions
POST	/orders/1hour	TRADE	Place 1-hour order
DELETE	/orders/1hour	TRADE	Cancel 1-hour order
POST	/orders/1hour/close-position	TRADE	Close 1-hour position
GET	/orders/1day/position	READ	Get 1-day positions
GET	/orders/1day/position/filled	READ	Get 1-day filled positions
POST	/orders/1day	TRADE	Place 1-day order
DELETE	/orders/1day	TRADE	Cancel 1-day order
POST	/orders/1day/close-position	TRADE	Close 1-day position

Detailed References

Market DataRoundsOrdersAccount