Skip to main content

Preview Trade Order

This endpoint allows to preview a trade order without executing it. It returns estimated rates, fees, and other order details.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
Authorization: APIKey {YOUR_API_KEY}

Endpoint

POST

/api/v2/trade/preview

Request Body Sample​

{
"accountId": "00000000-0000-0000-0000-000000000000",
"product": "BTC-USD",
"type": "market",
"side": "buy",
"quantity": "1.5",
"quantityCurrency": "USD"
}

Request Body Schema​

FieldTypeDescription
accountIduuidRequired. The account ID to trade from.
productstringRequired. Product to trade (e.g., BTC-USD).
typestringRequired. Must be set to "market".
sidestringRequired. Side of the trade ("buy" or "sell").
quantitydecimalRequired. Quantity to trade in the currency (must be positive).
quantityCurrencystringRequired. Currency of the quantity. For buy orders: quote currency (e.g., USD). For sell orders: base currency (e.g., BTC).

Response Sample​

{
"previewId": "00000000-0000-0000-0000-000000000000",
"product": "BTC-USD",
"type": "market",
"side": "buy",
"quantity": "100000.00",
"quantityCurrency": "USD",
"estimatedQuoteQuantity": "1.00000000",
"estimatedQuoteCurrency": "BTC",
"estimatedRate": "100000.00",
"estimatedFee": "100.00",
"estimatedFeeCurrency": "USD",
"estimateNetworkFee": "4.50",
"estimateNetworkFeeCurrency": "USD",
"expiresAt": "2025-01-01T12:00:00Z"
}

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!