Precise Execution API

API Introduction

Precise Execution API interfaces are provided for authenticated users, supporting order creation, position management, order status queries, and more. Access the platform via API Key + Signature authentication to place orders and initiate trades.

Quick Start

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)
• Authentication: API Key + Signature
• 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.

Testing Guide: For testing environment, please refer to Testing Guide for order quantity rules and test scenarios.

Multi-Chain Support: The system supports multiple blockchain networks, please refer to Multi-Chain Support for detailed information.

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 (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
	}
}

---

API Overview

Account APIs

• Authorization - API Key + Signature authentication
• Token Address - Query on-chain stock token contract addresses

Market Data APIs

• K-Line Query - Query historical K-line (candlestick) data
• Orderbook - Query real-time orderbook depth data
• Quotes - Query real-time ticker quotes and statistics
• Financials - Query financial indicators and fundamentals
• Basic Information - Query stock basic information and metadata
• Trading Sessions - Query current trading session status
• Spread Tables - Query bid/ask spread data

Order APIs

• Order Signature - Generate off-chain order signature for on-chain verification
• Create Order - Create new buy or sell orders
• Cancel Order - Cancel unfilled orders
• Query Orders - Query order list with various filters
• Query Nonce - Get next available order nonce value
• Estimate Fee - Estimate order fees
• Query Positions - Query held stock token information

Instant Swap APIs

• Overview - Swap mechanism and workflow introduction
• Get Quote - Get real-time buy/sell quote and quote_token
• Build Transaction - Build broadcastable on-chain transaction data
• Query Order Status - Query Swap order status

Corporate Action APIs

• Query Actions - Query corporate action records (triggered / processed) for the Maker
• Process Single - Process a single corporate action

WebSocket

• Order Status Push - Subscribe to real-time order status change notifications
• Market Data Push - Subscribe to real-time market data, including orderbook, K-line, and quote statistics

Risk APIs

• Blacklist Verify - Batch verification of addresses against blacklist

Please refer to the left navigation menu for detailed documentation of each API.

---

Enum Type Descriptions

OrderStatus - Order Status

Enum	Description	Final State	Details
pending	Pending	No	Order created, waiting for Taker to lock. For example, orders waiting for US market opening remain in this state
locked	Locked	No	Order locked by Taker, may be in trading process
partially_filled	Partially filled	Yes	Order partially filled, remaining portion refunded. Usually occurs when user requests cancellation during execution, resulting in partial fill
filled	Fully filled	Yes	Order fully filled
cancelled	Cancelled	Yes	Order cancelled by Maker
expired	Expired	Yes	Order exceeded validity period
rejected	Rejected	Yes	Order validation failed or rejected by Taker, rejection reason typically provided
suspended	Suspended	No	Order suspended, requires manual intervention

Final State Note: States marked as final (Yes) cannot transition to other states.

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

MakerStatus - User Status

Index	Description
1	Active
2	Inactive
3	Suspended

KLineInterval - K-Line Interval

Enum	Description
Minute1	1 minute K
Minute3	3 minute K
Minute5	5 minute K
Minute30	30 minute K
Hour	Hour K
Day	Day K
Week	Week K
Month	Month K
Quarter	Quarter K
Year	Year K

CryptoStatus - Stove Security Token Status

Enum	Description
normal	Normal
suspended	Suspended
circuit_breaker	Circuit Breaker

Session - Trading Session

Enum	Description
unknown	Unknown
pre_market	Pre-market
after_market	After-market
trading	Trading
closed	Closed
pre_opening	Pre-opening auction
closing_auction	Closing auction

Language

Code	Description
zh_tw	Traditional Chinese
en_us	English
ja_jp	Japanese
th_th	Thai
ar_sa	Arabic
nl_nl	Dutch
ko_kr	Korean

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: Defaults to ISO 8601 standard format, e.g., 2025-11-17T03:00:24Z