Pairs

GET 
/pairs

Returns the minimum and maximum deposit amount and the rate for every possible pair of coins listed in the query string.

warning

x-sideshift-secret is your account's private key. Never share it with anyone as it grants full access to your account and should be kept confidential.

info

Use the same commissionRate in this endpoint as when creating the shift/quote to get an accurate rate information.

Request

Header Parameters

x-sideshift-secret stringrequired

Query Parameters

pairs stringrequired

btc-mainnet,usdc-bsc,bch,eth

affiliateId stringrequired
commissionRate string

Responses

200

OK

application/json

Schema

Schema

• Array [

depositCoin stringrequired
settleCoin stringrequired
depositNetwork stringrequired
settleNetwork stringrequired
min stringrequired
max stringrequired
rate stringrequired

• ]

Example

[
  {
    "depositCoin": "BTC",
    "settleCoin": "ETH",
    "depositNetwork": "bitcoin",
    "settleNetwork": "ethereum",
    "min": "0.00010753",
    "max": "1.43368044",
    "rate": "17.291251441744"
  },
  {
    "depositCoin": "ETH",
    "settleCoin": "BTC",
    "depositNetwork": "ethereum",
    "settleNetwork": "bitcoin",
    "min": "0.013802779514",
    "max": "25.27981596",
    "rate": "0.055429074413"
  }
]

500

Internal Server Error

application/json

Schema

Schema

error object
message stringrequired

Examples

{
  "error": {
    "message": "Rate unavailable"
  }
}

{
  "error": {
    "message": "Duplicate coin"
  }
}

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

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

Loading...