{"openapi":"3.1.0","info":{"title":"DerivaSys API","version":"1.0.0"},"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/ready":{"get":{"summary":"Ready","operationId":"ready_ready_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/history/catalog":{"get":{"tags":["history"],"summary":"Catalog","operationId":"catalog_api_v1_history_catalog_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryCatalogResponse"}}}}}}},"/api/v1/history/series":{"get":{"tags":["history"],"summary":"Series","operationId":"series_api_v1_history_series_get","parameters":[{"name":"asset","in":"query","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"metric","in":"query","required":true,"schema":{"type":"string","title":"Metric"}},{"name":"tenor","in":"query","required":true,"schema":{"type":"string","title":"Tenor"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","title":"End"}},{"name":"resolution","in":"query","required":false,"schema":{"type":"string","default":"auto","title":"Resolution"}},{"name":"max_points","in":"query","required":false,"schema":{"type":"integer","default":2000,"title":"Max Points"}},{"name":"include_stats","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Stats"}},{"name":"include_markers","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Markers"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySeriesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/history/snapshot":{"get":{"tags":["history"],"summary":"Snapshot","operationId":"snapshot_api_v1_history_snapshot_get","parameters":[{"name":"asset","in":"query","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"metric","in":"query","required":true,"schema":{"type":"string","title":"Metric"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"string","title":"Timestamp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistorySnapshotResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/history/markers":{"get":{"tags":["history"],"summary":"Markers","operationId":"markers_api_v1_history_markers_get","parameters":[{"name":"asset","in":"query","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","title":"End"}},{"name":"types","in":"query","required":false,"schema":{"type":"string","default":"report,event","title":"Types"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryMarkersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/history/relative-vol":{"get":{"tags":["history"],"summary":"Relative Vol","operationId":"relative_vol_api_v1_history_relative_vol_get","parameters":[{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","title":"End"}},{"name":"base","in":"query","required":false,"schema":{"type":"string","default":"BTC","title":"Base"}},{"name":"comparison","in":"query","required":false,"schema":{"type":"string","default":"ETH","title":"Comparison"}},{"name":"tenors","in":"query","required":false,"schema":{"type":"string","default":"1W,2W,1M,3M,6M,9M,1Y","title":"Tenors"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string","default":"1d","title":"Interval"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelativeVolHistoryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/data/catalog":{"get":{"tags":["published data","published data"],"summary":"List seven published daily datasets and date coverage","operationId":"catalog_api_v1_data_catalog_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResponse"}}}},"404":{"description":"Asset or published date does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid date, range, page size, or cursor"},"503":{"description":"Upstream unavailable, failed verification, or capacity exhausted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/data/{asset}/dates":{"get":{"tags":["published data","published data"],"summary":"List all available publication dates in ascending order","operationId":"dates_api_v1_data__asset__dates_get","parameters":[{"name":"asset","in":"path","required":true,"schema":{"type":"string","title":"Asset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatesResponse"}}}},"404":{"description":"Asset or published date does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid date, range, page size, or cursor"},"503":{"description":"Upstream unavailable, failed verification, or capacity exhausted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/data/{asset}/latest":{"get":{"tags":["published data","published data"],"summary":"Get the latest published observation, verified by SHA-256","operationId":"latest_api_v1_data__asset__latest_get","parameters":[{"name":"asset","in":"path","required":true,"schema":{"type":"string","title":"Asset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyMetricsPayload"}}}},"404":{"description":"Asset or published date does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid date, range, page size, or cursor"},"503":{"description":"Upstream unavailable, failed verification, or capacity exhausted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/data/{asset}/observations":{"get":{"tags":["published data","published data"],"summary":"Page through available daily observations in an inclusive date range","operationId":"observations_api_v1_data__asset__observations_get","parameters":[{"name":"asset","in":"path","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","description":"Inclusive UTC calendar date, YYYY-MM-DD","title":"Start"},"description":"Inclusive UTC calendar date, YYYY-MM-DD"},{"name":"end","in":"query","required":true,"schema":{"type":"string","description":"Inclusive UTC calendar date; maximum range 366 calendar days","title":"End"},"description":"Inclusive UTC calendar date; maximum range 366 calendar days"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":31,"minimum":1,"description":"Maximum observations per page","default":31,"title":"Limit"},"description":"Maximum observations per page"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Exclusive date cursor from the previous page's nextCursor; retain the same start and end","title":"Cursor"},"description":"Exclusive date cursor from the previous page's nextCursor; retain the same start and end"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationsResponse"}}}},"404":{"description":"Asset or published date does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid date, range, page size, or cursor"},"503":{"description":"Upstream unavailable, failed verification, or capacity exhausted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/data/{asset}/{date}":{"get":{"tags":["published data","published data"],"summary":"Get a published daily observation, verified by SHA-256","operationId":"observation_api_v1_data__asset___date__get","parameters":[{"name":"asset","in":"path","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"date","in":"path","required":true,"schema":{"type":"string","title":"Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyMetricsPayload"}}}},"404":{"description":"Asset or published date does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid date, range, page size, or cursor"},"503":{"description":"Upstream unavailable, failed verification, or capacity exhausted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/public/v1/market-summary":{"get":{"tags":["public"],"summary":"Market Summary","operationId":"market_summary_public_v1_market_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketSummaryResponse"}}}}}}},"/history/relative-vol":{"get":{"tags":["history"],"summary":"Relative Vol","operationId":"relative_vol_history_relative_vol_get","parameters":[{"name":"start","in":"query","required":true,"schema":{"type":"string","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","title":"End"}},{"name":"base","in":"query","required":false,"schema":{"type":"string","default":"BTC","title":"Base"}},{"name":"comparison","in":"query","required":false,"schema":{"type":"string","default":"ETH","title":"Comparison"}},{"name":"tenors","in":"query","required":false,"schema":{"type":"string","default":"1W,2W,1M,3M,6M,9M,1Y","title":"Tenors"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string","default":"1d","title":"Interval"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelativeVolHistoryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market-context/latest":{"get":{"tags":["market-context"],"summary":"Latest","operationId":"latest_api_v1_market_context_latest_get","parameters":[{"name":"asset","in":"query","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LatestMarketContextResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market-context/btc-volatility/latest":{"get":{"tags":["market-context"],"summary":"Latest Btc Volatility Context","description":"Latest independent BTC DS30 and Bitfinex BVIV points at or before ``as_of``.","operationId":"latest_btc_volatility_context_api_v1_market_context_btc_volatility_latest_get","parameters":[{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LatestBtcVolatilityContextResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market-context/history":{"get":{"tags":["market-context"],"summary":"History","operationId":"history_api_v1_market_context_history_get","parameters":[{"name":"asset","in":"query","required":true,"schema":{"type":"string","title":"Asset"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","format":"date","title":"End"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":1,"default":2000,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossAssetHistoryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/market-context/benchmarks":{"get":{"tags":["market-context"],"summary":"Benchmarks","operationId":"benchmarks_api_v1_market_context_benchmarks_get","parameters":[{"name":"start","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Start"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","format":"date","title":"End"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":1,"default":10000,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenchmarkHistoryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AssetCoverage":{"properties":{"asset":{"type":"string","title":"Asset"},"earliest_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Earliest Timestamp"},"latest_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest Timestamp"}},"additionalProperties":false,"type":"object","required":["asset","earliest_timestamp","latest_timestamp"],"title":"AssetCoverage"},"BenchmarkHistoryResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion","default":1},"type":{"type":"string","const":"market_context_benchmarks","title":"Type","default":"market_context_benchmarks"},"start":{"type":"string","format":"date","title":"Start"},"end":{"type":"string","format":"date","title":"End"},"count":{"type":"integer","title":"Count"},"rows":{"items":{"$ref":"#/components/schemas/BenchmarkObservation"},"type":"array","title":"Rows"}},"additionalProperties":false,"type":"object","required":["start","end","count","rows"],"title":"BenchmarkHistoryResponse"},"BenchmarkObservation":{"properties":{"sessionDate":{"type":"string","format":"date","title":"Sessiondate"},"benchmark":{"type":"string","title":"Benchmark"},"sourceSymbol":{"type":"string","title":"Sourcesymbol"},"sourceTimestamp":{"type":"string","format":"date-time","title":"Sourcetimestamp"},"provider":{"type":"string","title":"Provider"},"ingestedAt":{"type":"string","format":"date-time","title":"Ingestedat"},"methodologyVersion":{"type":"string","title":"Methodologyversion"},"qualityStatus":{"type":"string","title":"Qualitystatus"},"rawPayloadHash":{"type":"string","title":"Rawpayloadhash"},"metrics":{"additionalProperties":{"$ref":"#/components/schemas/MarketContextMetric"},"type":"object","title":"Metrics"}},"additionalProperties":false,"type":"object","required":["sessionDate","benchmark","sourceSymbol","sourceTimestamp","provider","ingestedAt","methodologyVersion","qualityStatus","rawPayloadHash","metrics"],"title":"BenchmarkObservation"},"BtcVolatilityPoint":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"units":{"type":"string","const":"volatility_points","title":"Units"},"sourceTimestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sourcetimestamp"},"observedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Observedat"},"ingestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ingestedat"},"freshness":{"$ref":"#/components/schemas/PointFreshness"},"availability":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Availability"},"methodology":{"type":"string","title":"Methodology"},"comparisonEligible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Comparisoneligible"}},"additionalProperties":false,"type":"object","required":["value","units","sourceTimestamp","observedAt","ingestedAt","freshness","methodology"],"title":"BtcVolatilityPoint"},"BtcVolatilitySpread":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"units":{"type":"string","const":"volatility_points","title":"Units","default":"volatility_points"},"status":{"type":"string","enum":["available","unavailable"],"title":"Status"},"methodology":{"type":"string","title":"Methodology"}},"additionalProperties":false,"type":"object","required":["value","status","methodology"],"title":"BtcVolatilitySpread"},"CatalogAsset":{"properties":{"asset":{"type":"string","title":"Asset"},"sourceReport":{"type":"string","title":"Sourcereport"},"count":{"type":"integer","title":"Count"},"earliestDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Earliestdate"},"latestDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latestdate"}},"type":"object","required":["asset","sourceReport","count","earliestDate","latestDate"],"title":"CatalogAsset"},"CatalogResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion"},"cadence":{"type":"string","const":"daily","title":"Cadence"},"assets":{"items":{"$ref":"#/components/schemas/CatalogAsset"},"type":"array","title":"Assets"},"limits":{"additionalProperties":{"type":"integer"},"type":"object","title":"Limits"}},"type":"object","required":["schemaVersion","cadence","assets","limits"],"title":"CatalogResponse"},"Comparison":{"properties":{"status":{"type":"string","enum":["available","baseline-not-yet-available","invalid-baseline"],"title":"Status"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["status","note"],"title":"Comparison"},"CrossAssetHistoryResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion","default":1},"type":{"type":"string","const":"market_context_history","title":"Type","default":"market_context_history"},"asset":{"type":"string","title":"Asset"},"start":{"type":"string","format":"date","title":"Start"},"end":{"type":"string","format":"date","title":"End"},"count":{"type":"integer","title":"Count"},"rows":{"items":{"$ref":"#/components/schemas/CrossAssetObservation"},"type":"array","title":"Rows"}},"additionalProperties":false,"type":"object","required":["asset","start","end","count","rows"],"title":"CrossAssetHistoryResponse"},"CrossAssetObservation":{"properties":{"sessionDate":{"type":"string","format":"date","title":"Sessiondate"},"cryptoAsset":{"type":"string","title":"Cryptoasset"},"benchmark":{"type":"string","title":"Benchmark"},"cryptoSnapshotTimestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cryptosnapshottimestamp"},"benchmarkTimestamp":{"type":"string","format":"date-time","title":"Benchmarktimestamp"},"provider":{"type":"string","title":"Provider"},"ingestedAt":{"type":"string","format":"date-time","title":"Ingestedat"},"methodologyVersion":{"type":"string","title":"Methodologyversion"},"qualityStatus":{"type":"string","title":"Qualitystatus"},"alignmentToleranceSeconds":{"type":"integer","title":"Alignmenttoleranceseconds"},"cryptoRvWindowDays":{"type":"integer","title":"Cryptorvwindowdays"},"benchmarkRvWindowSessions":{"type":"integer","title":"Benchmarkrvwindowsessions"},"cryptoAnnualizationDays":{"type":"integer","title":"Cryptoannualizationdays"},"benchmarkAnnualizationSessions":{"type":"integer","title":"Benchmarkannualizationsessions"},"metrics":{"additionalProperties":{"$ref":"#/components/schemas/MarketContextMetric"},"type":"object","title":"Metrics"}},"additionalProperties":false,"type":"object","required":["sessionDate","cryptoAsset","benchmark","cryptoSnapshotTimestamp","benchmarkTimestamp","provider","ingestedAt","methodologyVersion","qualityStatus","alignmentToleranceSeconds","cryptoRvWindowDays","benchmarkRvWindowSessions","cryptoAnnualizationDays","benchmarkAnnualizationSessions","metrics"],"title":"CrossAssetObservation"},"DailyMetricsPayload":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion"},"asset":{"type":"string","title":"Asset"},"reportDate":{"type":"string","title":"Reportdate"},"timestamps":{"$ref":"#/components/schemas/Timestamps"},"comparison":{"$ref":"#/components/schemas/Comparison"},"provenance":{"$ref":"#/components/schemas/Provenance"},"tenors":{"items":{"$ref":"#/components/schemas/Tenor"},"type":"array","title":"Tenors"},"realisedVolatility":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Realisedvolatility"},"realisedVolatilityUnavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Realisedvolatilityunavailablereason"}},"type":"object","required":["schemaVersion","asset","reportDate","timestamps","comparison","provenance","tenors","realisedVolatility","realisedVolatilityUnavailableReason"],"title":"DailyMetricsPayload"},"DatesResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion"},"asset":{"type":"string","title":"Asset"},"dates":{"items":{"type":"string"},"type":"array","title":"Dates"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["schemaVersion","asset","dates","count"],"title":"DatesResponse"},"ErrorDetail":{"properties":{"code":{"type":"string","title":"Code"},"message":{"type":"string","title":"Message"}},"type":"object","required":["code","message"],"title":"ErrorDetail"},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}},"type":"object","required":["error"],"title":"ErrorResponse"},"Freshness":{"properties":{"status":{"type":"string","enum":["fresh","stale"],"title":"Status"},"ageSeconds":{"type":"number","title":"Ageseconds"},"evaluatedAt":{"type":"string","format":"date-time","title":"Evaluatedat"}},"additionalProperties":false,"type":"object","required":["status","ageSeconds","evaluatedAt"],"title":"Freshness"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HistoryCatalogResponse":{"properties":{"assets":{"items":{"type":"string"},"type":"array","title":"Assets"},"metrics":{"items":{"$ref":"#/components/schemas/MetricCatalog"},"type":"array","title":"Metrics"},"tenors":{"items":{"type":"string"},"type":"array","title":"Tenors"},"resolutions":{"items":{"type":"string"},"type":"array","title":"Resolutions"},"coverage":{"items":{"$ref":"#/components/schemas/AssetCoverage"},"type":"array","title":"Coverage"},"default_max_points":{"type":"integer","title":"Default Max Points"},"maximum_max_points":{"type":"integer","title":"Maximum Max Points"}},"additionalProperties":false,"type":"object","required":["assets","metrics","tenors","resolutions","coverage","default_max_points","maximum_max_points"],"title":"HistoryCatalogResponse"},"HistoryMarker":{"properties":{"id":{"type":"string","title":"Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"type":{"type":"string","title":"Type"},"title":{"type":"string","title":"Title"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"additionalProperties":false,"type":"object","required":["id","timestamp","type","title"],"title":"HistoryMarker"},"HistoryMarkersResponse":{"properties":{"asset":{"type":"string","title":"Asset"},"start":{"type":"string","format":"date-time","title":"Start"},"end":{"type":"string","format":"date-time","title":"End"},"markers":{"items":{"$ref":"#/components/schemas/HistoryMarker"},"type":"array","title":"Markers"}},"additionalProperties":false,"type":"object","required":["asset","start","end","markers"],"title":"HistoryMarkersResponse"},"HistoryPoint":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"value":{"type":"number","title":"Value"}},"additionalProperties":false,"type":"object","required":["timestamp","value"],"title":"HistoryPoint"},"HistorySeriesResponse":{"properties":{"asset":{"type":"string","title":"Asset"},"metric":{"type":"string","title":"Metric"},"tenor":{"type":"string","title":"Tenor"},"unit":{"type":"string","title":"Unit"},"start":{"type":"string","format":"date-time","title":"Start"},"end":{"type":"string","format":"date-time","title":"End"},"resolution":{"type":"string","title":"Resolution"},"source_point_count":{"type":"integer","title":"Source Point Count"},"returned_point_count":{"type":"integer","title":"Returned Point Count"},"points":{"items":{"$ref":"#/components/schemas/HistoryPoint"},"type":"array","title":"Points"},"stats":{"anyOf":[{"$ref":"#/components/schemas/HistoryStatistics"},{"type":"null"}]},"markers":{"items":{"$ref":"#/components/schemas/HistoryMarker"},"type":"array","title":"Markers"}},"additionalProperties":false,"type":"object","required":["asset","metric","tenor","unit","start","end","resolution","source_point_count","returned_point_count","points","stats","markers"],"title":"HistorySeriesResponse"},"HistorySnapshotResponse":{"properties":{"asset":{"type":"string","title":"Asset"},"metric":{"type":"string","title":"Metric"},"requested_timestamp":{"type":"string","format":"date-time","title":"Requested Timestamp"},"resolved_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Resolved Timestamp"},"unit":{"type":"string","title":"Unit"},"values":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":"object","title":"Values"}},"additionalProperties":false,"type":"object","required":["asset","metric","requested_timestamp","resolved_timestamp","unit","values"],"title":"HistorySnapshotResponse"},"HistoryStatistics":{"properties":{"latest":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest"},"first":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"First"},"absolute_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Absolute Change"},"minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Minimum"},"maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maximum"},"mean":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mean"},"standard_deviation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Standard Deviation"},"z_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Z Score"},"percentile":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentile"}},"additionalProperties":false,"type":"object","required":["latest","first","absolute_change","minimum","maximum","mean","standard_deviation","z_score","percentile"],"title":"HistoryStatistics"},"LatestBtcVolatilityContextResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion","default":1},"type":{"type":"string","const":"btc_volatility_context_latest","title":"Type","default":"btc_volatility_context_latest"},"asset":{"type":"string","const":"BTC","title":"Asset","default":"BTC"},"asOf":{"type":"string","format":"date-time","title":"Asof"},"status":{"type":"string","enum":["available","partial","unavailable"],"title":"Status"},"ds30":{"$ref":"#/components/schemas/BtcVolatilityPoint"},"bviv":{"$ref":"#/components/schemas/BtcVolatilityPoint"},"bvivMinusDs30":{"$ref":"#/components/schemas/BtcVolatilitySpread"}},"additionalProperties":false,"type":"object","required":["asOf","status","ds30","bviv","bvivMinusDs30"],"title":"LatestBtcVolatilityContextResponse"},"LatestMarketContextResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion","default":1},"type":{"type":"string","const":"market_context_latest","title":"Type","default":"market_context_latest"},"asset":{"type":"string","title":"Asset"},"status":{"type":"string","enum":["available","partial","unavailable"],"title":"Status"},"commonBenchmarkSessionDate":{"type":"string","format":"date","title":"Commonbenchmarksessiondate"},"benchmarkAsOfTimestamp":{"type":"string","format":"date-time","title":"Benchmarkasoftimestamp"},"benchmarks":{"items":{"$ref":"#/components/schemas/BenchmarkObservation"},"type":"array","title":"Benchmarks"},"crossAsset":{"anyOf":[{"$ref":"#/components/schemas/CrossAssetObservation"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["asset","status","commonBenchmarkSessionDate","benchmarkAsOfTimestamp","benchmarks","crossAsset"],"title":"LatestMarketContextResponse"},"MarketContextMetric":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"units":{"type":"string","title":"Units"},"observationTimestamp":{"type":"string","format":"date-time","title":"Observationtimestamp"},"source":{"type":"string","title":"Source"},"provider":{"type":"string","title":"Provider"},"freshness":{"$ref":"#/components/schemas/Freshness"},"annualizationBasis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Annualizationbasis"},"windowDefinition":{"type":"string","title":"Windowdefinition"},"methodologyVersion":{"type":"string","title":"Methodologyversion"},"qualityStatus":{"type":"string","title":"Qualitystatus"},"sampleCount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Samplecount"}},"additionalProperties":false,"type":"object","required":["value","units","observationTimestamp","source","provider","freshness","annualizationBasis","windowDefinition","methodologyVersion","qualityStatus"],"title":"MarketContextMetric"},"MarketSummaryMarket":{"properties":{"asset":{"type":"string","title":"Asset"},"spot":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Spot"},"spot_change_24h_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Spot Change 24H Pct"},"atm_iv_1w":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Atm Iv 1W"},"atm_iv_1w_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Atm Iv 1W Change"},"rr25_1w":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rr25 1W"},"fit_status":{"type":"string","enum":["accepted","unavailable"],"title":"Fit Status"},"surface_age_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Surface Age Ms"}},"additionalProperties":false,"type":"object","required":["asset","spot","spot_change_24h_pct","atm_iv_1w","atm_iv_1w_change","rr25_1w","fit_status","surface_age_ms"],"title":"MarketSummaryMarket"},"MarketSummaryResponse":{"properties":{"as_of":{"type":"string","format":"date-time","title":"As Of"},"status":{"type":"string","enum":["live","delayed","stale","unavailable"],"title":"Status"},"markets":{"items":{"$ref":"#/components/schemas/MarketSummaryMarket"},"type":"array","title":"Markets"}},"additionalProperties":false,"type":"object","required":["as_of","status","markets"],"title":"MarketSummaryResponse"},"MetricCatalog":{"properties":{"id":{"type":"string","title":"Id"},"display_name":{"type":"string","title":"Display Name"},"unit":{"type":"string","title":"Unit"}},"additionalProperties":false,"type":"object","required":["id","display_name","unit"],"title":"MetricCatalog"},"MetricValue":{"properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Current"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Previous"},"change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Change"},"percentChange":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentchange"}},"type":"object","required":["current","previous","change","percentChange"],"title":"MetricValue"},"ObservationsResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion"},"asset":{"type":"string","title":"Asset"},"start":{"type":"string","title":"Start"},"end":{"type":"string","title":"End"},"limit":{"type":"integer","title":"Limit"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"totalAvailable":{"type":"integer","title":"Totalavailable"},"returnedCount":{"type":"integer","title":"Returnedcount"},"hasMore":{"type":"boolean","title":"Hasmore"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextcursor"},"dates":{"items":{"type":"string"},"type":"array","title":"Dates"},"observations":{"items":{"$ref":"#/components/schemas/DailyMetricsPayload"},"type":"array","title":"Observations"}},"type":"object","required":["schemaVersion","asset","start","end","limit","cursor","totalAvailable","returnedCount","hasMore","nextCursor","dates","observations"],"title":"ObservationsResponse"},"PointFreshness":{"properties":{"status":{"type":"string","enum":["fresh","stale","unavailable"],"title":"Status"},"ageSeconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ageseconds"},"evaluatedAt":{"type":"string","format":"date-time","title":"Evaluatedat"},"maxAgeSeconds":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Maxageseconds"},"sourceMaxAgeSeconds":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Sourcemaxageseconds"},"rejectionReasons":{"anyOf":[{"items":{"type":"string","enum":["missing_source_timestamp","age_exceeded","source_unavailable","reference_stale","value_unavailable"]},"type":"array"},{"type":"null"}],"title":"Rejectionreasons"}},"additionalProperties":false,"type":"object","required":["status","ageSeconds","evaluatedAt"],"title":"PointFreshness","description":"Freshness for an intraday point, including absent source evidence."},"Provenance":{"properties":{"reportArtifact":{"type":"string","const":"published daily report","title":"Reportartifact"},"sourceReport":{"type":"string","title":"Sourcereport"},"sourceReportHref":{"type":"string","title":"Sourcereporthref"},"source":{"type":"string","title":"Source"},"comparison":{"type":"string","title":"Comparison"},"rrConvention":{"type":"string","title":"Rrconvention"},"bfConvention":{"type":"string","title":"Bfconvention"},"fixedTenors":{"type":"string","title":"Fixedtenors"},"realisedVolatility":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Realisedvolatility"}},"type":"object","required":["reportArtifact","sourceReport","sourceReportHref","source","comparison","rrConvention","bfConvention","fixedTenors","realisedVolatility"],"title":"Provenance"},"RelativeVolGap":{"properties":{"ts":{"type":"integer","title":"Ts"},"tenor":{"type":"string","title":"Tenor"},"reason":{"type":"string","enum":["missing_base_surface","missing_comparison_surface","stale_base_leg","stale_comparison_leg","extrapolated_tenor","insufficient_rv_history","market_data_gap","failed_surface_fit"],"title":"Reason"},"asset":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset"}},"additionalProperties":false,"type":"object","required":["ts","tenor","reason"],"title":"RelativeVolGap"},"RelativeVolHistoryResponse":{"properties":{"schemaVersion":{"type":"integer","const":1,"title":"Schemaversion","default":1},"type":{"type":"string","const":"relative_vol_history","title":"Type","default":"relative_vol_history"},"base":{"type":"string","title":"Base"},"comparison":{"type":"string","title":"Comparison"},"interval":{"type":"string","const":"1d","title":"Interval","default":"1d"},"annualizationDays":{"type":"integer","const":365,"title":"Annualizationdays","default":365},"rvEstimator":{"type":"string","const":"close_to_close_log_returns","title":"Rvestimator","default":"close_to_close_log_returns"},"returnInterval":{"type":"string","const":"1d","title":"Returninterval","default":"1d"},"alignmentToleranceSeconds":{"type":"integer","title":"Alignmenttoleranceseconds"},"points":{"items":{"$ref":"#/components/schemas/RelativeVolPoint"},"type":"array","title":"Points"},"gaps":{"items":{"$ref":"#/components/schemas/RelativeVolGap"},"type":"array","title":"Gaps"}},"additionalProperties":false,"type":"object","required":["base","comparison","alignmentToleranceSeconds","points","gaps"],"title":"RelativeVolHistoryResponse"},"RelativeVolPoint":{"properties":{"ts":{"type":"integer","title":"Ts"},"tenor":{"type":"string","title":"Tenor"},"tenorDays":{"type":"integer","title":"Tenordays"},"baseIv":{"type":"number","title":"Baseiv"},"comparisonIv":{"type":"number","title":"Comparisoniv"},"baseRr25":{"type":"number","title":"Baserr25"},"comparisonRr25":{"type":"number","title":"Comparisonrr25"},"baseBf25":{"type":"number","title":"Basebf25"},"comparisonBf25":{"type":"number","title":"Comparisonbf25"},"baseRv":{"type":"number","title":"Baserv"},"comparisonRv":{"type":"number","title":"Comparisonrv"},"baseReturn":{"type":"number","title":"Basereturn"},"comparisonReturn":{"type":"number","title":"Comparisonreturn"},"baseSpot":{"type":"number","title":"Basespot"},"comparisonSpot":{"type":"number","title":"Comparisonspot"},"baseFitTs":{"type":"integer","title":"Basefitts"},"comparisonFitTs":{"type":"integer","title":"Comparisonfitts"},"isExtrapolated":{"type":"boolean","const":false,"title":"Isextrapolated","default":false},"quality":{"type":"string","const":"valid","title":"Quality","default":"valid"}},"additionalProperties":false,"type":"object","required":["ts","tenor","tenorDays","baseIv","comparisonIv","baseRr25","comparisonRr25","baseBf25","comparisonBf25","baseRv","comparisonRv","baseReturn","comparisonReturn","baseSpot","comparisonSpot","baseFitTs","comparisonFitTs"],"title":"RelativeVolPoint"},"Tenor":{"properties":{"tenor":{"type":"string","title":"Tenor"},"targetExpiry":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Targetexpiry"},"availability":{"type":"string","enum":["available","unavailable"],"title":"Availability"},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unavailablereason"},"atmIv":{"$ref":"#/components/schemas/MetricValue"},"rr25":{"$ref":"#/components/schemas/MetricValue"},"bf25":{"$ref":"#/components/schemas/MetricValue"}},"type":"object","required":["tenor","targetExpiry","availability","unavailableReason","atmIv","rr25","bf25"],"title":"Tenor"},"Timestamps":{"properties":{"currentSnapshotAt":{"type":"string","title":"Currentsnapshotat"},"previousSnapshotAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previoussnapshotat"},"generatedAt":{"type":"string","title":"Generatedat"}},"type":"object","required":["currentSnapshotAt","previousSnapshotAt","generatedAt"],"title":"Timestamps"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}