BRAINIAC Options Analytics is an MCP server published by software.brainiac, hosted at www.brainiac.software. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 15 tools, including options-analytics_black-scholes-greeks, options-analytics_implied-volatility-solve, options-analytics_american-binomial-price, options-analytics_strategy-payoff, options-analytics_probability-of-profit.
Paid Options Analytics API via x402. Unpaid tool calls return 402.
650 connections through 4 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Price a European option with Black-Scholes-Merton and return delta, gamma, vega, theta, rho, vanna and charm from caller-supplied spot, strike, time, rate, dividend yield and volatility when pricing or analysing an option. Pure computation with a high-accuracy normal CDF. Call with type, spot, strike, timeYears, and sigma; optional rate, dividendYield, greeks, dayCount. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, type, spot, strike, timeYears, sigma, rate, dividendYield, dayCount, price, delta, gamma, vega, vegaPer1Pct, theta.
| Parameter | Type | Description |
|---|---|---|
| rate | number | rate, number, from -0.2 to 1. Required. |
| spot * | number | spot, number. Required. |
| type * | string | type, string, one of call, put. Required. |
| sigma * | number | sigma, number, from any to 5. Required. |
| greeks | array | greeks, array. Required. |
| strike * | number | strike, number. Required. |
| dayCount | string | dayCount, string, one of ACT/365, ACT/360, TRADING/252. Required. |
| timeYears * | number | timeYears, number, from 0 to 50. Required. |
| dividendYield | number | dividendYield, number, from -0.2 to 1. Required. |
{
"name": "options-analytics_black-scholes-greeks",
"title": "Price a European option and its Greeks",
"description": "Price a European option with Black-Scholes-Merton and return delta, gamma, vega, theta, rho, vanna and charm from caller-supplied spot, strike, time, rate, dividend yield and volatility when pricing or analysing an option. Pure computation with a high-accuracy normal CDF. Call with type, spot, strike, timeYears, and sigma; optional rate, dividendYield, greeks, dayCount. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, type, spot, strike, timeYears, sigma, rate, dividendYield, dayCount, price, delta, gamma, vega, vegaPer1Pct, theta.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"spot",
"strike",
"timeYears",
"sigma"
],
"properties": {
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"call",
"put"
],
"type": "string",
"description": "type, string, one of call, put. Required."
},
"sigma": {
"type": "number",
"maximum": 5,
"description": "sigma, number, from any to 5. Required.",
"exclusiveMinimum": 0
},
"greeks": {
"type": "array",
"items": {
"enum": [
"delta",
"gamma",
"vega",
"theta",
"rho",
"vanna",
"charm"
],
"type": "string",
"description": "item, string, one of delta, gamma, vega, theta, rho, vanna. Required."
},
"default": [
"delta",
"gamma",
"vega",
"theta",
"rho",
"vanna",
"charm"
],
"description": "greeks, array. Required."
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"dayCount": {
"enum": [
"ACT/365",
"ACT/360",
"TRADING/252"
],
"type": "string",
"default": "ACT/365",
"description": "dayCount, string, one of ACT/365, ACT/360, TRADING/252. Required."
},
"timeYears": {
"type": "number",
"maximum": 50,
"minimum": 0,
"description": "timeYears, number, from 0 to 50. Required."
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"d1": {
"type": "number",
"description": "d1. Number."
},
"d2": {
"type": "number",
"description": "d2. Number."
},
"rho": {
"type": "number",
"description": "rho. Number."
},
"vega": {
"type": "number",
"description": "vega. Number."
},
"charm": {
"type": "number",
"description": "charm. Number."
},
"delta": {
"type": "number",
"description": "delta. Number."
},
"gamma": {
"type": "number",
"description": "gamma. Number."
},
"model": {
"type": "string",
"description": "model. String."
},
"price": {
"type": "number",
"description": "price. Number."
},
"theta": {
"type": "number",
"description": "theta. Number."
},
"vanna": {
"type": "number",
"description": "vanna. Number."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"type": {
"type": "string",
"description": "type. String."
},
"sigma": {
"type": "number",
"description": "sigma. Number."
},
"strike": {
"type": "number",
"description": "strike. Number."
},
"dayCount": {
"type": "string",
"description": "dayCount. String."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"dividendYield": {
"type": "number",
"description": "dividendYield. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"thetaPerDay": {
"type": "number",
"description": "thetaPerDay. Number."
},
"vegaPer1Pct": {
"type": "number",
"description": "vegaPer1Pct. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Price a European option and its Greeks",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Solve implied volatility for 1 to 500 option prices with Newton and Brent root-finding on Black-Scholes-Merton, or on a Cox-Ross-Rubinstein tree for American options when pricing or analysing an option. Prices outside the no-arbitrage bounds return a status instead of a number. Call with spot and options; optional style, rate, dividendYield, treeSteps. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, style, rate, dividendYield, treeSteps, results, model, inputsUsed, Solve implied volatility for option prices, implied volatility solve.
| Parameter | Type | Description |
|---|---|---|
| rate | number | rate, number, from -0.2 to 1. Required. |
| spot * | number | spot, number. Required. |
| style | string | style, string, one of european, american. Required. |
| options * | array | options, array. Required. |
| treeSteps | integer | treeSteps, integer, from 50 to 2000. Required. |
| dividendYield | number | dividendYield, number, from -0.2 to 1. Required. |
Price an American or European option on a Cox-Ross-Rubinstein tree with optional discrete cash dividends (escrowed method), and return tree delta, gamma, theta, the early-exercise boundary and the Black-Scholes-Merton European value for comparison when pricing or analysing an option. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, type, spot, strike, timeYears, sigma, style, rate, dividendYield, steps, dividends, price, europeanPrice, delta, gamma.
| Parameter | Type | Description |
|---|---|---|
| rate | number | rate, number, from -0.2 to 1. Required. |
| spot * | number | spot, number. Required. |
| type * | string | type, string, one of call, put. Required. |
| sigma * | number | sigma, number, from any to 5. Required. |
| steps | integer | steps, integer, from 1 to 5000. Required. |
| style | string | style, string, one of american, european. Required. |
| strike * | number | strike, number. Required. |
| dividends | array |
Compute payoff and profit or loss of a multi-leg option and stock position at expiry and at a valuation date, with exact breakevens, maximum profit and loss, and unlimited-risk flags when pricing or analysing an option. Call with spot and legs; optional rate, dividendYield, multiplier, valuationTimeYears, grid. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: CISA KEV, known exploited, KEV catalog, when pricing or analysing an option, spot, legs, rate, dividendYield, multiplier, valuationTimeYears, grid, netPremium, breakevens, maxProfit, maxLoss.
| Parameter | Type | Description |
|---|---|---|
| grid | object | grid, object. Optional. |
| legs * | array | legs, array. Required. |
| rate | number | rate, number, from -0.2 to 1. Required. |
| spot * | number | spot, number. Required. |
| multiplier | number | multiplier, number. Required. |
| dividendYield | number | dividendYield, number, from -0.2 to 1. Required. |
| valuationTimeYears | any | valuationTimeYears, value. Optional. |
Compute lognormal probabilities of finishing above or below levels, touching a level before expiry, and finishing in profit for a strategy given its breakevens, under risk-neutral or real-world drift. Call with spot, sigma, and timeYears; optional rate, dividendYield, measure, drift, levels, breakevens and others. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: CISA KEV, known exploited, KEV catalog, when pricing or analysing an option, spot, sigma, timeYears, rate, dividendYield, measure, drift, levels, breakevens, profitAbove, profitBetween.
| Parameter | Type | Description |
|---|---|---|
| rate | number | rate, number, from -0.2 to 1. Required. |
| spot * | number | spot, number. Required. |
| drift | any | drift, value. Optional. |
| sigma * | number | sigma, number, from any to 5. Required. |
| levels | array | levels, array. Required. |
| measure | string | measure, string, one of risk_neutral, real_world. Required. |
| timeYears * | number | timeYears, number, from any to 50. Required. |
| breakevens | array |
Compute IV rank and IV percentile of the current implied volatility against caller-supplied history over a trailing window of observations when pricing or analysing an option. Call with current and history; optional windowDays. Returns ivRank, rankNote, ivPercentile, min, max, current, observations, window, model, and inputsUsed (window includes from, to). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, current, history, windowDays, ivRank, rankNote, ivPercentile, min, max, observations, window, model, inputsUsed, Compute IV rank and IV percentile, iv rank percentile.
| Parameter | Type | Description |
|---|---|---|
| current * | number | current, number. Required. |
| history * | array | history, array. Required. |
| windowDays | integer | windowDays, integer, from 5 to 2520. Required. |
{
"name": "options-analytics_iv-rank-percentile",
"title": "Compute IV rank and IV percentile",
"description": "Compute IV rank and IV percentile of the current implied volatility against caller-supplied history over a trailing window of observations when pricing or analysing an option. Call with current and history; optional windowDays. Returns ivRank, rankNote, ivPercentile, min, max, current, observations, window, model, and inputsUsed (window includes from, to). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, current, history, windowDays, ivRank, rankNote, ivPercentile, min, max, observations, window, model, inputsUsed, Compute IV rank and IV percentile, iv rank percentile.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"current",
"history"
],
"properties": {
"current": {
"type": "number",
"description": "current, number. Required.",
"exclusiveMinimum": 0
},
"history": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"iv"
],
"properties": {
"iv": {
"type": "number",
"description": "iv, number. Required.",
"exclusiveMinimum": 0
},
"date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "date, string, date. Required."
}
},
"description": "item, object. Required."
},
"description": "history, array. Required."
},
"windowDays": {
"type": "integer",
"default": 252,
"maximum": 2520,
"minimum": 5,
"description": "windowDays, integer, from 5 to 2520. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"max": {
"type": "number",
"description": "max. Number."
},
"min": {
"type": "number",
"description": "min. Number."
},
"model": {
"type": "string",
"description": "model. String."
},
"ivRank": {
"type": "number",
"description": "ivRank. Number."
},
"window": {
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "to. String."
},
"from": {
"type": "string",
"description": "from. String."
}
},
"description": "window. Object.",
"additionalProperties": {}
},
"current": {
"type": "number",
"description": "current. Number."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"rankNote": {
"type": "null",
"description": "rankNote. Null."
},
"inputsUsed": {
"type": "object",
"properties": {
"windowDays": {
"type": "number",
"description": "windowDays. Number."
},
"historyPoints": {
"type": "number",
"description": "historyPoints. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"ivPercentile": {
"type": "number",
"description": "ivPercentile. Number."
},
"observations": {
"type": "number",
"description": "observations. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute IV rank and IV percentile",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Compute close-to-close, Parkinson, Garman-Klass, Rogers-Satchell and Yang-Zhang realised volatility from OHLC bars, optionally excluding flagged days and returning a rolling series when pricing or analysing an option. Call with bars; optional estimators, annualization, window. Returns close_to_close, parkinson, garman_klass, rogers_satchell, yang_zhang, observations, excluded. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, bars, estimators, annualization, window, close to close, close_to_close, parkinson, garman klass, garman_klass, rogers satchell, rogers_satchell, yang zhang, yang_zhang, observations.
| Parameter | Type | Description |
|---|---|---|
| bars * | array | bars, array. Required. |
| window | any | window, value. Optional. |
| estimators | array | estimators, array. Required. |
| annualization | integer | annualization, integer, from 1 to 366. Required. |
{
"name": "options-analytics_historical-volatility",
"title": "Compute realised volatility from OHLC bars",
"description": "Compute close-to-close, Parkinson, Garman-Klass, Rogers-Satchell and Yang-Zhang realised volatility from OHLC bars, optionally excluding flagged days and returning a rolling series when pricing or analysing an option. Call with bars; optional estimators, annualization, window. Returns close_to_close, parkinson, garman_klass, rogers_satchell, yang_zhang, observations, excluded. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, bars, estimators, annualization, window, close to close, close_to_close, parkinson, garman klass, garman_klass, rogers satchell, rogers_satchell, yang zhang, yang_zhang, observations.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bars"
],
"properties": {
"bars": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"open",
"high",
"low",
"close"
],
"properties": {
"low": {
"type": "number",
"description": "low, number. Required.",
"exclusiveMinimum": 0
},
"date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "date, string, date. Required."
},
"high": {
"type": "number",
"description": "high, number. Required.",
"exclusiveMinimum": 0
},
"open": {
"type": "number",
"description": "open, number. Required.",
"exclusiveMinimum": 0
},
"close": {
"type": "number",
"description": "close, number. Required.",
"exclusiveMinimum": 0
},
"exclude": {
"type": "boolean",
"default": false,
"description": "exclude, boolean. Required."
}
},
"description": "item, object. Required."
},
"description": "bars, array. Required."
},
"window": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 3
},
{
"type": "null"
}
],
"description": "window, value. Optional."
},
"estimators": {
"type": "array",
"items": {
"enum": [
"close_to_close",
"parkinson",
"garman_klass",
"rogers_satchell",
"yang_zhang"
],
"type": "string",
"description": "item, string, one of close_to_close, parkinson, garman_klass, rogers_satchell, yang_zhang. Required."
},
"default": [
"close_to_close",
"parkinson",
"garman_klass",
"rogers_satchell",
"yang_zhang"
],
"description": "estimators, array. Required."
},
"annualization": {
"type": "integer",
"default": 252,
"maximum": 366,
"minimum": 1,
"description": "annualization, integer, from 1 to 366. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"rolling": {
"type": "null",
"description": "rolling. Null."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"excluded": {
"type": "number",
"description": "excluded. Number."
},
"parkinson": {
"type": "number",
"description": "parkinson. Number."
},
"inputsUsed": {
"type": "object",
"properties": {
"window": {
"type": "null",
"description": "window. Null."
},
"barCount": {
"type": "number",
"description": "barCount. Number."
},
"estimators": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "estimators. Array."
},
"annualization": {
"type": "number",
"description": "annualization. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"yang_zhang": {
"type": "number",
"description": "yang_zhang. Number."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"garman_klass": {
"type": "number",
"description": "garman_klass. Number."
},
"observations": {
"type": "number",
"description": "observations. Number."
},
"close_to_close": {
"type": "number",
"description": "close_to_close. Number."
},
"rogers_satchell": {
"type": "number",
"description": "rogers_satchell. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute realised volatility from OHLC bars",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Fit a raw-SVI slice per expiry to strike implied volatilities with the Zeliade quasi-explicit method, interpolate the surface in total variance, and report butterfly and calendar static-arbitrage violations when pricing or analysing an option. Call with forwardByExpiry and points; optional query. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, forwardByExpiry, points, query, slices, calendarArbitrage, model, inputsUsed, Fit an SVI volatility surface, volatility surface fit.
| Parameter | Type | Description |
|---|---|---|
| query | array | query, array. Optional. |
| points * | array | points, array. Required. |
| forwardByExpiry * | object | forwardByExpiry, object. Required. |
{
"name": "options-analytics_volatility-surface-fit",
"title": "Fit an SVI volatility surface",
"description": "Fit a raw-SVI slice per expiry to strike implied volatilities with the Zeliade quasi-explicit method, interpolate the surface in total variance, and report butterfly and calendar static-arbitrage violations when pricing or analysing an option. Call with forwardByExpiry and points; optional query. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, forwardByExpiry, points, query, slices, calendarArbitrage, model, inputsUsed, Fit an SVI volatility surface, volatility surface fit.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"forwardByExpiry",
"points"
],
"properties": {
"query": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeYears",
"strike"
],
"properties": {
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"timeYears": {
"type": "number",
"description": "timeYears, number. Required.",
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"description": "query, array. Optional."
},
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeYears",
"strike",
"iv"
],
"properties": {
"iv": {
"type": "number",
"maximum": 10,
"description": "iv, number, from any to 10. Required.",
"exclusiveMinimum": 0
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"timeYears": {
"type": "number",
"maximum": 50,
"description": "timeYears, number, from any to 50. Required.",
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"description": "points, array. Required."
},
"forwardByExpiry": {
"type": "object",
"description": "forwardByExpiry, object. Required.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"iv": {
"type": "number",
"description": "iv. Number."
},
"strike": {
"type": "number",
"description": "strike. Number."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "query. Array."
},
"slices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"params": {
"type": "object",
"properties": {
"a": {
"type": "number",
"description": "a. Number."
},
"b": {
"type": "number",
"description": "b. Number."
},
"m": {
"type": "number",
"description": "m. Number."
},
"rho": {
"type": "number",
"description": "rho. Number."
},
"sigma": {
"type": "number",
"description": "sigma. Number."
}
},
"description": "params. Object.",
"additionalProperties": {}
},
"rmseIv": {
"type": "number",
"description": "rmseIv. Number."
},
"status": {
"type": "string",
"description": "status. String."
},
"forward": {
"type": "number",
"description": "forward. Number."
},
"rawPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"iv": {
"type": "number",
"description": "iv. Number."
},
"strike": {
"type": "number",
"description": "strike. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "rawPoints. Array."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"butterflyArbitrage": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "butterflyArbitrage. Array."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "slices. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"expiries": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "expiries. Array."
},
"pointCount": {
"type": "number",
"description": "pointCount. Number."
},
"queryCount": {
"type": "number",
"description": "queryCount. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"calendarArbitrage": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "calendarArbitrage. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Fit an SVI volatility surface",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Infer the implied forward and carry from call and put quote pairs, solve the rate by least squares when omitted, and flag pairs whose bid and ask break the European or American parity band when pricing or analysing an option. Call with spot, timeYears, and pairs; optional style, rate, toleranceAbs. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, timeYears, pairs, style, rate, toleranceAbs, impliedForward, impliedCarry, impliedRate, model, inputsUsed, Check put-call parity and implied forward, put call parity check.
| Parameter | Type | Description |
|---|---|---|
| rate | any | rate, value. Optional. |
| spot * | number | spot, number. Required. |
| pairs * | array | pairs, array. Required. |
| style | string | style, string, one of european, american. Required. |
| timeYears * | number | timeYears, number, from any to 50. Required. |
| toleranceAbs | number | toleranceAbs, number, from 0 to any. Required. |
Compute the one and two standard deviation expected move and price ranges from implied volatility or from the at-the-money straddle price when pricing or analysing an option. Call with spot and daysToExpiry; optional iv, straddlePrice, dayBasis. Returns oneSigma, twoSigma, range1, range2, method, ivFromStraddle, model, and inputsUsed. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, daysToExpiry, straddlePrice, dayBasis, oneSigma, twoSigma, range1, range2, method, ivFromStraddle, model, inputsUsed, Compute market-implied expected move, expected move.
| Parameter | Type | Description |
|---|---|---|
| iv | any | iv, value. Optional. |
| spot * | number | spot, number. Required. |
| dayBasis | any | dayBasis, value. Required. |
| daysToExpiry * | number | daysToExpiry, number, from any to 3650. Required. |
| straddlePrice | any | straddlePrice, value. Optional. |
{
"name": "options-analytics_expected-move",
"title": "Compute market-implied expected move",
"description": "Compute the one and two standard deviation expected move and price ranges from implied volatility or from the at-the-money straddle price when pricing or analysing an option. Call with spot and daysToExpiry; optional iv, straddlePrice, dayBasis. Returns oneSigma, twoSigma, range1, range2, method, ivFromStraddle, model, and inputsUsed. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, daysToExpiry, straddlePrice, dayBasis, oneSigma, twoSigma, range1, range2, method, ivFromStraddle, model, inputsUsed, Compute market-implied expected move, expected move.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spot",
"daysToExpiry"
],
"properties": {
"iv": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "iv, value. Optional."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"dayBasis": {
"anyOf": [
{
"type": "number",
"const": 365
},
{
"type": "number",
"const": 252
}
],
"default": 365,
"description": "dayBasis, value. Required."
},
"daysToExpiry": {
"type": "number",
"maximum": 3650,
"description": "daysToExpiry, number, from any to 3650. Required.",
"exclusiveMinimum": 0
},
"straddlePrice": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "straddlePrice, value. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"method": {
"type": "string",
"description": "method. String."
},
"range1": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "range1. Array."
},
"range2": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "range2. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"oneSigma": {
"type": "number",
"description": "oneSigma. Number."
},
"twoSigma": {
"type": "number",
"description": "twoSigma. Number."
},
"inputsUsed": {
"type": "object",
"properties": {
"spot": {
"type": "number",
"description": "spot. Number."
},
"dayBasis": {
"type": "number",
"description": "dayBasis. Number."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"daysToExpiry": {
"type": "number",
"description": "daysToExpiry. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"ivFromStraddle": {
"type": "null",
"description": "ivFromStraddle. Null."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute market-implied expected move",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Compute 25-delta risk reversal, butterfly, skew slope and term-structure slope from strike and implied volatility quotes by expiry, with linear interpolation in log-moneyness and no extrapolation when pricing or analysing an option. Call with spot and expiries; optional rate, dividendYield, deltaConvention. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, expiries, rate, dividendYield, deltaConvention, termSlope, model, inputsUsed, Compute 25-delta skew metrics, skew metrics.
| Parameter | Type | Description |
|---|---|---|
| rate | number | rate, number, from -0.2 to 1. Required. |
| spot * | number | spot, number. Required. |
| expiries * | array | expiries, array. Required. |
| dividendYield | number | dividendYield, number, from -0.2 to 1. Required. |
| deltaConvention | string | deltaConvention, string, one of spot, forward. Required. |
{
"name": "options-analytics_skew-metrics",
"title": "Compute 25-delta skew metrics",
"description": "Compute 25-delta risk reversal, butterfly, skew slope and term-structure slope from strike and implied volatility quotes by expiry, with linear interpolation in log-moneyness and no extrapolation when pricing or analysing an option. Call with spot and expiries; optional rate, dividendYield, deltaConvention. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, expiries, rate, dividendYield, deltaConvention, termSlope, model, inputsUsed, Compute 25-delta skew metrics, skew metrics.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spot",
"expiries"
],
"properties": {
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"expiries": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeYears",
"points"
],
"properties": {
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"strike",
"iv"
],
"properties": {
"iv": {
"type": "number",
"maximum": 10,
"description": "iv, number, from any to 10. Required.",
"exclusiveMinimum": 0
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"description": "points, array. Required."
},
"timeYears": {
"type": "number",
"maximum": 50,
"description": "timeYears, number, from any to 50. Required.",
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"description": "expiries, array. Required."
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
},
"deltaConvention": {
"enum": [
"spot",
"forward"
],
"type": "string",
"default": "spot",
"description": "deltaConvention, string, one of spot, forward. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"expiries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"atmIv": {
"type": "number",
"description": "atmIv. Number."
},
"notes": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "notes. Array."
},
"put25dIv": {
"type": "number",
"description": "put25dIv. Number."
},
"call25dIv": {
"type": "number",
"description": "call25dIv. Number."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"butterfly25": {
"type": "number",
"description": "butterfly25. Number."
},
"put25dStrike": {
"type": "number",
"description": "put25dStrike. Number."
},
"call25dStrike": {
"type": "number",
"description": "call25dStrike. Number."
},
"riskReversal25": {
"type": "number",
"description": "riskReversal25. Number."
},
"skewSlopePerLogMoneyness": {
"type": "number",
"description": "skewSlopePerLogMoneyness. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "expiries. Array."
},
"termSlope": {
"type": "null",
"description": "termSlope. Null."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"expiryCount": {
"type": "number",
"description": "expiryCount. Number."
},
"dividendYield": {
"type": "number",
"description": "dividendYield. Number."
},
"deltaConvention": {
"type": "string",
"description": "deltaConvention. String."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute 25-delta skew metrics",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Aggregate share delta, dollar delta, gamma, vega, theta per day and beta-weighted delta across option and stock positions, computing Black-Scholes-Merton Greeks unless the caller supplies them when pricing or analysing an option. Call with benchmarkSpot and positions. Returns byUnderlying, total, model, and inputsUsed. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, benchmarkSpot, positions, byUnderlying, total, model, inputsUsed, Aggregate portfolio option Greeks, position greeks aggregate.
| Parameter | Type | Description |
|---|---|---|
| positions * | array | positions, array. Required. |
| benchmarkSpot * | number | benchmarkSpot, number. Required. |
{
"name": "options-analytics_position-greeks-aggregate",
"title": "Aggregate portfolio option Greeks",
"description": "Aggregate share delta, dollar delta, gamma, vega, theta per day and beta-weighted delta across option and stock positions, computing Black-Scholes-Merton Greeks unless the caller supplies them when pricing or analysing an option. Call with benchmarkSpot and positions. Returns byUnderlying, total, model, and inputsUsed. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, benchmarkSpot, positions, byUnderlying, total, model, inputsUsed, Aggregate portfolio option Greeks, position greeks aggregate.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"benchmarkSpot",
"positions"
],
"properties": {
"positions": {
"type": "array",
"items": {
"type": "object",
"required": [
"underlying",
"spot",
"kind",
"qty"
],
"properties": {
"qty": {
"type": "number",
"description": "qty, number. Required."
},
"beta": {
"type": "number",
"default": 1,
"description": "beta, number. Required."
},
"kind": {
"enum": [
"option",
"stock"
],
"type": "string",
"description": "kind, string, one of option, stock. Required."
},
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"call",
"put"
],
"type": "string",
"description": "type, string, one of call, put. Optional."
},
"vega": {
"type": "number",
"description": "vega, number. Optional."
},
"delta": {
"type": "number",
"description": "delta, number. Optional."
},
"gamma": {
"type": "number",
"description": "gamma, number. Optional."
},
"sigma": {
"type": "number",
"maximum": 5,
"description": "sigma, number, from any to 5. Optional.",
"exclusiveMinimum": 0
},
"theta": {
"type": "number",
"description": "theta, number. Optional."
},
"strike": {
"type": "number",
"description": "strike, number. Optional.",
"exclusiveMinimum": 0
},
"timeYears": {
"type": "number",
"maximum": 50,
"minimum": 0,
"description": "timeYears, number, from 0 to 50. Optional."
},
"multiplier": {
"type": "number",
"description": "multiplier, number. Optional.",
"exclusiveMinimum": 0
},
"underlying": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "underlying, string, length 1 to 32. Required."
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
}
},
"description": "item, object. Required."
},
"description": "positions, array. Required."
},
"benchmarkSpot": {
"type": "number",
"description": "benchmarkSpot, number. Required.",
"exclusiveMinimum": 0
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"total": {
"type": "object",
"properties": {
"vega": {
"type": "number",
"description": "vega. Number."
},
"gamma": {
"type": "number",
"description": "gamma. Number."
},
"shareDelta": {
"type": "number",
"description": "shareDelta. Number."
},
"dollarDelta": {
"type": "number",
"description": "dollarDelta. Number."
},
"thetaPerDay": {
"type": "number",
"description": "thetaPerDay. Number."
},
"betaWeightedDelta": {
"type": "number",
"description": "betaWeightedDelta. Number."
}
},
"description": "total. Object.",
"additionalProperties": {}
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"benchmarkSpot": {
"type": "number",
"description": "benchmarkSpot. Number."
},
"positionCount": {
"type": "number",
"description": "positionCount. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"byUnderlying": {
"type": "array",
"items": {
"type": "object",
"properties": {
"vega": {
"type": "number",
"description": "vega. Number."
},
"gamma": {
"type": "number",
"description": "gamma. Number."
},
"shareDelta": {
"type": "number",
"description": "shareDelta. Number."
},
"underlying": {
"type": "string",
"description": "underlying. String."
},
"dollarDelta": {
"type": "number",
"description": "dollarDelta. Number."
},
"thetaPerDay": {
"type": "number",
"description": "thetaPerDay. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "byUnderlying. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Aggregate portfolio option Greeks",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Compute static and if-called returns, annualised returns, downside protection and breakeven for a covered call, or the return on collateral for a cash-secured put when pricing or analysing an option. Call with strategy, strike, premium, and daysToExpiry; optional stockPrice, dividendsBeforeExpiry, commission. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: CISA KEV, known exploited, KEV catalog, when pricing or analysing an option, strategy, strike, premium, daysToExpiry, stockPrice, dividendsBeforeExpiry, commission, staticReturn, ifCalledReturn, staticAnnualized, ifCalledAnnualized.
| Parameter | Type | Description |
|---|---|---|
| strike * | number | strike, number. Required. |
| premium * | number | premium, number. Required. |
| strategy * | string | strategy, string, one of covered_call, cash_secured_put. Required. |
| commission | number | commission, number, from 0 to any. Required. |
| stockPrice | number | stockPrice, number. Optional. |
| daysToExpiry * | integer | daysToExpiry, integer, from 1 to 1095. Required. |
| dividendsBeforeExpiry | number |
Parse or build OCC Options Symbology Initiative 21-character option symbols, validating the calendar date and flagging roots that look adjusted when pricing or analysing an option. Call with optional parse, build. Returns parsed, built, model, and inputsUsed (parsed includes input, root, expiry, type, strike, valid, possiblyAdjusted). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, parse, build, parsed, built, model, inputsUsed, Parse or build OCC option symbols, occ symbol parse.
| Parameter | Type | Description |
|---|---|---|
| build | array | build, array. Required. |
| parse | array | parse, array. Required. |
{
"name": "options-analytics_occ-symbol-parse",
"title": "Parse or build OCC option symbols",
"description": "Parse or build OCC Options Symbology Initiative 21-character option symbols, validating the calendar date and flagging roots that look adjusted when pricing or analysing an option. Call with optional parse, build. Returns parsed, built, model, and inputsUsed (parsed includes input, root, expiry, type, strike, valid, possiblyAdjusted). HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, parse, build, parsed, built, model, inputsUsed, Parse or build OCC option symbols, occ symbol parse.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"build": {
"type": "array",
"items": {
"type": "object",
"required": [
"root",
"expiry",
"type",
"strike"
],
"properties": {
"root": {
"type": "string",
"pattern": "^[A-Za-z0-9]{1,6}$",
"description": "root, string. Required."
},
"type": {
"enum": [
"call",
"put"
],
"type": "string",
"description": "type, string, one of call, put. Required."
},
"expiry": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "expiry, string, date. Required."
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMaximum": 100000,
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"default": [],
"description": "build, array. Required."
},
"parse": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40,
"description": "item, string, length 0 to 40. Required."
},
"default": [],
"description": "parse, array. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"built": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "symbol. String."
},
"compact": {
"type": "string",
"description": "compact. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "built. Array."
},
"model": {
"type": "string",
"description": "model. String."
},
"parsed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"root": {
"type": "string",
"description": "root. String."
},
"type": {
"type": "string",
"description": "type. String."
},
"input": {
"type": "string",
"description": "input. String."
},
"valid": {
"type": "boolean",
"description": "valid. Boolean."
},
"expiry": {
"type": "string",
"description": "expiry. String."
},
"strike": {
"type": "number",
"description": "strike. Number."
},
"possiblyAdjusted": {
"type": "boolean",
"description": "possiblyAdjusted. Boolean."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "parsed. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"buildCount": {
"type": "number",
"description": "buildCount. Number."
},
"parseCount": {
"type": "number",
"description": "parseCount. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Parse or build OCC option symbols",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Compute the max-pain strike, per-strike payout, put/call open-interest ratio and the highest open-interest call and put walls for one expiry from a supplied option chain when pricing or analysing an option. Call with chain; optional multiplier, topWalls. Returns maxPain, painByStrike, putCallOiRatio, callWalls, putWalls, model, and inputsUsed. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, chain, multiplier, topWalls, maxPain, painByStrike, putCallOiRatio, callWalls, putWalls, model, inputsUsed, Compute max pain and open-interest walls, max pain oi.
| Parameter | Type | Description |
|---|---|---|
| chain * | array | chain, array. Required. |
| topWalls | integer | topWalls, integer, from 1 to 50. Required. |
| multiplier | number | multiplier, number. Required. |
{
"name": "options-analytics_max-pain-oi",
"title": "Compute max pain and open-interest walls",
"description": "Compute the max-pain strike, per-strike payout, put/call open-interest ratio and the highest open-interest call and put walls for one expiry from a supplied option chain when pricing or analysing an option. Call with chain; optional multiplier, topWalls. Returns maxPain, painByStrike, putCallOiRatio, callWalls, putWalls, model, and inputsUsed. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, chain, multiplier, topWalls, maxPain, painByStrike, putCallOiRatio, callWalls, putWalls, model, inputsUsed, Compute max pain and open-interest walls, max pain oi.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"chain"
],
"properties": {
"chain": {
"type": "array",
"items": {
"type": "object",
"required": [
"strike",
"callOi",
"putOi"
],
"properties": {
"putOi": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "putOi, integer, from 0 to 9007199254740991. Required."
},
"callOi": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "callOi, integer, from 0 to 9007199254740991. Required."
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"description": "chain, array. Required."
},
"topWalls": {
"type": "integer",
"default": 3,
"maximum": 50,
"minimum": 1,
"description": "topWalls, integer, from 1 to 50. Required."
},
"multiplier": {
"type": "number",
"default": 100,
"description": "multiplier, number. Required.",
"exclusiveMinimum": 0
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"maxPain": {
"type": "number",
"description": "maxPain. Number."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"putWalls": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "putWalls. Array."
},
"callWalls": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "callWalls. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"topWalls": {
"type": "number",
"description": "topWalls. Number."
},
"multiplier": {
"type": "number",
"description": "multiplier. Number."
},
"totalPutOi": {
"type": "number",
"description": "totalPutOi. Number."
},
"strikeCount": {
"type": "number",
"description": "strikeCount. Number."
},
"totalCallOi": {
"type": "number",
"description": "totalCallOi. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"painByStrike": {
"type": "array",
"items": {
"type": "object",
"properties": {
"strike": {
"type": "number",
"description": "strike. Number."
},
"totalPayout": {
"type": "number",
"description": "totalPayout. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "painByStrike. Array."
},
"putCallOiRatio": {
"type": "number",
"description": "putCallOiRatio. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute max pain and open-interest walls",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Tool calls wrap the existing POST APIs and stay pay-per-call. initialize and tools/list are free. An unpaid tool call returns the x402 payment terms in the tool result and does not run. Retry with the payment in params._meta["x402/payment"], or send payment-signature. Payment settles only after a successful result.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "options-analytics_implied-volatility-solve",
"title": "Solve implied volatility for option prices",
"description": "Solve implied volatility for 1 to 500 option prices with Newton and Brent root-finding on Black-Scholes-Merton, or on a Cox-Ross-Rubinstein tree for American options when pricing or analysing an option. Prices outside the no-arbitrage bounds return a status instead of a number. Call with spot and options; optional style, rate, dividendYield, treeSteps. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, style, rate, dividendYield, treeSteps, results, model, inputsUsed, Solve implied volatility for option prices, implied volatility solve.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spot",
"options"
],
"properties": {
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"style": {
"enum": [
"european",
"american"
],
"type": "string",
"default": "european",
"description": "style, string, one of european, american. Required."
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"strike",
"timeYears",
"price"
],
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "id, string, length 1 to 64. Optional."
},
"type": {
"enum": [
"call",
"put"
],
"type": "string",
"description": "type, string, one of call, put. Required."
},
"price": {
"type": "number",
"description": "price, number. Required.",
"exclusiveMinimum": 0
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"timeYears": {
"type": "number",
"maximum": 50,
"minimum": 0,
"description": "timeYears, number, from 0 to 50. Required."
}
},
"description": "item, object. Required."
},
"description": "options, array. Required."
},
"treeSteps": {
"type": "integer",
"default": 200,
"maximum": 2000,
"minimum": 50,
"description": "treeSteps, integer, from 50 to 2000. Required."
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id. String."
},
"iv": {
"type": "number",
"description": "iv. Number."
},
"index": {
"type": "number",
"description": "index. Number."
},
"method": {
"type": "string",
"description": "method. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"iterations": {
"type": "number",
"description": "iterations. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "results. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"style": {
"type": "string",
"description": "style. String."
},
"optionCount": {
"type": "number",
"description": "optionCount. Number."
},
"dividendYield": {
"type": "number",
"description": "dividendYield. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Solve implied volatility for option prices",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| dividends, array. Required. |
| timeYears * | number | timeYears, number, from 0 to 50. Required. |
| dividendYield | number | dividendYield, number, from -0.2 to 1. Required. |
{
"name": "options-analytics_american-binomial-price",
"title": "Price an American option on a binomial tree",
"description": "Price an American or European option on a Cox-Ross-Rubinstein tree with optional discrete cash dividends (escrowed method), and return tree delta, gamma, theta, the early-exercise boundary and the Black-Scholes-Merton European value for comparison when pricing or analysing an option. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, type, spot, strike, timeYears, sigma, style, rate, dividendYield, steps, dividends, price, europeanPrice, delta, gamma.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"spot",
"strike",
"timeYears",
"sigma"
],
"properties": {
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"call",
"put"
],
"type": "string",
"description": "type, string, one of call, put. Required."
},
"sigma": {
"type": "number",
"maximum": 5,
"description": "sigma, number, from any to 5. Required.",
"exclusiveMinimum": 0
},
"steps": {
"type": "integer",
"default": 500,
"maximum": 5000,
"minimum": 1,
"description": "steps, integer, from 1 to 5000. Required."
},
"style": {
"enum": [
"american",
"european"
],
"type": "string",
"default": "american",
"description": "style, string, one of american, european. Required."
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"dividends": {
"type": "array",
"items": {
"type": "object",
"required": [
"timeYears",
"amount"
],
"properties": {
"amount": {
"type": "number",
"minimum": 0,
"description": "amount, number, from 0 to any. Required."
},
"timeYears": {
"type": "number",
"description": "timeYears, number. Required.",
"exclusiveMinimum": 0
}
},
"description": "item, object. Required."
},
"default": [],
"description": "dividends, array. Required."
},
"timeYears": {
"type": "number",
"maximum": 50,
"minimum": 0,
"description": "timeYears, number, from 0 to 50. Required."
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"delta": {
"type": "number",
"description": "delta. Number."
},
"gamma": {
"type": "number",
"description": "gamma. Number."
},
"model": {
"type": "string",
"description": "model. String."
},
"price": {
"type": "number",
"description": "price. Number."
},
"steps": {
"type": "number",
"description": "steps. Number."
},
"theta": {
"type": "number",
"description": "theta. Number."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"type": {
"type": "string",
"description": "type. String."
},
"sigma": {
"type": "number",
"description": "sigma. Number."
},
"steps": {
"type": "number",
"description": "steps. Number."
},
"style": {
"type": "string",
"description": "style. String."
},
"strike": {
"type": "number",
"description": "strike. Number."
},
"dividends": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "dividends. Array."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"dividendYield": {
"type": "number",
"description": "dividendYield. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"convergence": {
"type": "object",
"properties": {
"priceAtHalfSteps": {
"type": "null",
"description": "priceAtHalfSteps. Null."
}
},
"description": "convergence. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"europeanPrice": {
"type": "number",
"description": "europeanPrice. Number."
},
"earlyExerciseBoundary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"criticalSpot": {
"type": "number",
"description": "criticalSpot. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "earlyExerciseBoundary. Array."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Price an American option on a binomial tree",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "options-analytics_strategy-payoff",
"title": "Compute multi-leg option strategy payoff",
"description": "Compute payoff and profit or loss of a multi-leg option and stock position at expiry and at a valuation date, with exact breakevens, maximum profit and loss, and unlimited-risk flags when pricing or analysing an option. Call with spot and legs; optional rate, dividendYield, multiplier, valuationTimeYears, grid. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: CISA KEV, known exploited, KEV catalog, when pricing or analysing an option, spot, legs, rate, dividendYield, multiplier, valuationTimeYears, grid, netPremium, breakevens, maxProfit, maxLoss.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spot",
"legs"
],
"properties": {
"grid": {
"type": "object",
"required": [
"from",
"to",
"step"
],
"properties": {
"to": {
"type": "number",
"description": "to, number. Required.",
"exclusiveMinimum": 0
},
"from": {
"type": "number",
"minimum": 0,
"description": "from, number, from 0 to any. Required."
},
"step": {
"type": "number",
"description": "step, number. Required.",
"exclusiveMinimum": 0
}
},
"description": "grid, object. Optional."
},
"legs": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"qty",
"premium"
],
"properties": {
"qty": {
"type": "number",
"description": "qty, number. Required."
},
"kind": {
"enum": [
"option",
"stock"
],
"type": "string",
"description": "kind, string, one of option, stock. Required."
},
"type": {
"enum": [
"call",
"put"
],
"type": "string",
"description": "type, string, one of call, put. Optional."
},
"sigma": {
"type": "number",
"maximum": 5,
"description": "sigma, number, from any to 5. Optional.",
"exclusiveMinimum": 0
},
"strike": {
"type": "number",
"description": "strike, number. Optional.",
"exclusiveMinimum": 0
},
"premium": {
"type": "number",
"minimum": 0,
"description": "premium, number, from 0 to any. Required."
},
"timeYears": {
"type": "number",
"maximum": 50,
"minimum": 0,
"description": "timeYears, number, from 0 to 50. Optional."
}
},
"description": "item, object. Required."
},
"description": "legs, array. Required."
},
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"multiplier": {
"type": "number",
"default": 100,
"description": "multiplier, number. Required.",
"exclusiveMinimum": 0
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
},
"valuationTimeYears": {
"anyOf": [
{
"type": "number",
"maximum": 50,
"minimum": 0
},
{
"type": "null"
}
],
"description": "valuationTimeYears, value. Optional."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"grid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"spot": {
"type": "number",
"description": "spot. Number."
},
"pnlAtExpiry": {
"type": "number",
"description": "pnlAtExpiry. Number."
},
"pnlAtValuation": {
"type": "number",
"description": "pnlAtValuation. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "grid. Array."
},
"model": {
"type": "string",
"description": "model. String."
},
"maxLoss": {
"type": "number",
"description": "maxLoss. Number."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"maxProfit": {
"type": "number",
"description": "maxProfit. Number."
},
"breakevens": {
"type": "array",
"items": {
"type": "number",
"description": "item. Number."
},
"description": "breakevens. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"legCount": {
"type": "number",
"description": "legCount. Number."
},
"multiplier": {
"type": "number",
"description": "multiplier. Number."
},
"dividendYield": {
"type": "number",
"description": "dividendYield. Number."
},
"frontExpiryYears": {
"type": "number",
"description": "frontExpiryYears. Number."
},
"valuationTimeYears": {
"type": "number",
"description": "valuationTimeYears. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"netPremium": {
"type": "number",
"description": "netPremium. Number."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"unlimitedLoss": {
"type": "boolean",
"description": "unlimitedLoss. Boolean."
},
"unlimitedProfit": {
"type": "boolean",
"description": "unlimitedProfit. Boolean."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute multi-leg option strategy payoff",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| breakevens, array. Optional. |
| profitAbove | boolean | profitAbove, boolean. Optional. |
| dividendYield | number | dividendYield, number, from -0.2 to 1. Required. |
| profitBetween | array | profitBetween, array. Optional. |
{
"name": "options-analytics_probability-of-profit",
"title": "Compute lognormal option probabilities",
"description": "Compute lognormal probabilities of finishing above or below levels, touching a level before expiry, and finishing in profit for a strategy given its breakevens, under risk-neutral or real-world drift. Call with spot, sigma, and timeYears; optional rate, dividendYield, measure, drift, levels, breakevens and others. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: CISA KEV, known exploited, KEV catalog, when pricing or analysing an option, spot, sigma, timeYears, rate, dividendYield, measure, drift, levels, breakevens, profitAbove, profitBetween.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spot",
"sigma",
"timeYears"
],
"properties": {
"rate": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "rate, number, from -0.2 to 1. Required."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"drift": {
"anyOf": [
{
"type": "number",
"maximum": 2,
"minimum": -1
},
{
"type": "null"
}
],
"description": "drift, value. Optional."
},
"sigma": {
"type": "number",
"maximum": 5,
"description": "sigma, number, from any to 5. Required.",
"exclusiveMinimum": 0
},
"levels": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required.",
"exclusiveMinimum": 0
},
"default": [],
"description": "levels, array. Required."
},
"measure": {
"enum": [
"risk_neutral",
"real_world"
],
"type": "string",
"default": "risk_neutral",
"description": "measure, string, one of risk_neutral, real_world. Required."
},
"timeYears": {
"type": "number",
"maximum": 50,
"description": "timeYears, number, from any to 50. Required.",
"exclusiveMinimum": 0
},
"breakevens": {
"type": "array",
"items": {
"type": "number",
"description": "item, number. Required.",
"exclusiveMinimum": 0
},
"description": "breakevens, array. Optional."
},
"profitAbove": {
"type": "boolean",
"description": "profitAbove, boolean. Optional."
},
"dividendYield": {
"type": "number",
"default": 0,
"maximum": 1,
"minimum": -0.2,
"description": "dividendYield, number, from -0.2 to 1. Required."
},
"profitBetween": {
"type": "array",
"items": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "number",
"exclusiveMinimum": 0
}
],
"maxItems": 2,
"minItems": 2,
"description": "profitBetween, array. Optional.",
"additionalItems": false
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"level": {
"type": "number",
"description": "level. Number."
},
"pAbove": {
"type": "number",
"description": "pAbove. Number."
},
"pBelow": {
"type": "number",
"description": "pBelow. Number."
},
"pTouch": {
"type": "number",
"description": "pTouch. Number."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "levels. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"sigma": {
"type": "number",
"description": "sigma. Number."
},
"measure": {
"type": "string",
"description": "measure. String."
},
"driftUsed": {
"type": "number",
"description": "driftUsed. Number."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"dividendYield": {
"type": "number",
"description": "dividendYield. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"probabilityOfProfit": {
"type": "number",
"description": "probabilityOfProfit. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute lognormal option probabilities",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "options-analytics_put-call-parity-check",
"title": "Check put-call parity and implied forward",
"description": "Infer the implied forward and carry from call and put quote pairs, solve the rate by least squares when omitted, and flag pairs whose bid and ask break the European or American parity band when pricing or analysing an option. Call with spot, timeYears, and pairs; optional style, rate, toleranceAbs. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: when pricing or analysing an option, spot, timeYears, pairs, style, rate, toleranceAbs, impliedForward, impliedCarry, impliedRate, model, inputsUsed, Check put-call parity and implied forward, put call parity check.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spot",
"timeYears",
"pairs"
],
"properties": {
"rate": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.2
},
{
"type": "null"
}
],
"description": "rate, value. Optional."
},
"spot": {
"type": "number",
"description": "spot, number. Required.",
"exclusiveMinimum": 0
},
"pairs": {
"type": "array",
"items": {
"type": "object",
"required": [
"strike",
"callBid",
"callAsk",
"putBid",
"putAsk"
],
"properties": {
"putAsk": {
"type": "number",
"minimum": 0,
"description": "putAsk, number, from 0 to any. Required."
},
"putBid": {
"type": "number",
"minimum": 0,
"description": "putBid, number, from 0 to any. Required."
},
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"callAsk": {
"type": "number",
"minimum": 0,
"description": "callAsk, number, from 0 to any. Required."
},
"callBid": {
"type": "number",
"minimum": 0,
"description": "callBid, number, from 0 to any. Required."
}
},
"description": "item, object. Required."
},
"description": "pairs, array. Required."
},
"style": {
"enum": [
"european",
"american"
],
"type": "string",
"default": "european",
"description": "style, string, one of european, american. Required."
},
"timeYears": {
"type": "number",
"maximum": 50,
"description": "timeYears, number, from any to 50. Required.",
"exclusiveMinimum": 0
},
"toleranceAbs": {
"type": "number",
"default": 0.01,
"minimum": 0,
"description": "toleranceAbs, number, from 0 to any. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mid": {
"type": "object",
"properties": {
"put": {
"type": "number",
"description": "put. Number."
},
"call": {
"type": "number",
"description": "call. Number."
}
},
"description": "mid. Object.",
"additionalProperties": {}
},
"strike": {
"type": "number",
"description": "strike. Number."
},
"forward": {
"type": "number",
"description": "forward. Number."
},
"residual": {
"type": "number",
"description": "residual. Number."
},
"violation": {
"type": "boolean",
"description": "violation. Boolean."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "pairs. Array."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"inputsUsed": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "rate. Number."
},
"spot": {
"type": "number",
"description": "spot. Number."
},
"style": {
"type": "string",
"description": "style. String."
},
"timeYears": {
"type": "number",
"description": "timeYears. Number."
},
"toleranceAbs": {
"type": "number",
"description": "toleranceAbs. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"impliedRate": {
"type": "null",
"description": "impliedRate. Null."
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"impliedCarry": {
"type": "number",
"description": "impliedCarry. Number."
},
"impliedForward": {
"type": "number",
"description": "impliedForward. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Check put-call parity and implied forward",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}| dividendsBeforeExpiry, number, from 0 to any. Required. |
{
"name": "options-analytics_covered-call-yield",
"title": "Compute covered call and cash-secured put yield",
"description": "Compute static and if-called returns, annualised returns, downside protection and breakeven for a covered call, or the return on collateral for a cash-secured put when pricing or analysing an option. Call with strategy, strike, premium, and daysToExpiry; optional stockPrice, dividendsBeforeExpiry, commission. HTTP 200 with status complete, partial, or failed is charged at the full listed price. HTTP 4xx/5xx are not charged. Keywords: CISA KEV, known exploited, KEV catalog, when pricing or analysing an option, strategy, strike, premium, daysToExpiry, stockPrice, dividendsBeforeExpiry, commission, staticReturn, ifCalledReturn, staticAnnualized, ifCalledAnnualized.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"strategy",
"strike",
"premium",
"daysToExpiry"
],
"properties": {
"strike": {
"type": "number",
"description": "strike, number. Required.",
"exclusiveMinimum": 0
},
"premium": {
"type": "number",
"description": "premium, number. Required.",
"exclusiveMinimum": 0
},
"strategy": {
"enum": [
"covered_call",
"cash_secured_put"
],
"type": "string",
"description": "strategy, string, one of covered_call, cash_secured_put. Required."
},
"commission": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "commission, number, from 0 to any. Required."
},
"stockPrice": {
"type": "number",
"description": "stockPrice, number. Optional.",
"exclusiveMinimum": 0
},
"daysToExpiry": {
"type": "integer",
"maximum": 1095,
"minimum": 1,
"description": "daysToExpiry, integer, from 1 to 1095. Required."
},
"dividendsBeforeExpiry": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "dividendsBeforeExpiry, number, from 0 to any. Required."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"model": {
"type": "string",
"description": "model. String."
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url. String."
},
"source": {
"type": "string",
"description": "source. String."
},
"status": {
"type": "string",
"description": "status. String."
},
"retrievedAt": {
"type": "string",
"description": "retrievedAt. String."
}
},
"description": "item. Object.",
"additionalProperties": {}
},
"description": "sources. Array."
},
"netDebit": {
"type": "number",
"description": "netDebit. Number."
},
"strategy": {
"type": "string",
"description": "strategy. String."
},
"breakeven": {
"type": "number",
"description": "breakeven. Number."
},
"collateral": {
"type": "null",
"description": "collateral. Null."
},
"inputsUsed": {
"type": "object",
"properties": {
"strike": {
"type": "number",
"description": "strike. Number."
},
"premium": {
"type": "number",
"description": "premium. Number."
},
"commission": {
"type": "number",
"description": "commission. Number."
},
"stockPrice": {
"type": "number",
"description": "stockPrice. Number."
},
"daysToExpiry": {
"type": "number",
"description": "daysToExpiry. Number."
},
"dividendsBeforeExpiry": {
"type": "number",
"description": "dividendsBeforeExpiry. Number."
}
},
"description": "inputsUsed. Object.",
"additionalProperties": {}
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"description": "Item. String."
},
"description": "limitations. Array."
},
"staticReturn": {
"type": "number",
"description": "staticReturn. Number."
},
"ifCalledReturn": {
"type": "number",
"description": "ifCalledReturn. Number."
},
"staticAnnualized": {
"type": "number",
"description": "staticAnnualized. Number."
},
"compoundAnnualized": {
"type": "number",
"description": "compoundAnnualized. Number."
},
"downsideProtection": {
"type": "number",
"description": "downsideProtection. Number."
},
"ifCalledAnnualized": {
"type": "number",
"description": "ifCalledAnnualized. Number."
},
"ifCalledCompoundAnnualized": {
"type": "number",
"description": "ifCalledCompoundAnnualized. Number."
}
},
"additionalProperties": {}
},
"annotations": {
"title": "Compute covered call and cash-secured put yield",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}