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.
{
"$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"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.