Ferro API reference

Ordered result with an explicit per-item failure alternative.

all of

one of

Ordered request envelope; runtime applies the pinned plan limit.

Additional fields are not accepted.

requestsarray of FusedAnalyticsRequestrequired

minItems: 1maxItems: 1024

Array item schema

FusedAnalyticsRequest

One metadata block for the entire admitted batch.

metadataResponseMetadatarequired

resultsarray of BatchFusedAnalyticsItemResultrequired

Array item schema

BatchFusedAnalyticsItemResult

Ordered result with an explicit per-item failure alternative.

all of

one of

Ordered request envelope; runtime applies the pinned plan limit.

Additional fields are not accepted.

requestsarray of GreeksAllTenRequestrequired

minItems: 1maxItems: 1024

Array item schema

GreeksAllTenRequest

One metadata block for the entire admitted batch.

metadataResponseMetadatarequired

resultsarray of BatchGreeksAllTenItemResultrequired

Array item schema

BatchGreeksAllTenItemResult

Ordered result with an explicit per-item failure alternative.

all of

one of

Ordered request envelope; runtime applies the pinned plan limit.

Additional fields are not accepted.

requestsarray of ImpliedVolatilityRequestrequired

minItems: 1maxItems: 1024

Array item schema

ImpliedVolatilityRequest

One metadata block for the entire admitted batch.

metadataResponseMetadatarequired

resultsarray of BatchImpliedVolatilityItemResultrequired

Array item schema

BatchImpliedVolatilityItemResult

Ordered result for one batch element.

all of

Per-item batch outcome. Structural request failures remain request-level errors.

one of

An ordered batch of option-pricing requests.

Additional fields are not accepted.

requestsarray of PriceRequestrequired

minItems: 1maxItems: 1024

Array item schema

PriceRequest

Successful response for a batch, including any per-item pricing failures.

metadataResponseMetadatarequired

resultsarray of BatchItemResultrequired

Array item schema

BatchItemResult

One discrete cash dividend. Time is a year fraction on the same basis as `time_to_expiry_years`, not a calendar date. The contract carries no calendar, day-count convention or timezone, and introducing one here to express a dividend date would add a basis the rest of the contract does not have and cannot validate. The engine's own `DividendEvent` is `ex_time_years` for the same reason.

Additional fields are not accepted.

cash_amountnumber · doublerequired

Cash amount per share, in the same currency as spot and strike.

ex_time_yearsnumber · doublerequired

Ex-dividend time as a year fraction from valuation.

Stable, machine-readable error details.

codestringrequired

fieldstring | nulloptional

messagestringrequired

Top-level HTTP error envelope.

errorErrorBodyrequired

metadataResponseMetadatarequired

Contract exercise convention, independent of the pricing algorithm.

string

Allowed values: "european" "american"

A request for price and Greeks, optionally at a volatility solved from an observed premium first. With `market_price`, volatility is solved and the Greeks are evaluated at the solved value — one admission, one solve, and the solved point passed inward as verified evidence rather than re-derived. Without it, the supplied `volatility` is used and the result is the all-ten-Greeks operation under another name.

Additional fields are not accepted.

dividend_schedulearray of DividendEventoptional

