Request quote

POST 
/quotes

For fixed rate shifts, a quote should be requested first.

A quote can be requested for either a depositAmount or a settleAmount.

When defining non-native tokens like AXS and USDT for depositCoin and/or settleCoin, the depositNetwork and settleNetwork fields must also be specified. This also applies to native tokens like ETH that supports multiple networks.

commissionRate optional parameter can be used to offer a better rate for your users by reducing the affiliate commission paid by SideShift.

If the API requests are sent from the integrations own server, the x-user-ip header must be set to the end-user IP address. Otherwise the requests will be blocked. See Permissions.

After the quote request, a fixed rate shift should be created using the `id` returned by the /quotes endpoint.

A quote expires after 15 minutes.

info

x-sideshift-secret is your account's private key.

Request

Header Parameters

x-sideshift-secret stringrequired
x-user-ip string

end-user IP address for integrations API requests

application/json

Body

depositCoin stringrequired
depositNetwork string

required for non-native tokens (e.g. AXS, USDT) and multi-network native tokens (e.g. ETH).

settleCoin stringrequired
settleNetwork string

required for non-native tokens (e.g. AXS, USDT) and multi-network native tokens (e.g. ETH).

depositAmount stringnullablerequired

if null, settleAmount is required

settleAmount stringnullablerequired

if null, depositAmount is required

affiliateId stringrequired

Responses

201

OK

application/json

Schema

Schema

id stringrequired
createdAt stringrequired
depositCoin stringrequired
settleCoin stringrequired
depositNetwork stringrequired
settleNetwork stringrequired
expiresAt stringrequired
depositAmount stringrequired
settleAmount stringrequired
rate stringrequired
affiliateId string

Example

{
  "id": "c1d79240-0117-4867-afed-9cc4605c53aa",
  "createdAt": "2023-10-17T03:33:21.230Z",
  "depositCoin": "ETH",
  "settleCoin": "ETH",
  "depositNetwork": "arbitrum",
  "settleNetwork": "ethereum",
  "expiresAt": "2023-10-17T03:48:21.230Z",
  "depositAmount": "0.14364577",
  "settleAmount": "0.14078454",
  "rate": "0.980081348723",
  "affiliateId": "YQMi62XMb"
}

400

Bad Request

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Bad request"
  }
}

{
  "error": {
      "message": "Bad request: Invalid parameters: depositCoin"
  }
}

{
  "error": {
      "message": "Method ETH/bitcoin not found"
  }
}

{
  "error": {
      "message": "Invalid "affiliateId""
  }
}

{
  "error": {
      "message": "Commission rate cannot be higher than 0.005"
  }
}

{
  "error": {
      "message": "Invalid parameters: commissionRate: Must be a positive number"
  }
}

401

Unauthorized

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Do not use the example affiliateId and x-sideshift-secret header from the documentation. Use your own from https://sideshift.ai/account"
  }
}

403

Forbidden

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Access denied. See https://sideshift.ai/access-denied"
  }
}

404

Not Found

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Account not found"
  }
}

500

Internal Server Error

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Invalid coin"
  }
}

{
  "error": {
      "message": "Invalid network"
  }
}

{
  "error": {
      "message": "Amount too low"
  }
}

{
  "error": {
      "message": "Amount too high"
  }
}

{
  "error": {
      "message": "Cannot specify both depositAmount and settleAmount"
  }
}

Loading...