Get Order Estimate

Smart Routing Order Estimate

Smart Routing Order Estimate

GET https://api.sfox.com/v1/offer/:side

Get an estimated execution price for the specified quantity of a given asset using sFOX’s Smart Order Routing, as well as related information. Only use this as an estimate – execution is not guaranteed.

Path Parameters

Name	Type	Description
side*	String	Specifies your order side. Options: buy | sell

Query Parameters

Name	Type	Description
pair	String	The pair or product to trade in the format: (i.e. "btcusd", "ethbtc", "usdteth") Default = btcusd
quantity*	Number	The base currency quantity to buy or sell. quantity OR maxspend are required.
maxspend	Number	The quote currency amount to spend (side = buy) or receive (side = sell). quantity OR maxspend are required.
routing_type	String	The sFOX order book used for the estimate Options: NetPrice | Smart

200: OK Success

{
    "price": 19203.23787426,
    "subtotal": 19202.05116807,
    "fees": 6.72071791, 
    "total": 19208.77188598,
    "quantity": 1,
    "vwap": 19202.05116807,
    "currency_pair": "btcusd",
    "routing_type": "NetPrice"
}

This response is an estimate, not a quote. Prices fluctuate often, therefore, it is possible that an order submitted after receiving this estimate will execute differently. Real-time order book and ticker data is available through SFOX’s Websocket API.

Response Body

VWAP, Price, Fees, and Total are in the quote currency (e.g. USD for a btcusd pair).

Key	Description	Example
price	Estimated order limit price to specify when placing this order to receive the estimated fill price at the time of this request. (Quote Currency)	19203.23787426
subtotal	If side = buy: Estimated cost before fees. If side = sell: Estimated proceeds before fees.	19202.05116807
fees	Estimated fees you would pay in quote currency terms for this order. Note: Authentication required to receive a fees estimate	6.72071791
total	If side = buy: Estimated cost net fees. If side = sell: Estimated proceeds net fees.	19208.77188598
quantity	The base currency quantity applicable to the estimate. Equal to the quantity parameter in the request.	1
vwap	Estimated fill price you would receive at the time of this request. (Quote currency terms)	19202.05116807
currency_pair	Trading pair / symbol	"btcusd"
routing_type	sFOX order book used for this estimate	"NetPrice"

Example Request

Shell

curl 'https://api.sfox.com/v1/offer/buy?quantity=1&pair=btcusd'

NodeJS

const axios = require('axios');

axios({
  method: 'get',
  url: 'https://api.sfox.com/v1/offer/buy',
  params: {
    quantity: 1,
    pair: 'btcusd' 
  }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});

Python

import requests

data = requests.get(
  "https://api.sfox.com/v1/offer/buy",
  headers={
    "Authorization": "Bearer <API_KEY>",
  },
  params={
    "quantity": 1,
    "pair": "btcusd"
  }
)
print(data)