Skip to main content
GET
/
extern
/
svr
/
{accountTypeId}
/
account
/
{accountId}
/
returns
Get returns (current balance minus net deposits)
curl --request GET \
  --url https://{host}/extern/svr/{accountTypeId}/account/{accountId}/returns \
  --header 'X-API-Key: <api-key>'
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{host}/extern/svr/{accountTypeId}/account/{accountId}/returns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://{host}/extern/svr/{accountTypeId}/account/{accountId}/returns"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "status": "<string>",
  "data": {
    "accountId": "<string>",
    "current": {},
    "totalDeposited": {},
    "totalWithdrawn": {},
    "netDeposited": {},
    "returns": {},
    "returnsPct": 123
  }
}
{
  "status": "<string>",
  "message": "<string>"
}
{
  "status": "<string>",
  "message": "<string>"
}
{
  "status": "<string>",
  "message": "<string>"
}
{
  "status": "<string>",
  "message": "<string>"
}
{
  "status": "<string>",
  "message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Server-to-server API key

Path Parameters

accountTypeId
string
required
accountId
string<uuid>
required

Response

Success

status
string
required
Allowed value: "success"
data
object
required
Last modified on July 3, 2026