Request quote
POST/quotes
For fixed rate shifts, a quote should be requested first.
Some networks only support variable rate shifts. Check depositVariableOnly and settleVariableOnly on /v2/coins before requesting a quote.
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. depositCoin can also be a token contract address for the selected depositNetwork when you need to target a specific token implementation.
When a quote is created with a contract address in depositCoin, the response will normalize depositCoin back to the canonical asset ticker, such as USDC.
commissionRate optional parameter can be used to adjust rates for your users. The default commission rate is 0.5%. Rates below the default offer better rates by reducing affiliate commission, while rates above the default are passed on to the user. The maximum commission rate is 2%.
Use the same commissionRate in the /v2/pair and /v2/pairs endpoints as when creating the shift/quotes to get an accurate rate information. See Monetization for detailed examples of how commission rates affect rates.
If the API requests are sent from the integration’s 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 /v2/quotes endpoint.
A quote expires after 15 minutes.
Authenticate by signing the request or with the legacy x-sideshift-secret header. Your Ed25519 secret key and your account secret each grant full access to your account. Never share them.
Request
Header Parameters
Your Ed25519 public key, hex encoded. Required when signing the request. See Authentication.
Current Unix time in milliseconds, the same value used in the signed message. Must be within 60 seconds of server time. Required when signing the request.
Ed25519 signature of timestamp + METHOD + path + body, hex encoded. Required when signing the request. See Authentication.
Legacy account secret. Not needed when the request is signed with the x-sideshift-key, x-sideshift-timestamp and x-sideshift-signature headers. See Authentication.
end-user IP address for integrations API requests
- application/json
Body
ticker or token contract address for the selected depositNetwork
required for non-native tokens (e.g. AXS, USDT) and multi-network native tokens (e.g. ETH).
required for non-native tokens (e.g. AXS, USDT) and multi-network native tokens (e.g. ETH).
if null, settleAmount is required
if null, depositAmount is required
Responses
- 201
- 400
- 401
- 403
- 404
- 500
- application/json
- Schema
- Example
Schema
{
"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"
}
- application/json
- Schema
- Example
Schema
error object
{
"error": {
"message": "Bad request",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Bad request: Invalid parameters: depositCoin",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Method ETH/bitcoin not found",
"code": "METHOD_NOT_FOUND"
}
}
{
"error": {
"message": "Invalid "affiliateId"",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Commission rate cannot be higher than 0.02",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Invalid parameters: commissionRate: Must be a positive number",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Only variable orders can be created for this deposit method",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Only variable orders can be created for this settle method",
"code": "BAD_USER_INPUT"
}
}
- application/json
- Schema
- Example
Schema
error object
{
"error": {
"message": "Do not use the example affiliateId and x-sideshift-secret header from the documentation. Use your own from https://sideshift.ai/account",
"code": "SESSION_REQUIRED"
}
}
- application/json
- Schema
- Example
Schema
error object
{
"error": {
"message": "Access denied. See https://sideshift.ai/access-denied",
"code": "ACCESS_DENIED"
}
}
- application/json
- Schema
- Example
Schema
error object
{
"error": {
"message": "Account not found",
"code": "NOT_FOUND"
}
}
- application/json
- Schema
- Example
Schema
error object
{
"error": {
"message": "Invalid coin",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Invalid network",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Amount too low. Settle amount is less than or equals to 0",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Amount too low. Minimum deposit amount: 0.00010663.",
"depositRangeMin": "0.00010663",
"code": "QUOTE_UNAVAILABLE"
}
}
{
"error": {
"message": "Amount too high. Maximum deposit amount: 0.5117083972",
"depositRangeMax": "0.5117083972",
"code": "QUOTE_UNAVAILABLE"
}
}
{
"error": {
"message": "Cannot specify both depositAmount and settleAmount",
"code": "BAD_USER_INPUT"
}
}
{
"error": {
"message": "Deposit method quote unavailable",
"code": "QUOTE_UNAVAILABLE"
}
}
{
"error": {
"message": "Settle method quote unavailable",
"code": "QUOTE_UNAVAILABLE"
}
}
{
"error": {
"message": "Deposit method unavailable",
"code": "SHIFT_UNAVAILABLE"
}
}
{
"error": {
"message": "Settle method unavailable",
"code": "SHIFT_UNAVAILABLE"
}
}