{"openapi":"3.1.0","info":{"title":"Rayoush Capital Data API","version":"0.5.0"},"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/admin/sync/quote/{symbol}":{"post":{"summary":"Sync Quote","operationId":"sync_quote_v1_admin_sync_quote__symbol__post","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/sync/history/{symbol}":{"post":{"summary":"Sync History","operationId":"sync_history_v1_admin_sync_history__symbol__post","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"adjusted","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Adjusted"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":300,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/symbols":{"get":{"summary":"Symbols","operationId":"symbols_v1_symbols_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/quotes/{symbol}":{"get":{"summary":"Get Quote","operationId":"get_quote_v1_quotes__symbol__get","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/history/{symbol}":{"get":{"summary":"History","operationId":"history_v1_history__symbol__get","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"adjusted","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Adjusted"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":300,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/providers":{"get":{"summary":"Providers","operationId":"providers_v1_providers_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/admin/aggregate/quote/{symbol}":{"post":{"summary":"Aggregate Quote","operationId":"aggregate_quote_v1_admin_aggregate_quote__symbol__post","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/aggregate/history/{symbol}":{"post":{"summary":"Aggregate History","operationId":"aggregate_history_v1_admin_aggregate_history__symbol__post","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"adjusted","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Adjusted"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":300,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/aggregated/{dataset}/{symbol}":{"get":{"summary":"Aggregated","operationId":"aggregated_v1_aggregated__dataset___symbol__get","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/aggregation-runs/{symbol}":{"get":{"summary":"Aggregation Runs","operationId":"aggregation_runs_v1_aggregation_runs__symbol__get","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/catalog":{"get":{"tags":["v3"],"summary":"Catalog","operationId":"catalog_v3_catalog_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/collect/{dataset}/{symbol}":{"post":{"tags":["v3"],"summary":"Collect","operationId":"collect_v3_collect__dataset___symbol__post","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"adjusted","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Adjusted"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":300,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/quotes/realtime/{symbol}":{"get":{"tags":["v3"],"summary":"Realtime Quote","description":"Fetch live quote for a symbol, falling back to latest canonical snapshot if market is closed or on upstream error.","operationId":"realtime_quote_v3_quotes_realtime__symbol__get","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/market/overview":{"get":{"tags":["v3"],"summary":"Get Market Overview","description":"Real-time indices and market-wide statistics for Bourse and Farabourse.","operationId":"get_market_overview_v3_market_overview_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/market/watch":{"get":{"tags":["v3"],"summary":"Get Market Watch","description":"Real-time market watch covering all ~3,600+ instruments in Iran capital market.","operationId":"get_market_watch_v3_market_watch_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"market_flow","in":"query","required":false,"schema":{"type":"string","pattern":"^(بورس|فرابورس|پایه)?$","default":"","title":"Market Flow"}},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","default":"trade_value","title":"Sort By"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Order"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/market/board":{"get":{"tags":["v3"],"summary":"Get Market Board","description":"Real-time market board with heatmaps, queues, and top sector performers.","operationId":"get_market_board_v3_market_board_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/quotes/full/{symbol}":{"get":{"tags":["v3"],"summary":"Get Full Stock Profile","description":"Complete stock board matching official TSETMC profile.","operationId":"get_full_stock_profile_v3_quotes_full__symbol__get","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"history_limit","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":1,"default":15,"title":"History Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/quotes/batch":{"post":{"tags":["v3"],"summary":"Batch Quotes","description":"Fetch realtime quotes for a list of symbols.","operationId":"batch_quotes_v3_quotes_batch_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchQuotesIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/collectors/health":{"get":{"tags":["v3"],"summary":"Collector Health","description":"Operational health status of all data collectors.","operationId":"collector_health_v3_collectors_health_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/corporate-actions/{canonical_id}":{"get":{"tags":["v3"],"summary":"Get Corporate Actions","description":"List corporate actions for an instrument.","operationId":"get_corporate_actions_v3_corporate_actions__canonical_id__get","parameters":[{"name":"canonical_id","in":"path","required":true,"schema":{"type":"string","title":"Canonical Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/funds/nav/{fund_id}":{"get":{"tags":["v3"],"summary":"Get Fund Nav","description":"Get Fund NAV history with live fallback to FIPIRAN / ETF quote.","operationId":"get_fund_nav_v3_funds_nav__fund_id__get","parameters":[{"name":"fund_id","in":"path","required":true,"schema":{"type":"string","title":"Fund Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"default":30,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/funds/list":{"get":{"tags":["v3"],"summary":"List Funds","description":"List active tracked mutual funds and ETFs across the entire Iranian capital market.","operationId":"list_funds_v3_funds_list_get","parameters":[{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","default":"trade_value","title":"Sort By"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":600,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/funds/sync-fipiran":{"post":{"tags":["v3"],"summary":"Sync Fipiran","description":"Manually trigger FIPIRAN funds metadata sync.","operationId":"sync_fipiran_v3_funds_sync_fipiran_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/codal/sync-local":{"post":{"tags":["v3"],"summary":"Sync Local Codal","description":"Index local codal reports repository into ExtendedFact.","operationId":"sync_local_codal_v3_codal_sync_local_post","parameters":[{"name":"max_issuers","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Max Issuers"}},{"name":"reports_per_issuer","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":10,"title":"Reports Per Issuer"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/codal/issuers":{"get":{"tags":["v3"],"summary":"Get Codal Issuers","description":"Search and browse indexed Codal issuers from local storage.","operationId":"get_codal_issuers_v3_codal_issuers_get","parameters":[{"name":"query","in":"query","required":false,"schema":{"type":"string","default":"","title":"Query"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/collectors/ping":{"post":{"tags":["v3"],"summary":"Ping Collectors","description":"Test ping all collectors and update heartbeats.","operationId":"ping_collectors_v3_collectors_ping_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/identities":{"get":{"tags":["v3"],"summary":"Identities","operationId":"identities_v3_identities_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/snapshots/{dataset}/{canonical_id}":{"get":{"tags":["v3"],"summary":"Snapshots","operationId":"snapshots_v3_snapshots__dataset___canonical_id__get","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"canonical_id","in":"path","required":true,"schema":{"type":"string","title":"Canonical Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/issues":{"get":{"tags":["v3"],"summary":"Issues","operationId":"issues_v3_issues_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","default":"open","title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/quality":{"get":{"tags":["v3"],"summary":"Quality","operationId":"quality_v3_quality_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/facts":{"post":{"tags":["v3"],"summary":"Add Fact","operationId":"add_fact_v3_facts_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FactIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/facts/{dataset}":{"get":{"tags":["v3"],"summary":"Facts","operationId":"facts_v3_facts__dataset__get","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string","title":"Dataset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/schedules":{"post":{"tags":["v3"],"summary":"Add Schedule","operationId":"add_schedule_v3_schedules_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["v3"],"summary":"Schedules","operationId":"schedules_v3_schedules_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/returns/portfolio":{"post":{"tags":["v3"],"summary":"Calc Portfolio","operationId":"calc_portfolio_v3_returns_portfolio_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/returns/asset":{"post":{"tags":["v3"],"summary":"Calc Asset","operationId":"calc_asset_v3_returns_asset_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/returns/twr":{"post":{"tags":["v3"],"summary":"Calc Twr","description":"Calculates True Time-Weighted Return (TWR) across subperiods.","operationId":"calc_twr_v3_returns_twr_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TWRIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/returns/xirr":{"post":{"tags":["v3"],"summary":"Calc Xirr","description":"Calculates exact Internal Rate of Return (XIRR) for irregular cash flows.","operationId":"calc_xirr_v3_returns_xirr_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XIRRIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/analytics/adjust-price":{"post":{"tags":["v3"],"summary":"Calc Price Adjustment","description":"Adjusts security price for corporate action (bonus shares, cash dividend, capital increase).","operationId":"calc_price_adjustment_v3_analytics_adjust_price_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceAdjustmentIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v3/screen":{"get":{"tags":["v3"],"summary":"Screening","operationId":"screening_v3_screen_get","parameters":[{"name":"field","in":"query","required":false,"schema":{"type":"string","default":"close_price","title":"Field"}},{"name":"op","in":"query","required":false,"schema":{"type":"string","default":"gt","title":"Op"}},{"name":"threshold","in":"query","required":false,"schema":{"type":"number","default":0,"title":"Threshold"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/ready":{"get":{"summary":"Ready","operationId":"ready_ready_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"BatchQuotesIn":{"properties":{"symbols":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Symbols"}},"type":"object","required":["symbols"],"title":"BatchQuotesIn"},"FactIn":{"properties":{"provider":{"type":"string","maxLength":64,"minLength":1,"title":"Provider"},"dataset":{"type":"string","title":"Dataset"},"external_id":{"type":"string","maxLength":180,"minLength":1,"title":"External Id"},"canonical_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Id"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"payload":{"additionalProperties":true,"type":"object","title":"Payload"}},"type":"object","required":["provider","dataset","external_id","payload"],"title":"FactIn"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PriceAdjustmentIn":{"properties":{"price":{"type":"number","exclusiveMinimum":0.0,"title":"Price"},"action_type":{"type":"string","title":"Action Type"},"params":{"additionalProperties":true,"type":"object","title":"Params"}},"type":"object","required":["price","action_type"],"title":"PriceAdjustmentIn"},"ReturnIn":{"properties":{"begin":{"type":"number","title":"Begin"},"end":{"type":"number","title":"End"},"dividends":{"type":"number","title":"Dividends","default":0},"purchases":{"type":"number","title":"Purchases","default":0},"sales":{"type":"number","title":"Sales","default":0}},"type":"object","required":["begin","end"],"title":"ReturnIn"},"ScheduleIn":{"properties":{"symbol":{"type":"string","maxLength":80,"minLength":1,"title":"Symbol"},"dataset":{"type":"string","title":"Dataset","default":"quote"},"interval_seconds":{"type":"integer","maximum":86400.0,"minimum":60.0,"title":"Interval Seconds","default":900},"enabled":{"type":"boolean","title":"Enabled","default":true}},"type":"object","required":["symbol"],"title":"ScheduleIn"},"TWRIn":{"properties":{"subperiods":{"items":{"$ref":"#/components/schemas/TWRPeriodIn"},"type":"array","minItems":1,"title":"Subperiods"}},"type":"object","required":["subperiods"],"title":"TWRIn"},"TWRPeriodIn":{"properties":{"begin":{"type":"number","title":"Begin"},"end":{"type":"number","title":"End"},"cash_flow":{"type":"number","title":"Cash Flow","default":0.0},"dividends":{"type":"number","title":"Dividends","default":0.0}},"type":"object","required":["begin","end"],"title":"TWRPeriodIn"},"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"},"XIRRIn":{"properties":{"cash_flows":{"items":{"$ref":"#/components/schemas/XIRRItem"},"type":"array","minItems":2,"title":"Cash Flows"}},"type":"object","required":["cash_flows"],"title":"XIRRIn"},"XIRRItem":{"properties":{"date":{"type":"string","title":"Date"},"amount":{"type":"number","title":"Amount"}},"type":"object","required":["date","amount"],"title":"XIRRItem"}}}}