Public API

API Introduction

Public API interfaces are open to all users and can be accessed without authentication. These interfaces provide platform statistics, orderbook information, and ticker statistics, offering transparent market data access for all users.

Basic Information

• Test Environment: https://api-qa.proto.stove.finance
• Production Environment: https://proto.stove.finance
• Content-Type: application/json
• Data Format: JSON (snake_case naming convention)
• Multi-Chain Support: Supports multiple blockchain networks, each identified by chain_id
• Default Network: BSC (Binance Smart Chain), chain_id = 56

Note: API examples show relative paths (e.g., /api/v1/orders). Prepend the environment URL when making actual requests.

Unified Response Format

All interfaces follow a unified response structure:

Field	Type	Description
code	int	Result code, 0 indicates success, non-0 indicates error
message	string	Error message, brief description (returned only on error)
details	string	Additional error information (returned only on error)
data	object	Business data (returned only on success)

Success Response Example:

{
	"code": 0,
	"data": {
		// Specific business data
	}
}

Error Response Example:

{
	"code": 400001,
	"message": "Invalid parameter",
	"details": "The wallet_address field is required"
}

---

API Overview

Public API provides the following main features:

• Platform Statistics - Query platform user count, order count, and stock token count
• Ticker Statistics - Query basic information and trading statistics for stocks
• Ticker Heatmap - Query heatmap data for popular market stocks

Please click the left navigation bar to view detailed documentation for each interface.

---

Enum Type Descriptions

Exchange - Exchange Code

Index	Description
0	U.S Stock Exchange
1	Hong Kong Stock Exchange
3	South Korea Stock Exchange

Market - Market Code

Enum	Description
usex	US Stock Market
hkex	Hong Kong Stock Market
krex	South Korea Stock Market

KLineInterval - K-Line Interval

Enum	Description
minute1	1 minute
minute3	3 minutes
minute5	5 minutes
minute30	30 minutes
hour	1 hour
day	1 day
week	1 week
month	1 month
quarter	1 quarter
year	1 year

Notes

• Data Format: All interfaces use snake_case naming convention
• Amount Precision: Amount fields use string type to avoid precision loss
• Address Format: Ethereum addresses must include 0x prefix
• Time Format: Unless otherwise specified, time format defaults to ISO 8601 standard format, e.g., 2025-11-17T03:00:24Z