Skip to main content
GET
/
api
/
v1
/
holdings
/
{id}
Retrieve a holding
curl --request GET \
  --url https://app.sure.am/api/v1/holdings/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "qty": 123,
  "price": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "cost_basis_source": "<string>",
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<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",
  "avg_cost": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

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

Path Parameters

​
id
string
required

Holding ID

Response

holding retrieved

​
id
string<uuid>
required
​
date
string<date>
required
​
qty
number<double>
required

Number of units held

​
price
string
required

Formatted price per unit

​
amount
string
required

Formatted total value

​
currency
string
required
​
cost_basis_source
string | null
required

Source of cost basis calculation

​
account
object
required
​
security
object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
avg_cost
string | null

Formatted average cost per unit