Served only together with `market_price` (#330).

maxItems: 16

Array item schema

DividendEvent

dividend_yieldnumber · doublerequired

exercise_styleExerciseStylerequired

market_pricenumber | null · doubleoptional

The observed premium to invert before evaluating the Greeks.

model_versionstring | nulloptional

option_typeOptionTyperequired

pricing_modelPricingModelrequired

risk_free_ratenumber · doublerequired

spotnumber · doublerequired

strikenumber · doublerequired

time_to_expiry_yearsnumber · doublerequired

volatilitynumber · doublerequired

Used only when `market_price` is absent.

Successful response for one fused-analytics operation.

metadataResponseMetadatarequired

resultFusedAnalyticsResultrequired

Price, Greeks and — when a premium was supplied — the solve that produced the volatility they were evaluated at.

greeksGreeksAllTenrequired

implied_volatilityone ofoptional

Must satisfy exactly one schema below:

Variant 1

null

Variant 2

Present only when the request supplied `market_price`.

ImpliedVolatilityResult

model_versionstringrequired

pricenumber · doublerequired

pricing_modelResolvedPricingModelrequired

The ten Greeks, on the contract's stated bases. Time derivatives are **per year**. The engine reports them per calendar day, which embeds a 365-day calendar; the contract carries no calendar, so the service scales by the engine's own day count at this boundary and the caller applies whichever convention it holds. Vega is raw `dV/dσ` per unit volatility, not per point. Nothing else is rescaled.

charmnumber · doublerequired

`d²V/(dS dt)`, **per year**.

colornumber · doublerequired

`d³V/(dS² dt)`, **per year**.

deltanumber · doublerequired

`dV/dS`.

gammanumber · doublerequired

`d²V/dS²`.

rhonumber · doublerequired

`dV/dr`, per unit rate.

thetanumber · doublerequired

`dV/dt`, **per year**.

vannanumber · doublerequired

`d²V/(dS dσ)`, per unit volatility.

veganumber · doublerequired

`dV/dσ`, per unit volatility.

vetanumber · doublerequired

`d²V/(dσ dt)`, **per year** per unit volatility.

volganumber · doublerequired

`d²V/dσ²`, per unit volatility squared.

A request for the price and all ten Greeks at a supplied volatility. The same shape as `PriceRequest`: the Greeks are derivatives of the price, so they are a property of the same contract and the same coordinates.

Additional fields are not accepted.

dividend_schedulearray of DividendEventoptional

Accepted by the wire contract, refused by this operation until the engine exposes schedule-aware Greeks without a premium (#330). A schedule is served on `FusedAnalytics` with `market_price`.

maxItems: 16

Array item schema

DividendEvent

dividend_yieldnumber · doublerequired

exercise_styleExerciseStylerequired

model_versionstring | nulloptional

option_typeOptionTyperequired

pricing_modelPricingModelrequired

risk_free_ratenumber · doublerequired

spotnumber · doublerequired

strikenumber · doublerequired

time_to_expiry_yearsnumber · doublerequired

volatilitynumber · doublerequired

Successful response for one all-ten-Greeks operation.

metadataResponseMetadatarequired

resultGreeksAllTenResultrequired

The price and Greeks of one contract at the volatility supplied.

greeksGreeksAllTenrequired

model_versionstringrequired

pricenumber · doublerequired

pricing_modelResolvedPricingModelrequired

A request to invert an observed premium into a volatility. Carries `market_price` and no `volatility`: volatility is the unknown being solved for, so a request that supplied one would be asking the service to ignore it.

Additional fields are not accepted.

dividend_schedulearray of DividendEventoptional

maxItems: 16

Array item schema

DividendEvent

dividend_yieldnumber · doublerequired

exercise_styleExerciseStylerequired

market_pricenumber · doublerequired

The observed premium to invert.

model_versionstring | nulloptional

option_typeOptionTyperequired

pricing_modelPricingModelrequired

risk_free_ratenumber · doublerequired

spotnumber · doublerequired

strikenumber · doublerequired

time_to_expiry_yearsnumber · doublerequired

Successful response for one implied-volatility operation.

metadataResponseMetadatarequired

resultImpliedVolatilityResultrequired

A solved implied volatility and the diagnostics that qualify it.

implied_volatilitynumber · doublerequired

Decimal fraction, on the same basis as `PriceRequest.volatility`.

iterationsinteger · int32required

minimum: 0

model_versionstringrequired

pricing_modelResolvedPricingModelrequired

residualnumber · doublerequired

residual_basisResidualBasisrequired

used_fallbackbooleanrequired

Whether the solve left its primary path. Not a quality signal on its own: an American solve inverts by bisection and reports `true` for every live solve, while a Bachelier solve reports `false` because bisection is its canonical solver rather than a degraded fallback.

Option payoff direction.

string

Allowed values: "call" "put"

Pinned policy identity and contributing record versions nested in response metadata.

planstringrequired

Versioned plan reference, formatted as id@version.

recordsarray of stringrequired

Contributing versioned records in resolution precedence order.

Array item schema

string

revisionstringrequired

Full opaque revision, encoded as 64 lowercase hexadecimal digits.

snapshot_idstringrequired

A single option-pricing request. All numeric fields are required.

Additional fields are not accepted.

dividend_schedulearray of DividendEventoptional

Discrete cash dividends within the option's life. American Bjerksund-Stensland 2002 only; omit for continuous `dividend_yield` alone.

maxItems: 16

Array item schema

DividendEvent

dividend_yieldnumber · doublerequired

exercise_styleExerciseStylerequired

model_versionstring | nulloptional

Optional algorithm-version pin. Omit to use the current version.

option_typeOptionTyperequired

pricing_modelPricingModelrequired

risk_free_ratenumber · doublerequired

spotnumber · doublerequired

strikenumber · doublerequired

time_to_expiry_yearsnumber · doublerequired

volatilitynumber · doublerequired

Successful response for one pricing operation.

metadataResponseMetadatarequired

resultPriceResultrequired

The transport-neutral result of one pricing operation.

exercise_styleExerciseStylerequired

model_versionstringrequired

Stable revision of the selected pricing algorithm.

option_typeOptionTyperequired

pricenumber · doublerequired

pricing_modelResolvedPricingModelrequired

Pricing algorithm selection. `Auto` resolves from the exercise style.

string

Allowed values: "auto" "black_scholes_merton" "bjerksund_stensland_2002" "bjerksund_stensland_1993"

string · binary

The basis a solved residual is expressed in. The residual is not one quantity. European and Black paths report a forward-normalised price residual comparable against the engine's convergence threshold; Bachelier and American Bjerksund-Stensland report a raw option-price residual. Publishing the number without its basis would invite exactly the cross-model comparison it does not support, so the basis travels with it and a client that ignores this field cannot silently get it wrong.

string

Allowed values: "forward_normalised_price" "option_price"

Pricing algorithm selected after resolving an input request. Unlike [`PricingModel`], this output-only type cannot represent `auto`.

string

Metadata shared by every successful response and API error.

api_versionstringrequired

budget_periodstring | nulloptional

budget_reset_atstring | nulloptional

UTC end of the budget period from the pinned account snapshot, when known.

compute_schedule_versionstringrequired

engine_versionstringrequired

Version of the FerroRisk service and linked pricing engine.

fcu_chargedinteger | null · int64optional

Committed commercial charge, including on post-commit failures. Absent in open development mode; zero for protected pre-commit refusals.

minimum: 0

fcu_quotedinteger | null · int64optional

Commercial quote; absent until reservation succeeds.

minimum: 0

fcu_schedule_idstring | nulloptional

fcu_schedule_versionstring | nulloptional

policyone ofoptional

Must satisfy exactly one schema below:

Variant 1

null

Variant 2

PolicyResponseMetadata

remaining_fcu_instance_estimateinteger | null · int64optional

Instance estimate, never an authoritative account balance or authorization input.

minimum: 0

request_idstringrequired

units_chargedinteger · int64required

minimum: 0

Liveness/readiness representation.

servicestringrequired

statusstringrequired

versionstringrequired