action portfoliooptimizer_post_portfolio_analysis_returns_average {
  label: "Arithmetic Average Return"
  description: "Compute the arithmetic average of the arithmetic return(s) of one or several portfolio(s).\n\nReferences\n* [Wikipedia, Arithmetic Average Rate of Return](https://en.wikipedia.org/wiki/Rate_of_return#Arithmetic_average_rate_of_return)\n"
  provider: portfoliooptimizer
  method: POST
  path: "/portfolio/analysis/returns/average"
  encoding: json
  input: {
    type: "object"
    required: ["portfolios"]
    properties: {
      portfolios: {
        type: "array"
        items: {
          type: "object"
          required: ["portfolioValues"]
          properties: {
            portfolioValues: {
              type: "array"
              description: "portfolioValues[t] is the value of the portfolio at the time t"
              items: {
                type: "number"
              }
            }
          }
        }
      }
    }
  }
  output: {
    type: "object"
    required: ["portfolios"]
    properties: {
      portfolios: {
        type: "array"
        items: {
          type: "object"
          required: ["portfolioAverageReturn"]
          properties: {
            portfolioAverageReturn: {
              type: "number"
              description: "The arithmetic average return of the portfolio"
            }
          }
        }
      }
    }
  }
}