Skip to main content
GET
/
investors
/
{investor_id}
/
positions
/
{position_id}
Retrieve a specific position
curl --request GET \
  --url https://api.bluumfinance.com/v1/investors/{investor_id}/positions/{position_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "object": "investor",
  "livemode": false,
  "id": "inv_01j9x8m2k7qpzwv3t5r6y8n0ab",
  "created": 1747776000,
  "metadata": {},
  "investor_id": "inv_01j9x8m2k7qpzwv3t5r6y8n0ab",
  "symbol": "AAPL",
  "asset_id": "<string>",
  "class": "equity",
  "country": "us",
  "currency": "USD",
  "quantity": "10.5",
  "average_cost_basis": "175.50",
  "total_cost_basis": "1842.75",
  "current_price": "180.00",
  "market_value": "1890.00",
  "unrealized_pl": "47.25",
  "unrealized_pl_percent": "2.56",
  "price_timestamp": "2023-11-07T05:31:56Z",
  "last_transaction_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Path Parameters

​
investor_id
string
required

Prefixed public id of the investor (e.g. inv_…).

​
position_id
string
required

Prefixed public id of the position (e.g. pos_…).

Query Parameters

​
refresh_prices
boolean
default:true

Response

Position retrieved.

Envelope-wrapped position resource.

​
object
string
required

The resource type discriminator.

Example:

"investor"

​
livemode
boolean
required

Whether this resource was created against a live API key. Test-mode keys always return false.

Example:

false

​
id
string

Prefixed public id (e.g. inv_…, ord_…, dep_…).

Example:

"inv_01j9x8m2k7qpzwv3t5r6y8n0ab"

​
created
integer | null

Unix-seconds timestamp of resource creation.

Example:

1747776000

​
metadata
object

Partner-set key/value map for cross-referencing.

​
investor_id
string

Prefixed public id of the owning investor.

Example:

"inv_01j9x8m2k7qpzwv3t5r6y8n0ab"

​
symbol
string
Example:

"AAPL"

​
asset_id
string
​
class
enum<string>

Canonical instrument class of the held asset.

Available options:
equity,
etf,
bond,
bill,
note,
mutual_fund,
derivative,
cryptocurrency,
commodity,
real_estate,
cash
Example:

"equity"

​
country
string | null

ISO 3166-1 alpha-2 country code (lower-case). Null for country-agnostic instruments.

Example:

"us"

​
currency
string
Example:

"USD"

​
quantity
string
Example:

"10.5"

​
average_cost_basis
string
Example:

"175.50"

​
total_cost_basis
string
Example:

"1842.75"

​
current_price
string
Example:

"180.00"

​
market_value
string
Example:

"1890.00"

​
unrealized_pl
string
Example:

"47.25"

​
unrealized_pl_percent
string
Example:

"2.56"

​
price_source
enum<string>
Available options:
ALPACA,
NAYA,
DATABASE,
UNAVAILABLE
​
price_confidence
enum<string>
Available options:
REAL_TIME,
DELAYED,
END_OF_DAY,
STALE,
UNAVAILABLE
​
price_timestamp
string<date-time> | null
​
last_transaction_at
string<date-time> | null
​
updated_at
string<date-time>