Skip to main content
POST
Estimate market order

Authorizations

X-Api-Key
string
header
default:sb_test_your_key
required

API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers.

Body

application/json

Request for a non-binding market-order execution estimate.

pair_id
string
required

Trading pair identifier.

Example:

"USD/NGN"

quantity
string
required

Quantity in base currency.

Example:

"100.00"

side
string
required

Order side: "buy" consumes asks and "sell" consumes bids.

Example:

"buy"

business_bps
integer<int32> | null

Optional partner spread applied to the estimated execution price for a client quote. This does not alter Stabyl execution or fees.

Required range: 0 <= x <= 10000
Example:

25

Response

Market-order estimate

data
object
required

Non-binding market-order execution and partner-quote estimate.

status
enum<string>
required
Available options:
success