Aladdin Studio · Schema

OrderRequest

Request body for creating a new trading order

FinancialInvestment ManagementPortfolio AnalyticsRisk ManagementAsset ManagementBlackRockData Cloud

Properties

Name Type Description
portfolioId string Portfolio identifier
securityId string Security identifier
side string Order side
quantity number Order quantity
orderType string Order type
limitPrice number Limit price (required for limit orders)
View JSON Schema on GitHub

JSON Schema

aladdin-studio-trading-order-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aladdin-studio/refs/heads/main/json-schema/aladdin-studio-trading-order-request-schema.json",
  "title": "OrderRequest",
  "description": "Request body for creating a new trading order",
  "type": "object",
  "properties": {
    "portfolioId": {
      "type": "string",
      "description": "Portfolio identifier",
      "example": "PF-123456"
    },
    "securityId": {
      "type": "string",
      "description": "Security identifier",
      "example": "US0378331005"
    },
    "side": {
      "type": "string",
      "description": "Order side",
      "enum": [
        "buy",
        "sell"
      ],
      "example": "buy"
    },
    "quantity": {
      "type": "number",
      "description": "Order quantity",
      "example": 100
    },
    "orderType": {
      "type": "string",
      "description": "Order type",
      "enum": [
        "market",
        "limit",
        "stop"
      ],
      "example": "market"
    },
    "limitPrice": {
      "type": "number",
      "description": "Limit price (required for limit orders)",
      "example": 195.0
    }
  },
  "required": [
    "portfolioId",
    "securityId",
    "side",
    "quantity"
  ]
}