Get balance sheet

Returns the family’s net worth, total assets, and total liabilities in the family’s primary currency.

GET /api/v1/balance_sheet

Get balance sheet

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/balance_sheet \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://app.sure.am/api/v1/balance_sheet"

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

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

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.sure.am/api/v1/balance_sheet', 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://app.sure.am/api/v1/balance_sheet",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sure.am/api/v1/balance_sheet"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/balance_sheet")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/balance_sheet")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "currency": "<string>",
  "net_worth": {},
  "assets": {},
  "liabilities": {}
}

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Response

200 - application/json

balance sheet data

currency · string · required

The family's primary currency code

net_worth · object · required

Net worth as a Money object

assets · object · required

Total assets as a Money object

liabilities · object · required

Total liabilities as a Money object