Withdraw collateral
curl --request POST \
--url https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1,
"collateralIndex": 1,
"collateralMint": "<string>",
"expectedLoanValues": {
"expectedApy": 1,
"expectedLqt": [
1
]
},
"loan": "<string>",
"assetIndexGuidance": [
1
],
"lockLoan": true,
"skipClose": true,
"stakeInstructions": {
"amount": 1,
"vault": "<string>",
"stakeAccount": "<string>"
}
}
'import requests
url = "https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw"
payload = {
"amount": 1,
"collateralIndex": 1,
"collateralMint": "<string>",
"expectedLoanValues": {
"expectedApy": 1,
"expectedLqt": [1]
},
"loan": "<string>",
"assetIndexGuidance": [1],
"lockLoan": True,
"skipClose": True,
"stakeInstructions": {
"amount": 1,
"vault": "<string>",
"stakeAccount": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1,
collateralIndex: 1,
collateralMint: '<string>',
expectedLoanValues: {expectedApy: 1, expectedLqt: [1]},
loan: '<string>',
assetIndexGuidance: [1],
lockLoan: true,
skipClose: true,
stakeInstructions: {amount: 1, vault: '<string>', stakeAccount: '<string>'}
})
};
fetch('https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw', 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://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw",
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([
'amount' => 1,
'collateralIndex' => 1,
'collateralMint' => '<string>',
'expectedLoanValues' => [
'expectedApy' => 1,
'expectedLqt' => [
1
]
],
'loan' => '<string>',
'assetIndexGuidance' => [
1
],
'lockLoan' => true,
'skipClose' => true,
'stakeInstructions' => [
'amount' => 1,
'vault' => '<string>',
'stakeAccount' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw"
payload := strings.NewReader("{\n \"amount\": 1,\n \"collateralIndex\": 1,\n \"collateralMint\": \"<string>\",\n \"expectedLoanValues\": {\n \"expectedApy\": 1,\n \"expectedLqt\": [\n 1\n ]\n },\n \"loan\": \"<string>\",\n \"assetIndexGuidance\": [\n 1\n ],\n \"lockLoan\": true,\n \"skipClose\": true,\n \"stakeInstructions\": {\n \"amount\": 1,\n \"vault\": \"<string>\",\n \"stakeAccount\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"collateralIndex\": 1,\n \"collateralMint\": \"<string>\",\n \"expectedLoanValues\": {\n \"expectedApy\": 1,\n \"expectedLqt\": [\n 1\n ]\n },\n \"loan\": \"<string>\",\n \"assetIndexGuidance\": [\n 1\n ],\n \"lockLoan\": true,\n \"skipClose\": true,\n \"stakeInstructions\": {\n \"amount\": 1,\n \"vault\": \"<string>\",\n \"stakeAccount\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1,\n \"collateralIndex\": 1,\n \"collateralMint\": \"<string>\",\n \"expectedLoanValues\": {\n \"expectedApy\": 1,\n \"expectedLqt\": [\n 1\n ]\n },\n \"loan\": \"<string>\",\n \"assetIndexGuidance\": [\n 1\n ],\n \"lockLoan\": true,\n \"skipClose\": true,\n \"stakeInstructions\": {\n \"amount\": 1,\n \"vault\": \"<string>\",\n \"stakeAccount\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"signatures": [
{
"publicKey": "<string>",
"signature": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}Borrowing
Withdraw collateral
Withdraws collateral from an existing loan. Full collateral removal may include internal weight-matrix and loan-lock handling before the transaction is returned.
POST
/
markets
/
creditbook
/
collateral
/
withdraw
Withdraw collateral
curl --request POST \
--url https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw \
--header 'Content-Type: application/json' \
--data '
{
"amount": 1,
"collateralIndex": 1,
"collateralMint": "<string>",
"expectedLoanValues": {
"expectedApy": 1,
"expectedLqt": [
1
]
},
"loan": "<string>",
"assetIndexGuidance": [
1
],
"lockLoan": true,
"skipClose": true,
"stakeInstructions": {
"amount": 1,
"vault": "<string>",
"stakeAccount": "<string>"
}
}
'import requests
url = "https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw"
payload = {
"amount": 1,
"collateralIndex": 1,
"collateralMint": "<string>",
"expectedLoanValues": {
"expectedApy": 1,
"expectedLqt": [1]
},
"loan": "<string>",
"assetIndexGuidance": [1],
"lockLoan": True,
"skipClose": True,
"stakeInstructions": {
"amount": 1,
"vault": "<string>",
"stakeAccount": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 1,
collateralIndex: 1,
collateralMint: '<string>',
expectedLoanValues: {expectedApy: 1, expectedLqt: [1]},
loan: '<string>',
assetIndexGuidance: [1],
lockLoan: true,
skipClose: true,
stakeInstructions: {amount: 1, vault: '<string>', stakeAccount: '<string>'}
})
};
fetch('https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw', 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://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw",
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([
'amount' => 1,
'collateralIndex' => 1,
'collateralMint' => '<string>',
'expectedLoanValues' => [
'expectedApy' => 1,
'expectedLqt' => [
1
]
],
'loan' => '<string>',
'assetIndexGuidance' => [
1
],
'lockLoan' => true,
'skipClose' => true,
'stakeInstructions' => [
'amount' => 1,
'vault' => '<string>',
'stakeAccount' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw"
payload := strings.NewReader("{\n \"amount\": 1,\n \"collateralIndex\": 1,\n \"collateralMint\": \"<string>\",\n \"expectedLoanValues\": {\n \"expectedApy\": 1,\n \"expectedLqt\": [\n 1\n ]\n },\n \"loan\": \"<string>\",\n \"assetIndexGuidance\": [\n 1\n ],\n \"lockLoan\": true,\n \"skipClose\": true,\n \"stakeInstructions\": {\n \"amount\": 1,\n \"vault\": \"<string>\",\n \"stakeAccount\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"collateralIndex\": 1,\n \"collateralMint\": \"<string>\",\n \"expectedLoanValues\": {\n \"expectedApy\": 1,\n \"expectedLqt\": [\n 1\n ]\n },\n \"loan\": \"<string>\",\n \"assetIndexGuidance\": [\n 1\n ],\n \"lockLoan\": true,\n \"skipClose\": true,\n \"stakeInstructions\": {\n \"amount\": 1,\n \"vault\": \"<string>\",\n \"stakeAccount\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tars.loopscale.com/v1/markets/creditbook/collateral/withdraw")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1,\n \"collateralIndex\": 1,\n \"collateralMint\": \"<string>\",\n \"expectedLoanValues\": {\n \"expectedApy\": 1,\n \"expectedLqt\": [\n 1\n ]\n },\n \"loan\": \"<string>\",\n \"assetIndexGuidance\": [\n 1\n ],\n \"lockLoan\": true,\n \"skipClose\": true,\n \"stakeInstructions\": {\n \"amount\": 1,\n \"vault\": \"<string>\",\n \"stakeAccount\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"signatures": [
{
"publicKey": "<string>",
"signature": "<string>"
}
]
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}{
"error": {
"code": 400,
"message": "Request could not be processed."
}
}Headers
Optional idempotency key; a retried write with the same key replays the original response
Body
application/json
Required range:
x >= 0Required range:
x >= 0Expected loan economics the borrower signs off on, checked on-chain against the freshly-priced values to bound slippage.
Show child attributes
Show child attributes
Per-collateral oracle asset-index guidance (one byte per collateral slot).
Required range:
x >= 0Show child attributes
Show child attributes
⌘I