Skip to main content
GET
/
api
/
v1
/
holdings
List holdings
curl --request GET \
  --url https://app.sure.am/api/v1/holdings \
  --header 'X-Api-Key: <api-key>'
{
  "holdings": [
    {
      "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>"
    }
  ],
  "pagination": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

Authorizations

​
X-Api-Key
string
header
required

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

Query Parameters

​
page
integer

Page number (default: 1)

​
per_page
integer

Items per page (default: 25, max: 100)

​
account_id
string<uuid>

Filter by account ID

​
account_ids
string[]

Filter by multiple account IDs

​
date
string<date>

Filter holdings for an exact date

​
start_date
string<date>

Filter holdings from this date

​
end_date
string<date>

Filter holdings until this date

​
security_id
string<uuid>

Filter by security ID

Response

200 - application/json

holdings listed

​
holdings
object[]
required
​
pagination
object
required