Upvest · JSON Structure

Investment Api Portfolio Create Structure

Request body for creating a portfolio.

Type: object Properties: 3 Required: 3
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

PortfolioCreate is a JSON Structure definition published by Upvest, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

account_id name allocations

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-portfolio-create-structure.json",
  "name": "PortfolioCreate",
  "description": "Request body for creating a portfolio.",
  "type": "object",
  "properties": {
    "account_id": {
      "type": "uuid",
      "description": "The account to create the portfolio for.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "name": {
      "type": "string",
      "description": "The portfolio name.",
      "example": "Example Name"
    },
    "allocations": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Request body for defining a portfolio allocation.",
        "required": [
          "instrument_id",
          "weight"
        ],
        "properties": {
          "instrument_id": {
            "type": "uuid",
            "description": "The instrument to allocate to.",
            "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
          },
          "weight": {
            "type": "string",
            "description": "The target weight as a decimal string between 0 and 1.",
            "example": "example-value"
          }
        }
      },
      "description": "The initial target allocations.",
      "example": [
        {
          "instrument_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "weight": "example-value"
        }
      ]
    }
  },
  "required": [
    "account_id",
    "name",
    "allocations"
  ]
}