Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
mode
enum<string>

Input Mode

Available options:
summary,
series
portfolioReturn
number

Portfolio Annual Return (%)

riskFreeRate
number

Risk-Free Rate (%)

stdDev
number

Standard Deviation of Returns (%)

Required range: x >= 0.0001
returns
string

Periodic Returns (%, comma or newline separated)

periodsPerYear
enum<string>

Return Frequency

Available options:
1,
4,
12,
52,
252
riskFreeRateSeries
number

Annual Risk-Free Rate (%)

sampleStdDev
boolean

Use sample standard deviation (n − 1)

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.