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
faceValue
number
required

Face Value ($)

Required range: 0.01 <= x <= 100000000
years
number
required

Years to Maturity

Required range: 1 <= x <= 100
calcType
enum<string>

Solve For

Available options:
price,
ytm
rate
number

Annual Yield / Discount Rate (%)

Required range: 0 <= x <= 100
currentPrice
number

Current Market Price ($)

Required range: 0.01 <= x <= 100000000
compound
enum<string>

Compounding Frequency

Available options:
1,
2,
4,
12,
365,
continuous
currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
AUD,
JPY,
CAD

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.