Create Holding Endpoint

POST

/api/v1/investments/holdings

curl --request POST \
  --url https://example.com/api/v1/investments/holdings \
  --header 'Content-Type: application/json' \
  --data '{ "ticker": "example", "name": "example", "quantity": 1, "cost_basis": 1, "fee": "0", "purchase_date": "2026-04-15", "account_id": 1, "current_price": 1, "currency": "example", "asset_class": "stock", "price_source": "example", "current_price_updated_at": "2026-04-15T12:00:00Z", "notes": "example" }'

Request Body^required

Media typeapplication/json

HoldingCreate

object

ticker

required

Ticker

string

>= 1 characters <= 20 characters

name

Any of:

string

string

<= 200 characters

null

null

quantity

required

Any of:

number

number

string

string

cost_basis

required

Any of:

number

number

string

string

fee

Any of:

number

number

string

string

purchase_date

required

Purchase Date

string format: date

account_id

required

Account Id

integer

current_price

Any of:

number

number

string

string

null

null

currency

Any of:

string

string

/^[A-Z]{3}$/

null

null

asset_class

Any of:

string

string

Allowed values: stock etf bond crypto cash real_estate commodity other

null

null

price_source

Any of:

string

string

null

null

current_price_updated_at

Any of:

string

string format: date-time

null

null

notes

Any of:

string

string

<= 2000 characters

null

null

Responses

201

Successful Response

Media typeapplication/json

HoldingOut

object

id

required

Id

integer

user_id

required

User Id

integer

account_id

required

Any of:

integer

integer

null

null

ticker

required

Ticker

string

name

required

Any of:

string

string

null

null

quantity

required

Quantity

string

cost_basis

required

Cost Basis

string

fee

required

Fee

string

total_cost

required

Total Cost

string

purchase_date

required

Purchase Date

string format: date

current_price

required

Any of:

string

string

null

null

currency

required

Any of:

string

string

null

null

asset_class

required

Any of:

string

string

null

null

price_source

required

Any of:

string

string

null

null

current_price_updated_at

required

Any of:

string

string format: date-time

null

null

notes

required

Any of:

string

string

null

null

value_base_currency

Any of:

string

string

null

null

price_gain_base_currency

Any of:

string

string

null

null

fx_gain_base_currency

Any of:

string

string

null

null

fx_rate

Any of:

string

string

null

null

cost_base_currency

Any of:

string

string

null

null

dividends_base_currency

Any of:

string

string

null

null

dividends

Dividends

Array<object>

default:

DividendOut

object

id

required

Id

integer

holding_id

required

Holding Id

integer

amount

required

Amount

string

ex_date

required

Ex Date

string format: date

pay_date

required

Any of:

string

string format: date

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

Example

{
  "dividends": []
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}