Upvest · JSON Structure

Investment Api Position Structure

A holding of a financial instrument within an account.

Type: object Properties: 8
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Position is a JSON Structure definition published by Upvest, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id account_id instrument_id quantity average_buy_in_price currency created_at updated_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-structure/investment-api-position-structure.json",
  "name": "Position",
  "description": "A holding of a financial instrument within an account.",
  "type": "object",
  "properties": {
    "id": {
      "type": "uuid",
      "description": "The unique identifier of the position.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "account_id": {
      "type": "uuid",
      "description": "The account the position belongs to.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "instrument_id": {
      "type": "uuid",
      "description": "The instrument held.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "quantity": {
      "type": "string",
      "description": "The quantity of shares held as a decimal string.",
      "example": "example-value"
    },
    "average_buy_in_price": {
      "type": "string",
      "description": "The average buy-in price as a decimal string.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The position currency.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the position was first established.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "description": "When the position was last updated.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}