Skip to content
Patrimoine
v9.1.0

Statistics Endpoint

GET
/api/v1/charts/statistics
curl --request GET \
  --url https://example.com/api/v1/charts/statistics

Portfolio statistics: CAGR, avg, min/max, best/worst month, volatility.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
Any of:
string format: date
to
Any of:
string format: date

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Statistics

Portfolio statistics for a date range.

object
cagr
required
Any of:
number
average
required
Average
string
min_value
required
Min Value
string
min_date
required
Any of:
string
max_value
required
Max Value
string
max_date
required
Any of:
string
best_month
required
Any of:
string
best_month_change
required
Best Month Change
string
worst_month
required
Any of:
string
worst_month_change
required
Worst Month Change
string
volatility
required
Any of:
number
data_points
required
Data Points
integer
consistency_score
Consistency Score
integer
0

Example 

{
  "consistency_score": 0
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}