Get Account Summary
curl --request GET \
--url https://api-options.sandbox.rails.xyz/account/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-options.sandbox.rails.xyz/account/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-options.sandbox.rails.xyz/account/summary', 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-options.sandbox.rails.xyz/account/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api-options.sandbox.rails.xyz/account/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-options.sandbox.rails.xyz/account/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-options.sandbox.rails.xyz/account/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"availableBalance": "9806.75",
"withdrawableBalance": "9612.50",
"accountBalance": "12500.00",
"marginUsed": "2693.25",
"pnl": "1362.80",
"fees": "-142.60",
"volume": "486000.00",
"unrealizedPnl": "312.40"
}User Account
Get Account Summary
Retrieve account balance, margin usage, and PnL.
GET
/
account
/
summary
Get Account Summary
curl --request GET \
--url https://api-options.sandbox.rails.xyz/account/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-options.sandbox.rails.xyz/account/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-options.sandbox.rails.xyz/account/summary', 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-options.sandbox.rails.xyz/account/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api-options.sandbox.rails.xyz/account/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-options.sandbox.rails.xyz/account/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-options.sandbox.rails.xyz/account/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"availableBalance": "9806.75",
"withdrawableBalance": "9612.50",
"accountBalance": "12500.00",
"marginUsed": "2693.25",
"pnl": "1362.80",
"fees": "-142.60",
"volume": "486000.00",
"unrealizedPnl": "312.40"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
Account summary
Balance available for new orders.
Balance available to withdraw.
Total account balance.
Margin currently in use.
Cumulative realized PnL.
Cumulative fees.
Cumulative traded volume.
Unrealized PnL across open positions.
⌘I