Synthetic Books
Refresh a Synthetic Book lease
Refreshes an unexpired lease owned by the authenticated user. Refresh every five minutes; a lease expires after ten minutes and an expired lease must be recreated.
POST
/
v1
/
synthetics
/
subscriptions
/
{subscription_id}
/
refresh
Refresh a Synthetic Book lease
curl --request POST \
--url https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-Secret: <api-key>' \
--header 'X-Client-Id: <api-key>'import requests
url = "https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh"
headers = {
"X-Client-Id": "<api-key>",
"X-Api-Key": "<api-key>",
"X-Api-Secret": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Client-Id': '<api-key>',
'X-Api-Key': '<api-key>',
'X-Api-Secret': '<api-key>'
}
};
fetch('https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh', 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://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Api-Secret: <api-key>",
"X-Client-Id: <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"
"net/http"
"io"
)
func main() {
url := "https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Client-Id", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Api-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh")
.header("X-Client-Id", "<api-key>")
.header("X-Api-Key", "<api-key>")
.header("X-Api-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["X-Api-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"refreshed": true,
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"synthetic_id": "<string>",
"expires_at_ms": 123,
"ttl_ms": 600000
}{
"error": "Insufficient scope",
"code": "<string>"
}{
"error": "Insufficient scope",
"code": "<string>"
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}Authorizations
Credential client id (kairos_ck_...). Must be sent together with X-Api-Key and X-Api-Secret.
64-char hex API key.
64-char hex API secret.
Path Parameters
Was this page helpful?
⌘I
Refresh a Synthetic Book lease
curl --request POST \
--url https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-Secret: <api-key>' \
--header 'X-Client-Id: <api-key>'import requests
url = "https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh"
headers = {
"X-Client-Id": "<api-key>",
"X-Api-Key": "<api-key>",
"X-Api-Secret": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Client-Id': '<api-key>',
'X-Api-Key': '<api-key>',
'X-Api-Secret': '<api-key>'
}
};
fetch('https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh', 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://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Api-Secret: <api-key>",
"X-Client-Id: <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"
"net/http"
"io"
)
func main() {
url := "https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Client-Id", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Api-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh")
.header("X-Client-Id", "<api-key>")
.header("X-Api-Key", "<api-key>")
.header("X-Api-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://execution.kairos.trade/v1/synthetics/subscriptions/{subscription_id}/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["X-Api-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"refreshed": true,
"subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"synthetic_id": "<string>",
"expires_at_ms": 123,
"ttl_ms": 600000
}{
"error": "Insufficient scope",
"code": "<string>"
}{
"error": "Insufficient scope",
"code": "<string>"
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}{
"error": "synthetic_books_unavailable",
"message": "<string>",
"details": {}
}
