Python (SDK)
from compass_api_sdk import CompassAPI, models
with CompassAPI(
api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:
res = compass_api.sky.sky_sell(token_out=models.SkySellRequestTokenOut.USDC, amount=0.2, chain=models.SkySellRequestChain.ETHEREUM, sender="0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC", estimate_gas=True)
# Handle response
print(res)import { CompassApiSDK } from "@compass-labs/api-sdk";
const compassApiSDK = new CompassApiSDK({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await compassApiSDK.sky.skySell({
tokenOut: "USDC",
amount: 0.2,
chain: "ethereum",
sender: "0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC",
});
console.log(result);
}
run();curl --request POST \
--url https://api.compasslabs.ai/v1/sky/sell \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"chain": "ethereum",
"sender": "0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC",
"token_out": "USDC",
"amount": 0.2
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chain: 'ethereum',
sender: '0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC',
token_out: 'USDC',
amount: 0.2
})
};
fetch('https://api.compasslabs.ai/v1/sky/sell', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.compasslabs.ai/v1/sky/sell",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chain' => 'ethereum',
'sender' => '0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC',
'token_out' => 'USDC',
'amount' => 0.2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.compasslabs.ai/v1/sky/sell"
payload := strings.NewReader("{\n \"chain\": \"ethereum\",\n \"sender\": \"0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC\",\n \"token_out\": \"USDC\",\n \"amount\": 0.2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.compasslabs.ai/v1/sky/sell")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"chain\": \"ethereum\",\n \"sender\": \"0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC\",\n \"token_out\": \"USDC\",\n \"amount\": 0.2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.compasslabs.ai/v1/sky/sell")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chain\": \"ethereum\",\n \"sender\": \"0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC\",\n \"token_out\": \"USDC\",\n \"amount\": 0.2\n}"
response = http.request(request)
puts response.read_body{
"transaction": {
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Sky
Sell USDS
Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
If swapping to DAI, user will need to set an allowance on the USDS contract for the
'SkyDaiUsdsConverter' contract beforehand.
If swapping to USDC, user will need to set an allowance on the USDS contract for the
'SkyUsdcUsdsConverter' contract beforehand.
<Info>
**Required Allowances**
In order to make this transaction, token allowances need to be set for the following contracts.
- `SkyUsdcUsdsConverter`
- `SkyDaiUsdsConverter`
</Info>
POST
/
v1
/
sky
/
sell
Python (SDK)
from compass_api_sdk import CompassAPI, models
with CompassAPI(
api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:
res = compass_api.sky.sky_sell(token_out=models.SkySellRequestTokenOut.USDC, amount=0.2, chain=models.SkySellRequestChain.ETHEREUM, sender="0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC", estimate_gas=True)
# Handle response
print(res)import { CompassApiSDK } from "@compass-labs/api-sdk";
const compassApiSDK = new CompassApiSDK({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await compassApiSDK.sky.skySell({
tokenOut: "USDC",
amount: 0.2,
chain: "ethereum",
sender: "0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC",
});
console.log(result);
}
run();curl --request POST \
--url https://api.compasslabs.ai/v1/sky/sell \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"chain": "ethereum",
"sender": "0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC",
"token_out": "USDC",
"amount": 0.2
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chain: 'ethereum',
sender: '0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC',
token_out: 'USDC',
amount: 0.2
})
};
fetch('https://api.compasslabs.ai/v1/sky/sell', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.compasslabs.ai/v1/sky/sell",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chain' => 'ethereum',
'sender' => '0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC',
'token_out' => 'USDC',
'amount' => 0.2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.compasslabs.ai/v1/sky/sell"
payload := strings.NewReader("{\n \"chain\": \"ethereum\",\n \"sender\": \"0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC\",\n \"token_out\": \"USDC\",\n \"amount\": 0.2\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.compasslabs.ai/v1/sky/sell")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"chain\": \"ethereum\",\n \"sender\": \"0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC\",\n \"token_out\": \"USDC\",\n \"amount\": 0.2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.compasslabs.ai/v1/sky/sell")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chain\": \"ethereum\",\n \"sender\": \"0x0ca38b6Ed5e12bbaf5fAf380c05a806D3a8d1CBC\",\n \"token_out\": \"USDC\",\n \"amount\": 0.2\n}"
response = http.request(request)
puts response.read_body{
"transaction": {
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
Available options:
DAI, USDC Example:
"USDC"
The amount of USDS you would like to sell 1:1 for 'token_out'.
Required range:
x > 0Example:
1.5
Available options:
ethereum Example:
"ethereum"
The address of the transaction sender.
Example:
"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
Allowed value:
"SKY_SELL"Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
Response
Successful Response
The unsigned transaction data. User must sign and broadcast to network.
- UnsignedTransaction
- UserOperationResponse
Show child attributes
Show child attributes
Example:
{
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}
Was this page helpful?