Retrieve holding

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

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

fetch('https://app.sure.am/api/v1/holdings/{id}', 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/holdings/{id}",
  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/holdings/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/holdings/{id}")

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "qty": "<string>",
  "price": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>",
    "status": "<string>"
  },
  "security": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ticker": "<string>",
    "name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cost_basis_source": "<string>",
  "avg_cost": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

GET

api

holdings

{id}

Retrieve holding

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

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

fetch('https://app.sure.am/api/v1/holdings/{id}', 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/holdings/{id}",
  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/holdings/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/holdings/{id}")

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "qty": "<string>",
  "price": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>",
    "status": "<string>"
  },
  "security": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ticker": "<string>",
    "name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cost_basis_source": "<string>",
  "avg_cost": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Authorizations

X-Api-Key

string

header

required

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

Path Parameters

string

required

Holding ID

Response

holding retrieved

string<uuid>

required

date

string<date>

required

qty

string

required

Quantity of shares held

price

string

required

Formatted price per share

amount

string

required

currency

string

required

account

object

required

Show child attributes

security

object

required

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

cost_basis_source

string | null

avg_cost

string | null

⌘I

Auth

Accounts

Balance Sheet

Balances

Budget Categories

Budgets

Categories

Chats

Family Exports

Family Settings

Holdings

Import Sessions

Imports

Merchants

Provider Connections

Recurring Transactions

Rejected Transfers

Rule Runs

Rules

Securities

Security Prices

Sync

Tags

Trades

Transactions

Transfers

Valuations

Users

Retrieve holding

Authorizations

Path Parameters

Response