{"openapi":"3.1.0","info":{"title":"Tradytics API","description":"Options flow, dark pools and the whole stock market: prints, positioning, chains, prices, fundamentals, SEC filings and disclosures, KPIs. Every dataset. Start for free. Docs: https://tradytics.com/docs","version":"1.0"},"servers":[{"url":"https://tradytics.com/api/public/v1"}],"paths":{"/options/flow":{"get":{"tags":["Options flow"],"summary":"Options flow","operationId":"flow_options_flow_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlyings, comma separated (e.g. `NVDA,AMD`). Default all.","title":"Symbol"},"description":"Underlyings, comma separated (e.g. `NVDA,AMD`). Default all."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":18446744073709551615,"minimum":0},{"type":"null"}],"description":"Only rows after this `id`, oldest first (polling).","title":"Since"},"description":"Only rows after this `id`, oldest first (polling)."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["call","put"],"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["sweep","block","split","single"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"side","in":"query","required":false,"schema":{"anyOf":[{"enum":["bought","sold","mid"],"type":"string"},{"type":"null"}],"title":"Side"}},{"name":"min_premium","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Minimum premium, USD.","default":0,"title":"Min Premium"},"description":"Minimum premium, USD."},{"name":"expiry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One expiry, `YYYY-MM-DD`.","title":"Expiry"},"description":"One expiry, `YYYY-MM-DD`."},{"name":"dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3650,"minimum":0},{"type":"null"}],"description":"Only contracts expiring within this many days (0: same day).","title":"Dte"},"description":"Only contracts expiring within this many days (0: same day)."},{"name":"contract","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One contract, OCC symbol (e.g. `NVDA261218C00150000`).","title":"Contract"},"description":"One contract, OCC symbol (e.g. `NVDA261218C00150000`)."},{"name":"opening","in":"query","required":false,"schema":{"type":"boolean","description":"Only prints larger than the open interest.","default":false,"title":"Opening"},"description":"Only prints larger than the open interest."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionPrintListResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Options prints, newest first: the live session by default, one session with `date`, or a range since 2022-01-03. Pass `since` to poll the live session, oldest first. Cancelled trades are left out. Missing historic quote and open interest fields are null.\n\nLearn more: [Options prints](https://tradytics.com/learn/tradytics-clean-options-flow), [same-day](https://tradytics.com/learn/what-are-0dte-options), [Premium](https://tradytics.com/learn/options-premium-vs-contracts), [inferred trade side](https://tradytics.com/learn/how-to-tell-if-options-were-bought-or-sold), [across exchanges](https://tradytics.com/learn/sweep-vs-block-vs-split), [Size above the open interest](https://tradytics.com/learn/opening-or-closing-options-trade).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-clean-options-flow","description":"Options prints"}}},"/options/flow/timeline":{"get":{"tags":["Options flow"],"summary":"Flow timeline","operationId":"timeline_options_flow_timeline_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlyings, comma separated. Default all single stocks.","title":"Symbol"},"description":"Underlyings, comma separated. Default all single stocks."},{"name":"interval","in":"query","required":false,"schema":{"enum":["1m","5m","15m","1h","1d"],"type":"string","default":"5m","title":"Interval"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3650,"minimum":0},{"type":"null"}],"description":"Only contracts expiring within this many days (0: same day).","title":"Dte"},"description":"Only contracts expiring within this many days (0: same day)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsFlowTimelineResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Net call and put premium, net delta and put/call per interval, oldest first, with the price. Without `symbol`: every single stock (no ETFs or index products), priced by SPY. Intraday intervals cover one session (default the latest); `1d` takes `from`/`to` (default 30 days).\n\nLearn more: [Net call and put premium](https://tradytics.com/learn/what-is-net-options-flow), [same-day](https://tradytics.com/learn/what-are-0dte-options), [Put premium over call premium](https://tradytics.com/learn/what-is-the-put-call-ratio).","externalDocs":{"url":"https://tradytics.com/learn/what-is-net-options-flow","description":"Net call and put premium"}}},"/options/flow/leaders":{"get":{"tags":["Options flow"],"summary":"Flow leaders","operationId":"leaders_options_flow_leaders_get","parameters":[{"name":"by","in":"query","required":false,"schema":{"enum":["symbol","sector"],"type":"string","default":"symbol","title":"By"}},{"name":"direction","in":"query","required":false,"schema":{"enum":["bullish","bearish"],"type":"string","default":"bullish","title":"Direction"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Rows per page, up to 100.","default":25,"title":"Limit"},"description":"Rows per page, up to 100."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsFlowLeadersResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Single stocks, or their sectors, ranked by net premium for the latest session or `date`, with premium against their 20-session average.\n\nLearn more: [net premium](https://tradytics.com/learn/what-is-net-options-flow).","externalDocs":{"url":"https://tradytics.com/learn/what-is-net-options-flow","description":"net premium"}}},"/options/flow/strikes":{"get":{"tags":["Options flow"],"summary":"Flow by strike","operationId":"strikes_options_flow_strikes_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","description":"Underlying, e.g. `NVDA`.","title":"Symbol"},"description":"Underlying, e.g. `NVDA`."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"expiry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One expiry, `YYYY-MM-DD`.","title":"Expiry"},"description":"One expiry, `YYYY-MM-DD`."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsFlowStrikesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Premium by strike and expiry for one underlying over the latest session, `date` or a range, busiest first.\n\nLearn more: [Premium by strike](https://tradytics.com/learn/what-is-whales-positioning).","externalDocs":{"url":"https://tradytics.com/learn/what-is-whales-positioning","description":"Premium by strike"}}},"/options/unusual":{"get":{"tags":["Options flow"],"summary":"Unusual contracts","operationId":"unusual_options_unusual_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlyings, comma separated (e.g. `NVDA,AMD`). Default all.","title":"Symbol"},"description":"Underlyings, comma separated (e.g. `NVDA,AMD`). Default all."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["call","put"],"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"min_premium","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Minimum premium in the contract's prints, USD.","default":100000,"title":"Min Premium"},"description":"Minimum premium in the contract's prints, USD."},{"name":"sort","in":"query","required":false,"schema":{"enum":["premium","volume_to_open_interest"],"type":"string","default":"premium","title":"Sort"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."},{"name":"include_spreads","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Spreads"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsUnusualResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Contracts whose session volume ran past their open interest, for the latest session or `date`. Largest premium first. Tagged spreads and complex legs are excluded by default. Use `include_spreads=true` to include them in gross premium.\n\nLearn more: [session volume ran past their open interest](https://tradytics.com/learn/volume-vs-open-interest).","externalDocs":{"url":"https://tradytics.com/learn/volume-vs-open-interest","description":"session volume ran past their open interest"}}},"/options/flow/{id}":{"get":{"tags":["Options flow"],"summary":"One print","operationId":"print__options_flow__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","maximum":18446744073709551615,"minimum":1,"description":"A print's `id`.","title":"Id"},"description":"A print's `id`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionPrintDetailResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One options print with the session's flow up to it, and what the contract did after: its close the next session and its value at expiry (the latest close until then). `outcome` is null until the session after the print has closed, or the contract has expired.\n\nLearn more: [options print](https://tradytics.com/learn/how-to-read-options-flow), [Premium](https://tradytics.com/learn/options-premium-vs-contracts), [inferred trade side](https://tradytics.com/learn/how-to-tell-if-options-were-bought-or-sold), [across exchanges](https://tradytics.com/learn/sweep-vs-block-vs-split), [Size above the open interest](https://tradytics.com/learn/opening-or-closing-options-trade).","externalDocs":{"url":"https://tradytics.com/learn/how-to-read-options-flow","description":"options print"}}},"/options/chain":{"get":{"tags":["Options contracts"],"summary":"Option chain","operationId":"chain_options_chain_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Underlying, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Underlying, e.g. `AAPL`."},{"name":"expiry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One expiry, `YYYY-MM-DD`.","title":"Expiry"},"description":"One expiry, `YYYY-MM-DD`."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["call","put"],"type":"string"},{"type":"null"}],"description":"`call` or `put`.","title":"Type"},"description":"`call` or `put`."},{"name":"min_dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Fewest days to expiry.","title":"Min Dte"},"description":"Fewest days to expiry."},{"name":"max_dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Most days to expiry.","title":"Max Dte"},"description":"Most days to expiry."},{"name":"min_strike","in":"query","required":false,"schema":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}],"description":"Lowest strike.","title":"Min Strike"},"description":"Lowest strike."},{"name":"max_strike","in":"query","required":false,"schema":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}],"description":"Highest strike.","title":"Max Strike"},"description":"Highest strike."},{"name":"min_otm_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Least out of the money, % (negative: in the money).","title":"Min Otm Pct"},"description":"Least out of the money, % (negative: in the money)."},{"name":"max_otm_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Most out of the money, %.","title":"Max Otm Pct"},"description":"Most out of the money, %."},{"name":"min_delta","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"description":"Lowest absolute delta.","title":"Min Delta"},"description":"Lowest absolute delta."},{"name":"max_delta","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"description":"Highest absolute delta.","title":"Max Delta"},"description":"Highest absolute delta."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsChainResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"A symbol's standard contracts (100 shares) with quotes, volume, open interest, IV and greeks, live (refreshed every 30 seconds) or any session since 2026-11-06 at its close. Sorted by expiry, strike, calls first.\n\nLearn more: [open interest](https://tradytics.com/learn/what-is-open-interest), [out of the money](https://tradytics.com/learn/itm-atm-otm), [Implied volatility](https://tradytics.com/learn/what-is-implied-volatility), [Greeks](https://tradytics.com/learn/options-greeks-explained).","externalDocs":{"url":"https://tradytics.com/learn/what-is-open-interest","description":"open interest"}}},"/options/expirations":{"get":{"tags":["Options contracts"],"summary":"Expirations","operationId":"expirations_options_expirations_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Underlying, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Underlying, e.g. `AAPL`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsExpirationsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every listed expiry, soonest first, with its contracts, strikes and cycle.\n\nLearn more: [cycle](https://tradytics.com/learn/what-is-opex).","externalDocs":{"url":"https://tradytics.com/learn/what-is-opex","description":"cycle"}}},"/options/contracts":{"get":{"tags":["Options contracts"],"summary":"Contracts","operationId":"contracts_options_contracts_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One or more underlyings, comma separated. Default the whole market.","title":"Symbol"},"description":"One or more underlyings, comma separated. Default the whole market."},{"name":"sort","in":"query","required":false,"schema":{"enum":["volume","premium","iv","iv_change","open_interest","open_interest_change"],"type":"string","default":"volume","title":"Sort"}},{"name":"order","in":"query","required":false,"schema":{"enum":["desc","asc"],"type":"string","default":"desc","title":"Order"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["call","put"],"type":"string"},{"type":"null"}],"description":"`call` or `put`.","title":"Type"},"description":"`call` or `put`."},{"name":"expiry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One expiry, `YYYY-MM-DD`.","title":"Expiry"},"description":"One expiry, `YYYY-MM-DD`."},{"name":"min_dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Fewest days to expiry.","title":"Min Dte"},"description":"Fewest days to expiry."},{"name":"max_dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Most days to expiry.","title":"Max Dte"},"description":"Most days to expiry."},{"name":"min_otm_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Least out of the money, % (negative: in the money).","title":"Min Otm Pct"},"description":"Least out of the money, % (negative: in the money)."},{"name":"max_otm_pct","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Most out of the money, %.","title":"Max Otm Pct"},"description":"Most out of the money, %."},{"name":"min_delta","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"description":"Lowest absolute delta.","title":"Min Delta"},"description":"Lowest absolute delta."},{"name":"max_delta","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"description":"Highest absolute delta.","title":"Max Delta"},"description":"Highest absolute delta."},{"name":"min_volume","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Volume"}},{"name":"min_open_interest","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Open Interest"}},{"name":"min_price","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Min Price"}},{"name":"max_price","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Max Price"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsContractsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Contracts of the ~4,000 most traded stocks and ETFs at the latest close (or `date`'s), ranked by volume, premium, IV, open interest or the change in either: the options screener.\n\nLearn more: [volume, premium](https://tradytics.com/learn/options-premium-vs-contracts), [options screener](https://tradytics.com/learn/options-market-data-api), [out of the money](https://tradytics.com/learn/itm-atm-otm), [Volume over open interest](https://tradytics.com/learn/volume-vs-open-interest), [Implied volatility](https://tradytics.com/learn/what-is-implied-volatility), [Greeks](https://tradytics.com/learn/options-greeks-explained).","externalDocs":{"url":"https://tradytics.com/learn/options-premium-vs-contracts","description":"volume, premium"}}},"/options/contracts/{contract}":{"get":{"tags":["Options contracts"],"summary":"Contract","operationId":"one_options_contracts__contract__get","parameters":[{"name":"contract","in":"path","required":true,"schema":{"type":"string","description":"OCC symbol, e.g. `NVDA261218C00150000` (`O:` prefix optional).","title":"Contract"},"description":"OCC symbol, e.g. `NVDA261218C00150000` (`O:` prefix optional)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsContractsContractResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One contract with its latest quote, trades and open interest. It uses the saved closing quote outside regular hours or while waiting for a new two-sided quote. IV and greeks use the official stock close for that snapshot.\n\nLearn more: [greeks](https://tradytics.com/learn/options-greeks-explained).","externalDocs":{"url":"https://tradytics.com/learn/options-greeks-explained","description":"greeks"}}},"/options/contracts/{contract}/bars":{"get":{"tags":["Options contracts"],"summary":"Contract bars","operationId":"contract_bars_options_contracts__contract__bars_get","parameters":[{"name":"contract","in":"path","required":true,"schema":{"type":"string","description":"OCC symbol, e.g. `NVDA261218C00150000` (`O:` prefix optional).","title":"Contract"},"description":"OCC symbol, e.g. `NVDA261218C00150000` (`O:` prefix optional)."},{"name":"timeframe","in":"query","required":false,"schema":{"enum":["1m","5m","15m","1h","1d"],"type":"string","default":"1d","title":"Timeframe"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":500,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsContractsContractBarsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"OHLCV bars with VWAP for one contract, oldest first. Without `from`: 5 days of `1m`, 10 of `5m`, 20 of `15m`, 60 of `1h`, a year of `1d`.\n\nLearn more: [OHLCV bars](https://tradytics.com/learn/options-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/options-market-data-api","description":"OHLCV bars"}}},"/options/open-interest":{"get":{"tags":["Options contracts"],"summary":"Open interest","operationId":"open_interest_options_open_interest_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Underlying, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Underlying, e.g. `AAPL`."},{"name":"by","in":"query","required":false,"schema":{"enum":["strike","expiry"],"type":"string","default":"strike","title":"By"}},{"name":"expiry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One expiry, `YYYY-MM-DD`.","title":"Expiry"},"description":"One expiry, `YYYY-MM-DD`."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":1000,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsOpenInterestResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Call and put open interest by strike or by expiry with the change since the session before, at the latest close (or `date`'s).\n\nLearn more: [open interest](https://tradytics.com/learn/what-is-open-interest).","externalDocs":{"url":"https://tradytics.com/learn/what-is-open-interest","description":"open interest"}}},"/options/exposure":{"get":{"tags":["Dealer positioning"],"summary":"Dealer exposure","description":"Gamma exposure estimates how much dealer hedging changes per 1% move. Use `symbol=SPX&greek=gamma&dte=0` for SPX 0DTE GEX, updated every 30 seconds during regular market hours. Use `date` for a session’s latest run or `at` for a specific instant. The spot and levels come from that run. Pass `limit` to page through `data.rows` and follow `data.next_cursor`.\n\nLearn more: [Gamma exposure](https://tradytics.com/learn/what-is-gamma-exposure-gex), [0DTE GEX](https://tradytics.com/learn/what-is-0dte-gex), [vanna and charm exposure](https://tradytics.com/learn/what-are-vanna-and-charm-exposure), [Who the dealers are short and long](https://tradytics.com/learn/how-tradytics-models-dealer-positioning), [call and put walls](https://tradytics.com/learn/call-wall-and-put-wall), [gamma flip](https://tradytics.com/learn/what-is-the-gamma-flip), [max pain](https://tradytics.com/learn/what-is-max-pain).","operationId":"exposure_options_exposure_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","description":"Underlying, e.g. `SPY`.","title":"Symbol"},"description":"Underlying, e.g. `SPY`."},{"name":"greek","in":"query","required":false,"schema":{"enum":["gamma","delta","vanna","charm"],"type":"string","default":"gamma","title":"Greek"}},{"name":"by","in":"query","required":false,"schema":{"enum":["strike","expiry"],"type":"string","default":"strike","title":"By"}},{"name":"expiry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One expiry, `YYYY-MM-DD`. Default all.","title":"Expiry"},"description":"One expiry, `YYYY-MM-DD`. Default all."},{"name":"dte","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3650,"minimum":0},{"type":"null"}],"description":"Only expiries within this many days (0: same day).","title":"Dte"},"description":"Only expiries within this many days (0: same day)."},{"name":"at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A moment, RFC 3339 (e.g. `2026-11-05T15:30:00Z`): the data as it stood then.","title":"At"},"description":"A moment, RFC 3339 (e.g. `2026-11-05T15:30:00Z`): the data as it stood then."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Rows to return. Omit to return all rows.","title":"Limit"},"description":"Rows to return. Omit to return all rows."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pass the previous page's `next_cursor`.","title":"Cursor"},"description":"Pass the previous page's `next_cursor`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsExposureResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"externalDocs":{"url":"https://tradytics.com/learn/what-is-gamma-exposure-gex","description":"Gamma exposure"}}},"/options/exposure/history":{"get":{"tags":["Dealer positioning"],"summary":"Dealer exposure history","operationId":"history_options_exposure_history_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","description":"Underlying, e.g. `SPY`.","title":"Symbol"},"description":"Underlying, e.g. `SPY`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Rows to return. Omit to return all rows.","title":"Limit"},"description":"Rows to return. Omit to return all rows."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pass the previous page's `next_cursor`.","title":"Cursor"},"description":"Pass the previous page's `next_cursor`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsExposureHistoryResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Daily dealer net delta and net gamma against the close, each session of about 18 months, oldest first.\n\nLearn more: [net gamma](https://tradytics.com/learn/what-is-gamma-exposure-gex).","externalDocs":{"url":"https://tradytics.com/learn/what-is-gamma-exposure-gex","description":"net gamma"}}},"/options/volatility":{"get":{"tags":["Volatility"],"summary":"Volatility","operationId":"volatility_options_volatility_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Underlying, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Underlying, e.g. `AAPL`."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsVolatilityResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One symbol's 30-day ATM IV against its past year and its realized vol, the ATM term structure, 25-delta skew and the moves options price. Live in regular hours until the close is stored (about 16:25 New York), then that close.\n\nLearn more: [the ATM term structure, 25-delta skew](https://tradytics.com/learn/options-volatility-surface), [Share of the past year's sessions with lower](https://tradytics.com/learn/iv-rank-vs-iv-percentile), [expected move](https://tradytics.com/learn/what-is-the-expected-move).","externalDocs":{"url":"https://tradytics.com/learn/options-volatility-surface","description":"the ATM term structure, 25-delta skew"}}},"/options/volatility/history":{"get":{"tags":["Volatility"],"summary":"Volatility history","operationId":"volatility_history_options_volatility_history_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Underlying, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Underlying, e.g. `AAPL`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OptionsVolatilityHistoryResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Daily 30-day ATM IV with its rank and percentile, realized vol and the close, oldest first, from November 2025.\n\nLearn more: [rank and percentile](https://tradytics.com/learn/iv-rank-vs-iv-percentile).","externalDocs":{"url":"https://tradytics.com/learn/iv-rank-vs-iv-percentile","description":"rank and percentile"}}},"/darkpool/prints":{"get":{"tags":["Dark pool"],"summary":"Dark pool prints","operationId":"prints_darkpool_prints_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tickers, comma separated. Default all.","title":"Symbol"},"description":"Tickers, comma separated. Default all."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":18446744073709551615,"minimum":0},{"type":"null"}],"description":"Only rows after this `id`, oldest first (polling).","title":"Since"},"description":"Only rows after this `id`, oldest first (polling)."},{"name":"min_notional","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Minimum notional, USD.","default":0,"title":"Min Notional"},"description":"Minimum notional, USD."},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["trade","close","open"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"venue","in":"query","required":false,"schema":{"anyOf":[{"enum":["dark_pool","exchange","all"],"type":"string"},{"type":"null"}],"title":"Venue"}},{"name":"max_rank","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Only prints ranked this high or better in the stock's last 12 months.","title":"Max Rank"},"description":"Only prints ranked this high or better in the stock's last 12 months."},{"name":"sort","in":"query","required":false,"schema":{"enum":["time","notional"],"type":"string","default":"time","title":"Sort"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DarkPoolPrintListResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Off-exchange block prints, newest or largest first. Use `venue=exchange` for exchange blocks or `venue=all` for both. Opening and closing auction requests default to exchange venues. Gross price outliers are excluded using quote or unadjusted session prices. Ranks appear after a session is ranked. Pass `since` to poll the live session as prints arrive.\n\nLearn more: [Off-exchange block prints](https://tradytics.com/learn/what-are-dark-pool-prints), [Sale conditions](https://tradytics.com/learn/how-to-read-dark-pool-prints), [Its place by notional](https://tradytics.com/learn/ranked-dark-pool-prints).","externalDocs":{"url":"https://tradytics.com/learn/what-are-dark-pool-prints","description":"Off-exchange block prints"}}},"/darkpool/levels":{"get":{"tags":["Dark pool"],"summary":"Dark pool levels","operationId":"levels_darkpool_levels_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","description":"Ticker, e.g. `AAPL`.","title":"Symbol"},"description":"Ticker, e.g. `AAPL`."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"window","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"description":"Sessions, up to 250, ending at `date` (default the latest).","default":10,"title":"Window"},"description":"Sessions, up to 250, ending at `date` (default the latest)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Levels, up to 200.","default":20,"title":"Limit"},"description":"Levels, up to 200."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DarkpoolLevelsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"The price levels with the most dark pool block money over the last `window` sessions to `date`, biggest first: off-exchange block trades in bins of 0.25% of the last close.\n\nLearn more: [price levels](https://tradytics.com/learn/what-are-dark-pool-levels).","externalDocs":{"url":"https://tradytics.com/learn/what-are-dark-pool-levels","description":"price levels"}}},"/darkpool/daily":{"get":{"tags":["Dark pool"],"summary":"Dark pool by day","operationId":"daily_darkpool_daily_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One ticker. Leave out for the session's top names.","title":"Symbol"},"description":"One ticker. Leave out for the session's top names."},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Names per page, up to 1000 (market-wide).","default":100,"title":"Limit"},"description":"Names per page, up to 1000 (market-wide)."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DarkpoolDailyResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Session totals newest first: one stock's sessions (default the last year, zeros on a session it traded without blocks), or without `symbol` one session's names by dark pool notional. Daily ranks use the rolling 12 months ending on each session.\n\nLearn more: [Session totals](https://tradytics.com/learn/ranked-dark-pool-prints).","externalDocs":{"url":"https://tradytics.com/learn/ranked-dark-pool-prints","description":"Session totals"}}},"/stocks/quotes":{"get":{"tags":["Stocks"],"summary":"Quotes","operationId":"quotes_stocks_quotes_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Up to 100 comma-separated tickers. Omit for every tracked symbol, most traded first.","title":"Symbol"},"description":"Up to 100 comma-separated tickers. Omit for every tracked symbol, most traded first."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksQuotesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Quotes for up to 100 distinct tickers, or the full market ranked by dollar volume. Refreshes about every 30 seconds. meta.as_of is the snapshot time; price_at is the source minute.\n\nLearn more: [Quotes](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"Quotes"}}},"/stocks/bars":{"get":{"tags":["Stocks"],"summary":"Bars","operationId":"bars_stocks_bars_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"title":"Symbol","type":"string"}},{"name":"timeframe","in":"query","required":false,"schema":{"enum":["1s","1m","5m","15m","30m","1h","4h","1d","1w"],"type":"string","default":"1d","title":"Timeframe"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"description":"Bars per page, up to 5000.","default":500,"title":"Limit"},"description":"Bars per page, up to 5000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockBarListResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Split-adjusted OHLCV bars with VWAP, oldest first, including the forming bar. Daily and weekly bars go back to 2004 for every US stock; intraday bars cover two years of the ~3,000 most traded symbols and the four major indices, 1-second bars the last 7 days.\n\nLearn more: [OHLCV bars](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"OHLCV bars"}}},"/stocks/snapshot":{"get":{"tags":["Stocks"],"summary":"Market snapshot","operationId":"snapshot_stocks_snapshot_get","parameters":[{"name":"sort","in":"query","required":false,"schema":{"enum":["symbol","price","change","change_pct","volume","dollar_volume_usd","relative_volume","market_cap_usd"],"type":"string","default":"dollar_volume_usd","title":"Sort"}},{"name":"order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"desc","title":"Order"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["stock","etf","adr","index"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"sector","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector"}},{"name":"min_market_cap_usd","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Min Market Cap Usd"}},{"name":"min_dollar_volume_usd","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Min Dollar Volume Usd"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksSnapshotResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Rank stocks, funds and indices by move, volume or size. All rows have a price from the session in `meta.date`. Use Quotes for the last price even when it is from an earlier session.\n\nLearn more: [move, volume or size](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"move, volume or size"}}},"/stocks/technicals":{"get":{"tags":["Stocks"],"summary":"Technicals","operationId":"technicals_stocks_technicals_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"title":"Symbol","type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksTechnicalsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"A technical rating with the signals, moving averages and oscillators behind it, and monthly seasonality, on daily bars through today.\n\nLearn more: [technical rating](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"technical rating"}}},"/stocks/short-interest":{"get":{"tags":["Stocks"],"summary":"Short interest","operationId":"short_interest_stocks_short_interest_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"title":"Symbol","type":"string"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksShortInterestResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Short interest at every FINRA settlement date, twice a month, newest first.\n\nLearn more: [Short interest](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"Short interest"}}},"/stocks/short-volume":{"get":{"tags":["Stocks"],"summary":"Short volume","operationId":"short_volume_stocks_short_volume_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"title":"Symbol","type":"string"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksShortVolumeResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Daily off-exchange short sale volume reported to FINRA, newest first.\n\nLearn more: [off-exchange short sale volume](https://tradytics.com/learn/dark-pool-volume-vs-short-volume).","externalDocs":{"url":"https://tradytics.com/learn/dark-pool-volume-vs-short-volume","description":"off-exchange short sale volume"}}},"/stocks/corporate-actions":{"get":{"tags":["Stocks"],"summary":"Dividends and splits","operationId":"corporate_actions_stocks_corporate_actions_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["dividend","split"],"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksCorporateActionsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Dividends and splits, newest first: one symbol's whole history, or the whole market's within up to 93 days (default a week back to a month ahead)."}},"/fundamentals/profile":{"get":{"tags":["Fundamentals"],"summary":"Company profile","operationId":"profile_fundamentals_profile_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsProfileResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"The company, its size and its valuation at the price now.\n\nLearn more: [valuation](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"valuation"}}},"/fundamentals/income-statement":{"get":{"tags":["Fundamentals"],"summary":"Income statement","operationId":"income_fundamentals_income_statement_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"period","in":"query","required":false,"schema":{"enum":["quarter","annual","ttm"],"type":"string","default":"quarter","title":"Period"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Periods, newest first, up to 200 (every filing since 2009).","default":12,"title":"Limit"},"description":"Periods, newest first, up to 200 (every filing since 2009)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsIncomeStatementResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Quarterly, annual or trailing-twelve-month income statements from the 10-Qs and 10-Ks, newest first, at the latest filed figures; a renamed ticker keeps its history (`META` includes its years as `FB`). Q4 is the year less nine months. A line the filing doesn't show, or shows as zero, is `null`.\n\nLearn more: [income statements](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"income statements"}}},"/fundamentals/balance-sheet":{"get":{"tags":["Fundamentals"],"summary":"Balance sheet","operationId":"balance_fundamentals_balance_sheet_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"period","in":"query","required":false,"schema":{"enum":["quarter","annual"],"type":"string","default":"quarter","title":"Period"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Periods, newest first, up to 200 (every filing since 2009).","default":12,"title":"Limit"},"description":"Periods, newest first, up to 200 (every filing since 2009)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsBalanceSheetResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Quarterly or annual balance sheets from the 10-Qs and 10-Ks, newest first, at the latest filed figures. A line the filing doesn't show, or shows as zero, is `null`.\n\nLearn more: [balance sheets](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"balance sheets"}}},"/fundamentals/cash-flow":{"get":{"tags":["Fundamentals"],"summary":"Cash flow statement","operationId":"cash_flow_fundamentals_cash_flow_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"period","in":"query","required":false,"schema":{"enum":["quarter","annual","ttm"],"type":"string","default":"quarter","title":"Period"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Periods, newest first, up to 200 (every filing since 2009).","default":12,"title":"Limit"},"description":"Periods, newest first, up to 200 (every filing since 2009)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsCashFlowResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Quarterly, annual or trailing-twelve-month cash flow statements, newest first: a quarter is the filing's year to date less the quarter before's. A line the filing doesn't show, or shows as zero, is `null`.\n\nLearn more: [cash flow statements](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"cash flow statements"}}},"/fundamentals/ratios":{"get":{"tags":["Fundamentals"],"summary":"Ratios","operationId":"ratios_fundamentals_ratios_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Days, newest first, up to 1000.","default":100,"title":"Limit"},"description":"Days, newest first, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsRatiosResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Valuation, margin, return and balance sheet ratios on the trailing twelve months: at the price now, or at each close since 2009 with `from` and `to`, on the statements on file that day.\n\nLearn more: [Valuation, margin, return and balance sheet ratios](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"Valuation, margin, return and balance sheet ratios"}}},"/fundamentals/segments":{"get":{"tags":["Fundamentals"],"summary":"Revenue segments","operationId":"segments_fundamentals_segments_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"by","in":"query","required":false,"schema":{"enum":["product","region"],"type":"string","default":"product","title":"By"}},{"name":"period","in":"query","required":false,"schema":{"enum":["annual","quarter"],"type":"string","default":"annual","title":"Period"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsSegmentsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Revenue by product line or by region as reported, newest period first, largest segment first."}},"/fundamentals/earnings":{"get":{"tags":["Fundamentals"],"summary":"Earnings","operationId":"earnings_fundamentals_earnings_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Reports, newest first, up to 1000.","default":40,"title":"Limit"},"description":"Reports, newest first, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsEarningsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every report with EPS and revenue against the estimates, newest first. The next report comes first, its actuals `null`.\n\nLearn more: [EPS and revenue against the estimates](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"EPS and revenue against the estimates"}}},"/fundamentals/estimates":{"get":{"tags":["Fundamentals"],"summary":"Analyst estimates","operationId":"estimates_fundamentals_estimates_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"period","in":"query","required":false,"schema":{"enum":["annual","quarter"],"type":"string","default":"annual","title":"Period"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsEstimatesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Analyst estimates for each fiscal period the company has yet to report, nearest first.\n\nLearn more: [Analyst estimates](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"Analyst estimates"}}},"/fundamentals/analysts":{"get":{"tags":["Fundamentals"],"summary":"Analysts","operationId":"analysts_fundamentals_analysts_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsAnalystsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Ratings consensus, price targets and the latest 50 calls by firm.\n\nLearn more: [Ratings consensus, price targets](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"Ratings consensus, price targets"}}},"/fundamentals/transcripts":{"get":{"tags":["Fundamentals"],"summary":"Earnings call transcripts","operationId":"transcripts_fundamentals_transcripts_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1990},{"type":"null"}],"description":"Fiscal year.","title":"Year"},"description":"Fiscal year."},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":4,"minimum":1},{"type":"null"}],"description":"Fiscal quarter, 1 to 4. Needs `year`.","title":"Quarter"},"description":"Fiscal quarter, 1 to 4. Needs `year`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsTranscriptsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Earnings call transcripts: the latest, one quarter, or every quarter of a fiscal year. A 404 for a requested fiscal period means its transcript is unavailable."}},"/fundamentals/etf-holdings":{"get":{"tags":["Fundamentals"],"summary":"ETF holdings","operationId":"etf_holdings_fundamentals_etf_holdings_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Holdings, biggest first, up to 1000.","default":100,"title":"Limit"},"description":"Holdings, biggest first, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsEtfHoldingsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"ETF holdings, largest weight first, as its issuer last published.\n\nLearn more: [ETF holdings](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"ETF holdings"}}},"/filings":{"get":{"tags":["Filings"],"summary":"List filings","operationId":"filings_filings_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every filer.","title":"Symbol"},"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every filer."},{"name":"form","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Form types, comma separated, e.g. `10-K,10-Q,8-K`.","title":"Form"},"description":"Form types, comma separated, e.g. `10-K,10-Q,8-K`."},{"name":"item","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"8-K items, comma separated, e.g. `2.02,5.02`.","title":"Item"},"description":"8-K items, comma separated, e.g. `2.02,5.02`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Filings newest first, for the whole market or a few companies, by form, 8-K item and date."}},"/filings/search":{"get":{"tags":["Filings"],"summary":"Search filings","operationId":"search_filings_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":1000,"description":"Natural language question or topic.","title":"Q"},"description":"Natural language question or topic."},{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma separated tickers. Default all indexed issuers.","title":"Symbol"},"description":"Comma separated tickers. Default all indexed issuers."},{"name":"form","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Form types, comma separated, e.g. `10-K,10-Q,8-K`.","title":"Form"},"description":"Form types, comma separated, e.g. `10-K,10-Q,8-K`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"First filing date, inclusive.","title":"From"},"description":"First filing date, inclusive."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last filing date, inclusive.","title":"To"},"description":"Last filing date, inclusive."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Source documents per page, up to 100.","default":25,"title":"Limit"},"description":"Source documents per page, up to 100."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingSearchResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Find SEC filings by meaning. Each result includes the best matching passage in that EDGAR document. The five-year index covers 10-K, 10-Q, and 8-K filings that report Item 2.02 results, including amendments. During backfill, search covers completed issuers and `meta.coverage.complete` is false.\n\nLearn more: [SEC filings](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"SEC filings"}}},"/filings/{accession}":{"get":{"tags":["Filings"],"summary":"Filing","operationId":"filing_filings__accession__get","parameters":[{"name":"accession","in":"path","required":true,"schema":{"type":"string","description":"Accession number, e.g. `0000320193-25-000079`.","title":"Accession"},"description":"Accession number, e.g. `0000320193-25-000079`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsAccessionResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One filing with every document and exhibit in it."}},"/filings/{accession}/sections":{"get":{"tags":["Filings"],"summary":"Filing sections","operationId":"filing_sections_filings__accession__sections_get","parameters":[{"name":"accession","in":"path","required":true,"schema":{"type":"string","description":"Accession number, e.g. `0000320193-25-000079`.","title":"Accession"},"description":"Accession number, e.g. `0000320193-25-000079`."},{"name":"section","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"description":"Sections, comma separated, e.g. `risk_factors,mda`, or 8-K items like `2.02`.","title":"Section"},"description":"Sections, comma separated, e.g. `risk_factors,mda`, or 8-K items like `2.02`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsAccessionSectionsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Sections of a 10-K, 10-Q or 8-K as plain text. A section asked for the first time can answer `warming_up` for a few seconds."}},"/disclosures/insiders":{"get":{"tags":["Disclosures"],"summary":"Insider trades","operationId":"insiders_disclosures_insiders_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every company.","title":"Symbol"},"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every company."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma separated: `buy`, `conversion`, `disposition`, `exercise`, `expiration`, `gift`, `grant`, `inheritance`, `other`, `sell`, `tax`.","title":"Type"},"description":"Comma separated: `buy`, `conversion`, `disposition`, `exercise`, `expiration`, `gift`, `grant`, `inheritance`, `other`, `sell`, `tax`."},{"name":"min_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Smallest `value_usd`, e.g. `1000000`.","title":"Min Value"},"description":"Smallest `value_usd`, e.g. `1000000`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"include_amended","in":"query","required":false,"schema":{"type":"boolean","description":"Also the filings a later amendment replaced, each with `amended_by`.","default":false,"title":"Include Amended"},"description":"Also the filings a later amendment replaced, each with `amended_by`."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresInsidersResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every Form 4 transaction, newest filing first: officers, directors and 10% owners buying, selling, exercising and receiving stock. Two years back, new ones within a minute of filing.\n\nLearn more: [officers, directors and 10% owners](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"officers, directors and 10% owners"}}},"/disclosures/institutions":{"get":{"tags":["Disclosures"],"summary":"Institutional holders","operationId":"institutions_disclosures_institutions_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `AAPL`."},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter end, `YYYY-MM-DD` or `2026Q2`. Default the latest quarter past its filing deadline.","title":"Quarter"},"description":"Quarter end, `YYYY-MM-DD` or `2026Q2`. Default the latest quarter past its filing deadline."},{"name":"put_call","in":"query","required":false,"schema":{"anyOf":[{"enum":["call","put"],"type":"string"},{"type":"null"}],"description":"Option positions instead of shares.","title":"Put Call"},"description":"Option positions instead of shares."},{"name":"include_amended","in":"query","required":false,"schema":{"type":"boolean","description":"Also the filings a later amendment replaced, each with `amended_by`.","default":false,"title":"Include Amended"},"description":"Also the filings a later amendment replaced, each with `amended_by`."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresInstitutionsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every institution that reported a stock on its 13F for a quarter, biggest position first, with what it bought or sold since the quarter before. The last 8 quarters."}},"/disclosures/institutions/{cik}":{"get":{"tags":["Disclosures"],"summary":"Institution's holdings","operationId":"institution_disclosures_institutions__cik__get","parameters":[{"name":"cik","in":"path","required":true,"schema":{"type":"integer","maximum":9999999999,"minimum":1,"description":"The manager's SEC CIK, e.g. `1067983` (Berkshire Hathaway).","title":"Cik"},"description":"The manager's SEC CIK, e.g. `1067983` (Berkshire Hathaway)."},{"name":"quarter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter end, `YYYY-MM-DD` or `2026Q2`. Default the latest quarter past its filing deadline.","title":"Quarter"},"description":"Quarter end, `YYYY-MM-DD` or `2026Q2`. Default the latest quarter past its filing deadline."},{"name":"include_amended","in":"query","required":false,"schema":{"type":"boolean","description":"Also the filings a later amendment replaced, each with `amended_by`.","default":false,"title":"Include Amended"},"description":"Also the filings a later amendment replaced, each with `amended_by`."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresInstitutionsCikResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One institution's whole 13F book for a quarter, biggest position first, with the changes from the quarter before."}},"/disclosures/activists":{"get":{"tags":["Disclosures"],"summary":"Activist and passive stakes","operationId":"activists_disclosures_activists_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every company.","title":"Symbol"},"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every company."},{"name":"form","in":"query","required":false,"schema":{"anyOf":[{"enum":["13d","13g"],"type":"string"},{"type":"null"}],"description":"`13d` activist, `13g` passive.","title":"Form"},"description":"`13d` activist, `13g` passive."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresActivistsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Schedule 13D (activist) and 13G (passive) filings of holders of 5% or more, newest first. Two years back."}},"/disclosures/congress":{"get":{"tags":["Disclosures"],"summary":"Congress trades","operationId":"congress_disclosures_congress_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every company.","title":"Symbol"},"description":"Ticker symbols, comma separated, e.g. `AAPL,NVDA`. Default every company."},{"name":"chamber","in":"query","required":false,"schema":{"anyOf":[{"enum":["house","senate"],"type":"string"},{"type":"null"}],"title":"Chamber"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma separated: `buy`, `sell`, `exchange`, `other`.","title":"Type"},"description":"Comma separated: `buy`, `sell`, `exchange`, `other`."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisclosuresCongressResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Stock trades members of the House and Senate disclosed, newest disclosure first. Three years back.\n\nLearn more: [Stock trades members of the House and Senate disclosed](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"Stock trades members of the House and Senate disclosed"}}},"/kpis":{"get":{"tags":["KPIs"],"summary":"KPIs","operationId":"kpis_kpis_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"description":"Ticker symbol, e.g. `TSLA`.","title":"Symbol","type":"string"},"description":"Ticker symbol, e.g. `TSLA`."},{"name":"kpi","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"description":"KPI ids, comma separated, e.g. `deliveries,production`. Default every KPI.","title":"Kpi"},"description":"KPI ids, comma separated, e.g. `deliveries,production`. Default every KPI."},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["reported","tracked"],"type":"string"},{"type":"null"}],"description":"`reported` (from filings) or `tracked` (from the web).","title":"Kind"},"description":"`reported` (from filings) or `tracked` (from the web)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KpisResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One company's KPI values, newest first: each fiscal quarter's numbers from its results release, 10-Q or 10-K, and the weekly numbers tracked for it."}},"/kpis/definitions":{"get":{"tags":["KPIs"],"summary":"KPI definitions","operationId":"definitions_kpis_definitions_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker symbol, e.g. `TSLA`. Default every company covered.","title":"Symbol"},"description":"Ticker symbol, e.g. `TSLA`. Default every company covered."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KpisDefinitionsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"The KPIs covered for each company, the periods they span, and whether the company still reports them. A KPI is never removed: one the company stops reporting is `stopped`, one it redefines is `replaced` by a new id from that quarter on."}},"/market/status":{"get":{"tags":["Market"],"summary":"Market status","operationId":"status_market_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketStatusResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Whether the market is open now, the next open and close, and the holidays and early closes ahead."}},"/market/indices":{"get":{"tags":["Market"],"summary":"Indices","operationId":"indices_market_indices_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketIndicesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Live index quotes for the S&P 500, Nasdaq 100, Russell 2000, Dow Jones Industrial Average and VIX.\n\nLearn more: [Live index quotes](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"Live index quotes"}}},"/market/breadth":{"get":{"tags":["Market"],"summary":"Breadth","operationId":"breadth_market_breadth_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketBreadthResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Market breadth for liquid stocks and ADRs ($20M+ traded today, funds left out): how many rose or fell, the distribution of returns, and the equal-weight S&P 500 against the cap-weighted one.\n\nLearn more: [Market breadth](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"Market breadth"}}},"/market/sectors":{"get":{"tags":["Market"],"summary":"Sectors and themes","operationId":"sectors_market_sectors_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"enum":["sector","theme"],"type":"string","default":"sector","title":"Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketSectorsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"The 11 sectors through their SPDR ETFs, or investing themes as equal-weight baskets. Daily moves, member counts and rankings use quotes from the session in `meta.date`.\n\nLearn more: [sectors](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"sectors"}}},"/calendar/earnings":{"get":{"tags":["Calendar and news"],"summary":"Earnings calendar","operationId":"earnings_calendar_earnings_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEarningsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Reports by date then company size, with estimates and results. Actuals use the same filed figures and verified releases as `/fundamentals/earnings`. Without `symbol`, every US listing in the range, past or ahead (default the next 7 days, up to 93 a call); with it, the company's whole history, newest first.\n\nLearn more: [estimates and results](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"estimates and results"}}},"/calendar/economic":{"get":{"tags":["Calendar and news"],"summary":"Economic calendar","operationId":"economic_calendar_economic_get","parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":3,"description":"A two-letter country code, `EU`, or `all`.","default":"US","title":"Country"},"description":"A two-letter country code, `EU`, or `all`."},{"name":"impact","in":"query","required":false,"schema":{"anyOf":[{"enum":["low","medium","high"],"type":"string"},{"type":"null"}],"title":"Impact"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEconomicResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Economic releases and central bank events by time. FMP supplies the readings and estimates. The official BEA schedule fills gaps in upcoming US GDP release dates, with readings and estimates null when unavailable. Default the US, yesterday to a week ahead, up to 93 days a call."}},"/news":{"get":{"tags":["Calendar and news"],"summary":"News","operationId":"news_news_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Stories per page, up to 500.","default":50,"title":"Limit"},"description":"Stories per page, up to 500."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Stories newest first, all of them or one symbol's. Default the last 30 days.\n\nLearn more: [Stories](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"Stories"}}},"/screener/stocks":{"get":{"tags":["Screener"],"summary":"Screen stocks","operationId":"stocks_screener_stocks_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated tickers: just these rows, no filters.","title":"Symbol"},"description":"Comma-separated tickers: just these rows, no filters."},{"name":"fields","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated fields to return, or `all`.","title":"Fields"},"description":"Comma-separated fields to return, or `all`."},{"name":"labels","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated label ids; a row must carry all of them.","title":"Labels"},"description":"Comma-separated label ids; a row must carry all of them."},{"name":"sector","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["stock","etf","adr"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Field to sort by. Default `average_dollar_volume_usd`.","title":"Sort"},"description":"Field to sort by. Default `average_dollar_volume_usd`."},{"name":"order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"desc","title":"Order"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerStocksResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"The stock screener filters any numeric field with `min_<field>` and `max_<field>` (`min_relative_volume=2&max_rsi=30`). Prices, volume and labels all come from the same completed scan. For current prices, use Quotes.\n\nLearn more: [stock screener](https://tradytics.com/learn/stock-scanner-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-scanner-api","description":"stock screener"},"x-query-parameter-patterns":[{"pattern":"^min_[a-z][a-z0-9_]*$","schema":{"type":"number"},"description":"Minimum value of a numeric field listed by GET /screener/fields."},{"pattern":"^max_[a-z][a-z0-9_]*$","schema":{"type":"number"},"description":"Maximum value of a numeric field listed by GET /screener/fields."}]}},"/screener/fields":{"get":{"tags":["Screener"],"summary":"Screener fields","operationId":"fields_screener_fields_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerFieldsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every field with its group and type, and every label with its group and lean.\n\nLearn more: [every label](https://tradytics.com/learn/tradytics-scanner).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-scanner","description":"every label"}}},"/signals":{"get":{"tags":["Signals"],"summary":"List signals","operationId":"signals_signals_get","parameters":[{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"enum":["itm-puts","etf-repeat-calls","heavy-calls","opening-calls","burst-calls","index-tide-calls","repeat-flow"],"type":"string"},{"type":"null"}],"description":"One flow pattern.","title":"Source"},"description":"One flow pattern."},{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["open","settled"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Rows per page, up to 500.","default":50,"title":"Limit"},"description":"Rows per page, up to 500."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Signals newest first, today's live.\n\nLearn more: [Signals](https://tradytics.com/learn/tradytics-signals).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-signals","description":"Signals"}}},"/signals/performance":{"get":{"tags":["Signals"],"summary":"Signal performance","operationId":"performance_signals_performance_get","parameters":[{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"enum":["itm-puts","etf-repeat-calls","heavy-calls","opening-calls","burst-calls","index-tide-calls","repeat-flow"],"type":"string"},{"type":"null"}],"description":"One flow pattern. Default every pattern and `all`.","title":"Source"},"description":"One flow pattern. Default every pattern and `all`."},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"enum":["7d","30d","90d","all"],"type":"string"},{"type":"null"}],"description":"`7d`, `30d`, `90d` or `all`. Default each.","title":"Window"},"description":"`7d`, `30d`, `90d` or `all`. Default each."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["open","settled"],"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalsPerformanceResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Each pattern's record from every signal's latest mark or settlement, losers included, over the last 7, 30 and 90 days and all time.\n\nLearn more: [Each pattern's record](https://tradytics.com/learn/options-flow-signals-api).","externalDocs":{"url":"https://tradytics.com/learn/options-flow-signals-api","description":"Each pattern's record"}}},"/signals/{id}":{"get":{"tags":["Signals"],"summary":"Signal","operationId":"one_signals__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","description":"The signal's `id`.","title":"Id"},"description":"The signal's `id`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalsIdResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One signal with the numbers its pattern read, the prints behind it and every mark.\n\nLearn more: [pattern](https://tradytics.com/learn/how-tradytics-signals-are-built).","externalDocs":{"url":"https://tradytics.com/learn/how-tradytics-signals-are-built","description":"pattern"}}},"/insights/market":{"get":{"tags":["Insights"],"summary":"Market digest","operationId":"market_insights_market_get","parameters":[{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One session, `YYYY-MM-DD` (New York).","title":"Date"},"description":"One session, `YYYY-MM-DD` (New York)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsMarketResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"An AI-written market digest with a headline, a summary, three stories and the week's events ahead. Rewritten every 30 minutes in the session.\n\nLearn more: [AI-written market digest](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"AI-written market digest"}}},"/insights/movers":{"get":{"tags":["Insights"],"summary":"Why it's moving","operationId":"movers_insights_movers_get","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated tickers. Omit for every stock with a story, newest first.","title":"Symbol"},"description":"Comma-separated tickers. Omit for every stock with a story, newest first."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Stories per page, up to 500.","default":50,"title":"Limit"},"description":"Stories per page, up to 500."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsMoversResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Each stock's latest story behind its move, newest first: the 100 largest companies and the most viewed, rewritten through the day.\n\nLearn more: [story behind its move](https://tradytics.com/learn/tradytics-research-pages).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-research-pages","description":"story behind its move"}}},"/probabilities":{"get":{"tags":["Probabilities"],"summary":"List questions","operationId":"questions_probabilities_get","parameters":[{"name":"group","in":"query","required":false,"schema":{"anyOf":[{"enum":["close","range","hit","earnings"],"type":"string"},{"type":"null"}],"description":"`close`, `range`, `hit` or `earnings`.","title":"Group"},"description":"`close`, `range`, `hit` or `earnings`."},{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProbabilitiesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every live question with a tight book and trades in the last day, with its leading outcomes.\n\nLearn more: [live question](https://tradytics.com/learn/prediction-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/prediction-market-data-api","description":"live question"}}},"/probabilities/outlook":{"get":{"tags":["Probabilities"],"summary":"S&P 500 outlook","operationId":"outlook_probabilities_outlook_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProbabilitiesOutlookResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Where Kalshi and Polymarket put the S&P 500 at each date they price, from the next close to year end, and the last 30 sessions' 10 AM calls on the S&P 500 and Nasdaq-100 against the close.\n\nLearn more: [Where Kalshi and Polymarket put the S&P 500](https://tradytics.com/learn/what-do-prediction-markets-say-about-the-sp-500).","externalDocs":{"url":"https://tradytics.com/learn/what-do-prediction-markets-say-about-the-sp-500","description":"Where Kalshi and Polymarket put the S&P 500"}}},"/probabilities/settled":{"get":{"tags":["Probabilities"],"summary":"Settled markets","operationId":"settled_probabilities_settled_get","parameters":[{"name":"source","in":"query","required":false,"schema":{"enum":["kalshi","polymarket"],"type":"string","default":"kalshi","title":"Source"}},{"name":"series","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"description":"A Kalshi series (e.g. `KXINXU`) or a Polymarket event id.","title":"Series"},"description":"A Kalshi series (e.g. `KXINXU`) or a Polymarket event id."},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"description":"A Kalshi category (e.g. `Financials`) or a Polymarket tag (e.g. `stocks`).","title":"Category"},"description":"A Kalshi category (e.g. `Financials`) or a Polymarket tag (e.g. `stocks`)."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProbabilitiesSettledResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every finance market Kalshi has settled since June 2021, and Polymarket's, the latest to close first. Default the last 30 days unless `series` is set.\n\nLearn more: [finance market Kalshi has settled](https://tradytics.com/learn/kalshi-data-api).","externalDocs":{"url":"https://tradytics.com/learn/kalshi-data-api","description":"finance market Kalshi has settled"}}},"/probabilities/{id}/history":{"get":{"tags":["Probabilities"],"summary":"Outcome history","operationId":"history_probabilities__id__history_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","maxLength":90,"description":"A question's `id`, or a settled market's `id`.","title":"Id"},"description":"A question's `id`, or a settled market's `id`."},{"name":"market","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":90},{"type":"null"}],"description":"One outcome's `market`. Default the question's first.","title":"Market"},"description":"One outcome's `market`. Default the question's first."},{"name":"interval","in":"query","required":false,"schema":{"enum":["hour","day"],"type":"string","default":"hour","title":"Interval"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start: `YYYY-MM-DD` or an RFC 3339 time.","title":"From"},"description":"Start: `YYYY-MM-DD` or an RFC 3339 time."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now.","title":"To"},"description":"End: `YYYY-MM-DD` or an RFC 3339 time. Default now."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProbabilitiesIdHistoryResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One outcome's chance through time, live or settled: the last trade in each hour or day.\n\nLearn more: [chance through time](https://tradytics.com/learn/prediction-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/prediction-market-data-api","description":"chance through time"}}},"/probabilities/{id}":{"get":{"tags":["Probabilities"],"summary":"Question","operationId":"question_probabilities__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","maxLength":90,"description":"A question's `id`.","title":"Id"},"description":"A question's `id`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProbabilitiesIdResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One open question with every outcome, and for an earnings question the stock's past reports and moves.\n\nLearn more: [earnings question](https://tradytics.com/learn/tradytics-probabilities).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-probabilities","description":"earnings question"}}},"/fund":{"get":{"tags":["AI Fund"],"summary":"The fund","operationId":"book_fund_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Exposure, open positions and the latest 20 posts and letters. Broad-market ETF hedges have their own exposure group.\n\nLearn more: [Exposure](https://tradytics.com/learn/tradytics-ai-fund).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-ai-fund","description":"Exposure"}}},"/fund/trades":{"get":{"tags":["AI Fund"],"summary":"Fund trades","operationId":"trades_fund_trades_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["open","closed"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"symbol","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Rows per page, up to 200.","default":50,"title":"Limit"},"description":"Rows per page, up to 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundTradesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Every trade, open and closed, newest first. See how the fund picks trades.\n\nLearn more: [how the fund picks trades](https://tradytics.com/learn/how-the-tradytics-ai-fund-picks-trades).","externalDocs":{"url":"https://tradytics.com/learn/how-the-tradytics-ai-fund-picks-trades","description":"how the fund picks trades"}}},"/symbols":{"get":{"tags":["Symbols"],"summary":"List symbols","operationId":"symbols_symbols_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"description":"Matches the start of a ticker or any part of a name.","title":"Q"},"description":"Matches the start of a ticker or any part of a name."},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["stock","etf","adr","index"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Rows per page, up to 1000.","default":100,"title":"Limit"},"description":"Rows per page, up to 1000."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`next_cursor` from the previous page.","title":"Cursor"},"description":"`next_cursor` from the previous page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SymbolsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"The ~6,000 symbols Tradytics tracks, most traded first. Search by ticker or name with `q`."}},"/symbols/{symbol}":{"get":{"tags":["Symbols"],"summary":"Symbol","operationId":"detail_symbols__symbol__get","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","description":"Ticker symbol, e.g. `AAPL`.","title":"Symbol"},"description":"Ticker symbol, e.g. `AAPL`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SymbolsSymbolResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One symbol: its name, kind, sector, industry, size and live quote.\n\nLearn more: [live quote](https://tradytics.com/learn/stock-market-data-api).","externalDocs":{"url":"https://tradytics.com/learn/stock-market-data-api","description":"live quote"}}},"/account/portfolio":{"get":{"tags":["Your account"],"summary":"Your portfolio","operationId":"holdings_account_portfolio_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPortfolioResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Your linked brokerage accounts, read only: holdings, options and recent orders, in each account's currency.\n\nLearn more: [linked brokerage accounts](https://tradytics.com/learn/tradytics-portfolio-tracker).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-portfolio-tracker","description":"linked brokerage accounts"}}},"/account/portfolio/trades":{"get":{"tags":["Your account"],"summary":"Your trades","operationId":"trades_account_portfolio_trades_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPortfolioTradesResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"A year of closed round trips, newest first, with dividends and fees per account.\n\nLearn more: [closed round trips](https://tradytics.com/learn/tradytics-portfolio-tracker).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-portfolio-tracker","description":"closed round trips"}}},"/account/portfolio/factors":{"get":{"tags":["Your account"],"summary":"Your portfolio's factors","operationId":"factors_account_portfolio_factors_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPortfolioFactorsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Your book's risk by source, beta, value at risk and tracking error, each holding's share, crash replays, and returns split into market, sectors, styles and stock picking. `404 not_connected` before a brokerage is linked.\n\nLearn more: [risk by source](https://tradytics.com/learn/tradytics-portfolio-factors).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-portfolio-factors","description":"risk by source"}}},"/account/backtests":{"get":{"tags":["Your account"],"summary":"Your backtests","operationId":"threads_account_backtests_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Only backtests whose title or messages mention this.","title":"Q"},"description":"Only backtests whose title or messages mention this."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Rows, up to 200.","default":50,"title":"Limit"},"description":"Rows, up to 200."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBacktestsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Your backtests, the latest first.\n\nLearn more: [backtests](https://tradytics.com/learn/tradytics-backtester).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-backtester","description":"backtests"}}},"/account/backtests/{id}":{"get":{"tags":["Your account"],"summary":"A backtest","operationId":"thread_account_backtests__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","description":"A backtest's `id`.","title":"Id"},"description":"A backtest's `id`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBacktestsIdResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One backtest: the conversation and every run it made.\n\nLearn more: [backtest](https://tradytics.com/learn/tradytics-backtester).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-backtester","description":"backtest"}}},"/account/dashboards":{"get":{"tags":["Your account"],"summary":"Your dashboards","operationId":"boards_account_dashboards_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDashboardsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Your dashboards.\n\nLearn more: [dashboards](https://tradytics.com/learn/tradytics-custom-dashboards).","externalDocs":{"url":"https://tradytics.com/learn/tradytics-custom-dashboards","description":"dashboards"}}},"/account/dashboards/{id}":{"get":{"tags":["Your account"],"summary":"A dashboard","operationId":"board_account_dashboards__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","description":"A dashboard's `id`.","title":"Id"},"description":"A dashboard's `id`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDashboardsIdResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"One dashboard's layout on a 12-column grid.\n\nLearn more: [layout](https://tradytics.com/learn/how-to-build-an-options-trading-dashboard).","externalDocs":{"url":"https://tradytics.com/learn/how-to-build-an-options-trading-dashboard","description":"layout"}}},"/account/watchlists":{"get":{"tags":["Your account"],"summary":"Your watchlists","operationId":"watchlists_account_watchlists_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountWatchlistsResponse"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"500":{"$ref":"#/components/responses/Error500"},"503":{"$ref":"#/components/responses/Error503"}},"description":"Your watchlists, the default first, each with its symbols in the order added."}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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"},"OptionPrint":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time"},"symbol":{"type":"string"},"contract":{"type":"string"},"type":{"type":"string","enum":["call","put"]},"strike":{"type":"number"},"expiry":{"type":"string","format":"date"},"dte":{"type":"integer"},"spot":{"anyOf":[{"type":"number"},{"type":"null"}]},"size":{"type":"integer"},"price":{"type":"number"},"premium_usd":{"type":"integer","format":"int64"},"bid":{"anyOf":[{"type":"number"},{"type":"null"}]},"ask":{"anyOf":[{"type":"number"},{"type":"null"}]},"side":{"anyOf":[{"type":"string","enum":["bought","sold","mid"]},{"type":"null"}]},"aggression":{"anyOf":[{"type":"integer"},{"type":"null"}]},"side_checked":{"type":"boolean"},"kind":{"type":"string","enum":["sweep","block","split","single"]},"condition":{"anyOf":[{"type":"string"},{"type":"null"}]},"opening":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}]},"volume":{"type":"integer","format":"int64"},"iv":{"anyOf":[{"type":"number"},{"type":"null"}]},"delta":{"anyOf":[{"type":"number"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"iv_quality":{"type":"string","enum":["low_vega"],"description":"IV is null when a 20-volatility-point band changes the model price by less than a cent or the valid quote spread, or the fill and zero-volatility price both fit inside the quote. The quote check applies even if the solver returns null."}},"required":["id","time","symbol","contract","type","strike","expiry","dte","spot","size","price","premium_usd","bid","ask","side","aggression","side_checked","kind","condition","opening","open_interest","volume","iv","delta","events"]},"OptionPrintDetail":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time"},"symbol":{"type":"string"},"contract":{"type":"string"},"type":{"type":"string","enum":["call","put"]},"strike":{"type":"number"},"expiry":{"type":"string","format":"date"},"dte":{"type":"integer"},"spot":{"anyOf":[{"type":"number"},{"type":"null"}]},"size":{"type":"integer"},"price":{"type":"number"},"premium_usd":{"type":"integer","format":"int64"},"bid":{"anyOf":[{"type":"number"},{"type":"null"}]},"ask":{"anyOf":[{"type":"number"},{"type":"null"}]},"side":{"anyOf":[{"type":"string","enum":["bought","sold","mid"]},{"type":"null"}]},"aggression":{"anyOf":[{"type":"integer"},{"type":"null"}]},"side_checked":{"type":"boolean"},"kind":{"type":"string","enum":["sweep","block","split","single"]},"condition":{"anyOf":[{"type":"string"},{"type":"null"}]},"opening":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}]},"volume":{"type":"integer","format":"int64"},"iv":{"anyOf":[{"type":"number"},{"type":"null"}]},"delta":{"anyOf":[{"type":"number"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"iv_quality":{"type":"string","enum":["low_vega"],"description":"IV is null when a 20-volatility-point band changes the model price by less than a cent or the valid quote spread, or the fill and zero-volatility price both fit inside the quote. The quote check applies even if the solver returns null."},"context":{"$ref":"#/components/schemas/OptionPrintContext"},"outcome":{"anyOf":[{"$ref":"#/components/schemas/OptionPrintOutcome"},{"type":"null"}]}},"required":["id","time","symbol","contract","type","strike","expiry","dte","spot","size","price","premium_usd","bid","ask","side","aggression","side_checked","kind","condition","opening","open_interest","volume","iv","delta","events","context","outcome"]},"OptionPrintContext":{"type":"object","properties":{"session":{"type":"string","format":"date"},"contract_prints":{"type":"integer"},"contract_premium_usd":{"type":"integer","format":"int64"},"contract_net_premium_usd":{"type":"integer","format":"int64"},"symbol_prints":{"type":"integer"},"symbol_premium_usd":{"type":"integer","format":"int64"},"symbol_net_premium_usd":{"type":"integer","format":"int64"}},"required":["session","contract_prints","contract_premium_usd","contract_net_premium_usd","symbol_prints","symbol_premium_usd","symbol_net_premium_usd"]},"OptionPrintOutcome":{"type":"object","properties":{"next_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"next_close":{"anyOf":[{"type":"number"},{"type":"null"}]},"next_return_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"final_date":{"type":"string","format":"date"},"final_price":{"anyOf":[{"type":"number"},{"type":"null"}]},"final_return_pct":{"anyOf":[{"type":"number"},{"type":"null"}]},"expired":{"type":"boolean"}},"required":["next_date","next_close","next_return_pct","final_date","final_price","final_return_pct","expired"]},"DarkPoolPrint":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time"},"symbol":{"type":"string"},"price":{"type":"number"},"size":{"type":"integer","format":"int64"},"notional_usd":{"type":"integer","format":"int64"},"venue":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}},"kind":{"type":"string","enum":["trade","open","close"]},"rank":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["id","time","symbol","price","size","notional_usd","venue","conditions","kind","rank"]},"StockBar":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"open":{"anyOf":[{"type":"number"},{"type":"null"}]},"high":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]},"close":{"anyOf":[{"type":"number"},{"type":"null"}]},"volume":{"anyOf":[{"type":"integer","format":"int64"},{"type":"null"}]},"vwap":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["time","open","high","low","close","volume","vwap"]},"SECFilingPassage":{"type":"object","properties":{"accession":{"type":"string"},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}]},"cik":{"anyOf":[{"type":"integer","format":"int64"},{"type":"null"}]},"company":{"anyOf":[{"type":"string"},{"type":"null"}]},"form":{"anyOf":[{"type":"string"},{"type":"null"}]},"filed_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"filing_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"passage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["accession","symbol","cik","company","form","filed_date","document_type","description","url","filing_url","passage"]},"FilingSearchCoverage":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"complete":{"type":"boolean"}},"required":["from","to","complete"]},"ResponseMeta":{"type":"object","properties":{"as_of":{"type":"string","format":"date-time"}},"required":["as_of"]},"ListMeta":{"type":"object","properties":{"as_of":{"type":"string","format":"date-time"},"count":{"type":"integer","minimum":0}},"required":["as_of","count"]},"ObjectResponse":{"type":"object","properties":{"data":{"type":"object","additionalProperties":true},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"ListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":true}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FilingSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SECFilingPassage"}},"meta":{"type":"object","properties":{"as_of":{"type":"string","format":"date-time"},"count":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"coverage":{"$ref":"#/components/schemas/FilingSearchCoverage"}},"required":["as_of","count","total","coverage"]},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"status":{"type":"integer"},"code":{"type":"string"},"message":{"type":"string"}},"required":["status","code","message"]},"request_id":{"type":"string"}},"required":["error","request_id"]},"OptionPrintListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OptionPrint"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsFlowTimelineResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Interval start, UTC (`1d`: the session's open)."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session."},"call_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bought minus sold, calls."},"put_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bought minus sold, puts."},"net_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Call minus put: positive is bullish."},"net_delta_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Delta bought minus sold, in stock dollars."},"put_call_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Put premium over call premium, all prints."},"prints":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Prints."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The underlying's close at the interval's end (one symbol, or SPY market-wide)."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsFlowLeadersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker (null by sector)."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector."},"net_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bullish minus bearish."},"bullish_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calls bought and puts sold."},"bearish_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Puts bought and calls sold."},"premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"All premium."},"prints":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Prints."},"premium_vs_average":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Premium over its 20-session daily average."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The stock's change, % (a sector's: market-cap weighted)."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close or last (null by sector)."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsFlowStrikesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"strike":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike."},"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiration."},"call_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bought minus sold, calls."},"put_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bought minus sold, puts."},"net_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Call minus put."},"premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"All premium."},"prints":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Prints."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsUnusualResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"contract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCC symbol, with the root it traded under (`SPXW` for SPX weeklies, `NDXP`, `RUTW`, `VIXW`)."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlying (index options read `SPX`, `NDX`, `VIX`)."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`call` or `put`."},"strike":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike."},"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiration, `YYYY-MM-DD`."},"dte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calendar days to expiry from the session."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts traded in the session (so far, live)."},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Open interest before the session. Null for the reconstructed archive."},"volume_to_open_interest":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Volume over open interest."},"average_volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Daily volume over the 20 sessions before."},"volume_to_average":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Volume over `average_volume`."},"premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Premium in its prints."},"net_premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bought minus sold."},"prints":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Prints."},"spot":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Underlying price at the last print."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last print's price."},"iv":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Implied volatility at the last print."},"iv_quality":{"type":"string","enum":["low_vega"],"description":"`low_vega` when a band of up to 20 volatility points moves the model price by less than a cent or the spread of a valid in-range quote, or when that quote also contains the zero-volatility price. The quote check can set this flag even if the solver returns null."},"last_time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last print, UTC."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionPrintDetailResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OptionPrintDetail"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"OptionsChainResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"contract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCC symbol."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`call` or `put`."},"strike":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike."},"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiration, `YYYY-MM-DD`."},"dte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calendar days to expiry."},"bid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"ask":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"mid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"last":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last trade."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts traded in the session."},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Open contracts as of the session before."},"iv":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Implied volatility. Black-Scholes on the mid with a 4% rate and an underlying price matched to the quote. Stored chains estimate carry from put-call parity. Live views use zero carry and return null when aligned inputs are unavailable."},"delta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"gamma":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"theta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"vega":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"underlying_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The underlying price at the quote time. A dated chain gives the stored session close."},"underlying_price_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"UTC time of the underlying price, when available for a live quote."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time of the quote, UTC."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsExpirationsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiration, `YYYY-MM-DD`."},"dte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calendar days to expiry."},"contracts":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calls and puts listed."},"strikes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Distinct strikes."},"cycle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`monthly` (the third Friday), `quarterly` (a quarter's last weekday) or `weekly`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsContractsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"contract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCC symbol."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlying."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`call` or `put`."},"strike":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike."},"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiration, `YYYY-MM-DD`."},"dte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calendar days to expiry."},"underlying_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The stock's close."},"otm_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Out of the money, % (negative is in the money)."},"bid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"ask":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"mid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"last":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last trade."},"vwap":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's volume-weighted price."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts traded."},"premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Dollars traded."},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Open contracts as of the session before."},"open_interest_change":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Change since the session before."},"volume_to_open_interest":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Volume over open interest."},"iv_change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV change since the session before."},"iv":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Implied volatility. Black-Scholes on the mid with a 4% rate and an underlying price matched to the quote. Stored chains estimate carry from put-call parity. Live views use zero carry and return null when aligned inputs are unavailable."},"delta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"gamma":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"theta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."},"vega":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Greeks; theta per day, vega per vol point."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsContractsContractResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"contract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OCC symbol."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlying."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`call` or `put`."},"strike":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike."},"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiration, `YYYY-MM-DD`."},"dte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calendar days to expiry."},"shares_per_contract":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares delivered."},"adjusted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A non-standard deliverable after a split, spin-off or special dividend (BABA2: 100 shares and $95): no IV, greeks or break-even."},"bid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"ask":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"mid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The quote; null without an offer."},"last":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last trade."},"bid_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts at the bid and ask."},"ask_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts at the bid and ask."},"last_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts in the last trade."},"last_trade_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time of the last trade, UTC."},"open":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"high":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"low":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"previous_close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session before's close."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change from `previous_close`, %."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts traded in the session."},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Open contracts as of the session before."},"quote_source":{"anyOf":[{"type":"string","enum":["vendor","closing_snapshot"]},{"type":"null"}],"description":"`vendor` for the vendor quote or `closing_snapshot` for the saved closing quote. Null if there is no quote."},"underlying_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The underlying price matched to a vendor quote, or the official stock close for a saved quote."},"underlying_price_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"UTC time of the underlying price. For a closing snapshot, this is the regular session close."},"iv":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Black-Scholes on the mid at the option quote time for a vendor quote, or at the regular session close for a saved quote. Theta per day, vega per vol point. Null when inputs are unavailable."},"delta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Black-Scholes on the mid at the option quote time for a vendor quote, or at the regular session close for a saved quote. Theta per day, vega per vol point. Null when inputs are unavailable."},"gamma":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Black-Scholes on the mid at the option quote time for a vendor quote, or at the regular session close for a saved quote. Theta per day, vega per vol point. Null when inputs are unavailable."},"theta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Black-Scholes on the mid at the option quote time for a vendor quote, or at the regular session close for a saved quote. Theta per day, vega per vol point. Null when inputs are unavailable."},"vega":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Black-Scholes on the mid at the option quote time for a vendor quote, or at the regular session close for a saved quote. Theta per day, vega per vol point. Null when inputs are unavailable."},"break_even_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike plus (call) or minus (put) the mid."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time of the quote, UTC."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"OptionsContractsContractBarsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bar start, UTC; daily bars carry the session date at 00:00 UTC."},"open":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Prices."},"high":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Prices."},"low":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Prices."},"close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Prices."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Contracts."},"vwap":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Volume-weighted average price."},"trades":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Trades in the bar."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsOpenInterestResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"strike":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Strike; null by expiry."},"expiry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`YYYY-MM-DD`; null by strike across all expiries."},"call_open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Open contracts."},"put_open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Open contracts."},"call_open_interest_change":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Change since the session before."},"put_open_interest_change":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Change since the session before."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsExposureResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlying."},"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the run was written, UTC."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The model's session."},"spot":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The underlying price used by the returned model run."},"spot_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC timestamp of the price used. Present on 30-second SPX same-day gamma snapshots."},"greek":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As asked."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`usd_per_1pct_move` (gamma), `shares` (delta), `usd_per_vol_point` (vanna), `shares_per_day` (charm)."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Who the dealers are short and long."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net across the full result, before pagination."},"levels":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`call_wall` and `put_wall` (the call and put walls in the view), `flip` (the gamma flip within 5% of spot, else null), `max_pain` (max pain: the strike where the expiry's open contracts pay holders least: the expiry asked, else the nearest)."},"rows":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Rows ordered by strike or expiry. Each row contains call, put and net exposure."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page of rows, pinned to this run. Present when paging. Null on the last page."},"next_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL for the next page, without an API key. Present when paging."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"OptionsExposureHistoryResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session."},"close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close."},"net_delta":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Dealer delta, shares, every expiry."},"net_gamma_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Dealer gamma, dollars of delta per 1% move."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"OptionsVolatilityResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Underlying."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session, `YYYY-MM-DD`."},"underlying_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The stock's price."},"atm_iv_30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"30-day constant-maturity at-the-money IV."},"iv_rank":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Where `atm_iv_30d` sits between the past year's low (0) and high (1)."},"iv_percentile":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the past year's sessions with lower `atm_iv_30d`."},"realized_vol_20d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close-to-close volatility, annualized."},"realized_vol_30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close-to-close volatility, annualized."},"vrp":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"`atm_iv_30d` minus `realized_vol_30d`."},"expected_move":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"The one-standard-deviation expected move to the next expiry: `expiry`, `dte`, `move_usd`, `move_pct`."},"earnings_move":{"anyOf":[{"type":"object","properties":{"earnings_date":{"type":"string","format":"date"},"expiry":{"type":"string","format":"date"},"dte":{"type":"integer"},"move_usd":{"type":"number"},"move_pct":{"type":"number"}},"required":["earnings_date","expiry","dte","move_usd","move_pct"]},{"type":"null"}],"description":"The expected move around earnings through the first expiry that covers the next report. A closing snapshot uses the schedule known at that close. Null when that date or expiry is unavailable."},"term":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`expiry`, `dte`, `atm_iv`."},"skew":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`expiry`, `dte`, `put_25d_iv`, `call_25d_iv`, `skew` (put minus call)."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"OptionsVolatilityHistoryResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session, `YYYY-MM-DD`."},"close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The closing price from daily bars when available. The stored snapshot price is used until the daily bar arrives."},"atm_iv_30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"30-day constant-maturity at-the-money IV."},"iv_rank":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Where `atm_iv_30d` sits between the past year's low (0) and high (1)."},"iv_percentile":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the past year's sessions with lower `atm_iv_30d`."},"realized_vol_20d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close-to-close volatility, annualized."},"realized_vol_30d":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close-to-close volatility, annualized."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DarkPoolPrintListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DarkPoolPrint"}},"meta":{"$ref":"#/components/schemas/ListMeta","properties":{"rank_status":{"type":"string","enum":["ready","partial","unavailable","empty"],"description":"For the returned page. `ready` if all prints have a rank, `partial` if some do, `unavailable` if none do, or `empty` if no prints match."}}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DarkpoolLevelsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Notional-weighted price."},"low":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The bin's bounds."},"high":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The bin's bounds."},"notional_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Dark pool notional."},"prints":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Prints."},"share":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Of the window's dark pool notional."},"distance_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"From the last close, %."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DarkpoolDailyResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"dark_notional_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Off-exchange block trades."},"exchange_notional_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Block trades on exchanges."},"closing_auction_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The auctions; null for the live session."},"opening_auction_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The auctions; null for the live session."},"prints":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Block trades."},"close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Close (last for the live session)."},"rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The session's place by `dark_notional_usd` among the stock's sessions over the 12 months to it; null without dark pool trades."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"StocksQuotesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and short name."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and short name."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The session the price, change and volume are from: today, or the last one the symbol traded in."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Latest price, including premarket and after-hours."},"price_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC start of the minute that supplied the price. Null when only the prior daily close is available."},"session":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trading phase of the price: premarket, regular, or after_hours."},"regular_close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular-session close for the quote date when available."},"stale":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the price is from an earlier trading date."},"volume_source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"daily, consolidated, consolidated_cached, or minute_bars. Null for an index."},"change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change from the previous close, in dollars and percent."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change from the previous close, in dollars and percent."},"previous_close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The previous session's close."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares traded that session, 04:00 to 20:00 New York; null for an index."},"dollar_volume_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Dollars traded that session."},"gap_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The open against the previous close (before the open, the pre-market move); null before the first trade."},"relative_volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Today's volume over the 20-session average; null before the first trade."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"StockBarListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StockBar"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"StocksSnapshotResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, short name, `stock`, `etf`, `adr` or `index`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, short name, `stock`, `etf`, `adr` or `index`."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, short name, `stock`, `etf`, `adr` or `index`."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's sector and industry, named as on every endpoint; null for funds and indices."},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's sector and industry, named as on every endpoint; null for funds and indices."},"market_cap_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares outstanding at the price."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last trade and its change from the previous close."},"change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last trade and its change from the previous close."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Last trade and its change from the previous close."},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares and dollars traded that session."},"dollar_volume_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares and dollars traded that session."},"relative_volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Today's volume over the 20-session average; null before the first trade."}}}},"meta":{"$ref":"#/components/schemas/ListMeta","properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The session the price, change and volume are from."}}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"StocksTechnicalsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"description":"Ticker and price."},"price":{"description":"Ticker and price."},"rating":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"-1 (strong sell) to 1 (strong buy)."},"signals":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name` and `lean` (-1, 0 or 1)."},"moving_averages":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name`, `days`, `average` (`simple` or `exponential`), `value`, `price_above`."},"oscillators":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name` (RSI, MFI, stochastic, CCI), `value`, `overbought` and `oversold` levels."},"macd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"MACD (12, 26, 9) and its signal line, ADX, average true range in dollars."},"macd_signal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"MACD (12, 26, 9) and its signal line, ADX, average true range in dollars."},"adx":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"MACD (12, 26, 9) and its signal line, ADX, average true range in dollars."},"atr":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"MACD (12, 26, 9) and its signal line, ADX, average true range in dollars."},"seasonality":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`month`, `up_years`, `down_years`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"StocksShortInterestResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and settlement date."},"settlement_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and settlement date."},"short_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares sold short."},"average_daily_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Average daily shares traded."},"days_to_cover":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short interest over average daily volume."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"StocksShortVolumeResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and session."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and session."},"short_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares sold short, and those exempt."},"short_exempt_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares sold short, and those exempt."},"total_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"All shares reported."},"short_volume_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short volume over total volume, decimal."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"StocksCorporateActionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The action, its ticker, `dividend` or `split`."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The action, its ticker, `dividend` or `split`."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The action, its ticker, `dividend` or `split`."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ex-dividend date, or the split's execution date."},"declaration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dividends: when declared, recorded and paid."},"record_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dividends: when declared, recorded and paid."},"pay_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dividends: when declared, recorded and paid."},"amount":{"description":"Dividends: cash per share and its currency."},"currency":{"description":"Dividends: cash per share and its currency."},"frequency":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Dividends: payments a year (0 one-off)."},"distribution":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Dividends: `recurring`, `special` and the like."},"split_from":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Splits: old shares for new (1 to 4 is a 4-for-1)."},"split_to":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Splits: old shares for new (1 to 4 is a 4-for-1)."},"split_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`forward_split`, `reverse_split` or `stock_dividend`."},"adjustment_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"What earlier prices are multiplied by for this action."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsProfileResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Short name, e.g. `Apple`."},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Registered name."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the company does."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector and industry."},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sector and industry."},"exchange":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Listing exchange and country."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Listing exchange and country."},"employees":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Full-time employees."},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Company site."},"ipo_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"First trading day, `YYYY-MM-DD`."},"is_etf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether it is a fund."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Price now, as `/stocks/quotes` has it."},"price_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session of the price."},"market_cap_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap (every share class) and enterprise value at that price."},"enterprise_value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap (every share class) and enterprise value at that price."},"shares_outstanding":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares outstanding and free float."},"float_shares":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares outstanding and free float."},"valuation":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`pe`, `forward_pe` (on the next fiscal year's average EPS estimate), `ps`, `pb`, `ev_to_ebitda`."},"margins":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`gross`, `operating`, `net` over the trailing twelve months, decimals."},"dividend_yield":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing yield, decimal."},"beta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Beta."},"year_high":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highest and lowest price of the last 52 weeks."},"year_low":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highest and lowest price of the last 52 weeks."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"FundamentalsIncomeStatementResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year, as the company names it."},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Q1` to `Q4` (for `ttm`, the quarter the twelve months end with) or `FY`."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the period, `YYYY-MM-DD`."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the latest filing behind these numbers (a later filing restates earlier periods)."},"first_filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the period was first on file in full."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SEC accession number of that latest filing."},"template":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`standard`, `bank`, `insurer` or `reit`: which industry lines apply."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reporting currency, `USD` (filers reporting in another currency, and 20-F and 40-F filers, are not covered)."},"revenue_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue (banks: net interest income plus noninterest income; insurers and REITs: total revenues)."},"cost_of_revenue_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Cost of revenue (`null` for banks and insurers)."},"gross_profit_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Gross profit, or revenue less cost of revenue where the statement doesn't show it (`null` for banks and insurers)."},"research_and_development_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"R&D."},"selling_general_and_administrative_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"SG&A."},"depreciation_and_amortization_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depreciation and amortization (the cash flow statement's where the income statement has none)."},"other_operating_expenses_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other operating expenses."},"operating_expenses_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total operating expenses (banks: noninterest expense)."},"operating_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Operating income."},"interest_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Interest income."},"interest_expense_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Interest expense."},"other_income_expense_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other income or expense."},"total_other_income_expense_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total non-operating income or expense."},"income_before_tax_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Pretax income."},"income_tax_expense_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Income tax."},"discontinued_operations_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Discontinued operations."},"equity_in_affiliates_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Equity in affiliates."},"extraordinary_items_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Extraordinary items."},"consolidated_net_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income including minority interests."},"noncontrolling_interest_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minority interests' share."},"net_income_attributable_to_parent_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income of the company's shareholders."},"preferred_dividends_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Preferred dividends."},"net_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income to common shareholders."},"ebitda_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Operating income plus depreciation and amortization."},"eps":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Basic and diluted EPS, $, adjusted for later splits. Q4: the earnings release's where it agrees with the filings, else Q4 net income over its shares."},"eps_diluted":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Basic and diluted EPS, $, adjusted for later splits. Q4: the earnings release's where it agrees with the filings, else Q4 net income over its shares."},"weighted_shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Weighted average shares, basic and diluted, adjusted for later splits (integers)."},"weighted_shares_diluted":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Weighted average shares, basic and diluted, adjusted for later splits (integers)."},"net_interest_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Banks: net interest income and noninterest income."},"noninterest_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Banks: net interest income and noninterest income."},"provision_for_credit_losses_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Banks: provision for credit losses."},"noninterest_expense_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Banks: noninterest expense."},"premiums_earned_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Insurers: net premiums earned and net investment income."},"net_investment_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Insurers: net premiums earned and net investment income."},"claims_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Insurers: losses, claims and policy benefits."},"as_first_filed":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Lines a later filing changed, as first filed (`{\"revenue_usd\": …}`), or `null`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsBalanceSheetResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year, as the company names it."},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Q1` to `Q4` (for `ttm`, the quarter the twelve months end with) or `FY`."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the period, `YYYY-MM-DD`."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the latest filing behind these numbers (a later filing restates earlier periods)."},"first_filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the period was first on file in full."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SEC accession number of that latest filing."},"template":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`standard`, `bank`, `insurer` or `reit`: which industry lines apply."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reporting currency, `USD` (filers reporting in another currency, and 20-F and 40-F filers, are not covered)."},"cash_and_equivalents_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Cash and equivalents."},"short_term_investments_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short-term investments."},"receivables_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Receivables."},"inventory_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Inventory."},"other_current_assets_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other current assets."},"total_current_assets_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current assets."},"property_plant_equipment_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net PP&E."},"goodwill_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Goodwill."},"intangible_assets_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net intangibles."},"other_assets_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other non-current assets."},"total_assets_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total assets."},"accounts_payable_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Accounts payable."},"deferred_revenue_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current deferred revenue."},"short_term_debt_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Debt due within a year."},"accrued_and_other_current_liabilities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Accrued and other current liabilities."},"total_current_liabilities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current liabilities."},"long_term_debt_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Long-term debt and capital leases."},"other_noncurrent_liabilities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other non-current liabilities."},"total_liabilities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total liabilities (liabilities and equity less equity where the balance sheet shows no total)."},"commitments_and_contingencies_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Commitments and contingencies."},"temporary_equity_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Redeemable (temporary) equity."},"preferred_stock_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Preferred stock."},"common_stock_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Common stock."},"additional_paid_in_capital_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Additional paid-in capital."},"treasury_stock_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Treasury stock."},"accumulated_other_comprehensive_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Accumulated other comprehensive income."},"retained_earnings_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Retained earnings (deficit)."},"other_equity_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other equity."},"stockholders_equity_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Equity of the parent's shareholders."},"noncontrolling_interest_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Minority interests."},"total_equity_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total equity."},"total_liabilities_and_equity_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Liabilities and equity."},"total_debt_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short-term plus long-term debt."},"net_debt_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total debt less cash and equivalents."},"loans_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Banks: net loans and deposits."},"deposits_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Banks: net loans and deposits."},"real_estate_investments_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"REITs: real estate, net."},"as_first_filed":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Lines a later filing changed, as first filed (`{\"revenue_usd\": …}`), or `null`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsCashFlowResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year, as the company names it."},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Q1` to `Q4` (for `ttm`, the quarter the twelve months end with) or `FY`."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the period, `YYYY-MM-DD`."},"filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the latest filing behind these numbers (a later filing restates earlier periods)."},"first_filed_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date the period was first on file in full."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SEC accession number of that latest filing."},"template":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`standard`, `bank`, `insurer` or `reit`: which industry lines apply."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reporting currency, `USD` (filers reporting in another currency, and 20-F and 40-F filers, are not covered)."},"net_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income."},"depreciation_and_amortization_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Depreciation and amortization."},"stock_based_compensation_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Stock-based compensation."},"other_cash_adjustments_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other non-cash adjustments."},"change_in_working_capital_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change in operating assets and liabilities."},"other_operating_activities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other operating activities."},"operating_cash_flow_continuing_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Operating cash flow of continuing and discontinued operations."},"operating_cash_flow_discontinued_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Operating cash flow of continuing and discontinued operations."},"operating_cash_flow_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Operating cash flow."},"capital_expenditure_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Capital expenditure (negative)."},"sale_of_property_plant_equipment_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"PP&E sold."},"acquisitions_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Businesses acquired, net of cash (negative)."},"other_investing_activities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other investing activities."},"investing_cash_flow_continuing_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Investing cash flow of continuing and discontinued operations."},"investing_cash_flow_discontinued_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Investing cash flow of continuing and discontinued operations."},"investing_cash_flow_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Investing cash flow."},"net_short_term_debt_issued_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Debt issued less repaid, short and long term."},"net_long_term_debt_issued_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Debt issued less repaid, short and long term."},"dividends_paid_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Dividends paid (negative)."},"share_repurchases_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares bought back (negative)."},"noncontrolling_interests_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Paid to minority interests (negative)."},"other_financing_activities_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Other financing."},"financing_cash_flow_continuing_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Financing cash flow of continuing and discontinued operations."},"financing_cash_flow_discontinued_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Financing cash flow of continuing and discontinued operations."},"financing_cash_flow_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Financing cash flow."},"effect_of_exchange_rates_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Currency effect on cash."},"discontinued_operations_income_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Income from discontinued operations."},"change_in_cash_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change in cash."},"free_cash_flow_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Operating cash flow plus capital expenditure."},"as_first_filed":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Lines a later filing changed, as first filed (`{\"revenue_usd\": …}`), or `null`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsRatiosResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session, `YYYY-MM-DD`."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Price now, as `/stocks/quotes` has it, or the close."},"market_cap_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap across all share classes. Historical values use the close and filed shares, with the historical issuer market cap series for Berkshire Hathaway."},"enterprise_value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap plus total debt less cash and equivalents."},"eps":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing net income to common per share outstanding, $."},"pe":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap over trailing net income to common, revenue and stockholders' equity (`null` for a loss)."},"ps":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap over trailing net income to common, revenue and stockholders' equity (`null` for a loss)."},"pb":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap over trailing net income to common, revenue and stockholders' equity (`null` for a loss)."},"price_to_cash_flow":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap over trailing operating and free cash flow."},"price_to_free_cash_flow":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market cap over trailing operating and free cash flow."},"ev_to_sales":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Enterprise value over trailing revenue and EBITDA."},"ev_to_ebitda":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Enterprise value over trailing revenue and EBITDA."},"gross_margin":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing gross profit, operating income and net income to common over revenue, decimals."},"operating_margin":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing gross profit, operating income and net income to common over revenue, decimals."},"net_margin":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing gross profit, operating income and net income to common over revenue, decimals."},"dividend_yield":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing dividends paid over market cap, decimal."},"return_on_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing net income to common over the latest total assets and stockholders' equity, decimals."},"return_on_equity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing net income to common over the latest total assets and stockholders' equity, decimals."},"debt_to_equity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Total debt over stockholders' equity."},"current_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current assets; cash, short-term investments and receivables; and cash, over current liabilities."},"quick_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current assets; cash, short-term investments and receivables; and cash, over current liabilities."},"cash_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current assets; cash, short-term investments and receivables; and cash, over current liabilities."},"free_cash_flow_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing free cash flow."},"average_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Average daily volume of the 30 sessions to the date, shares (`null` at the price now)."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsSegmentsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the period."},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year."},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Q1` to `Q4` or `FY`."},"segment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Segment as the company names it."},"revenue_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its revenue."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsEarningsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Report date."},"fiscal_year":{"description":"The quarter reported (`period_end` `null` until filed, for 52/53-week years)."},"fiscal_period":{"description":"The quarter reported (`period_end` `null` until filed, for 52/53-week years)."},"period_end":{"description":"The quarter reported (`period_end` `null` until filed, for 52/53-week years)."},"eps_adjusted":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EPS as analysts count it (adjusted, where the company reports adjusted EPS) and their consensus, $."},"eps_estimate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EPS as analysts count it (adjusted, where the company reports adjusted EPS) and their consensus, $."},"eps_surprise_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"`eps_adjusted` against the consensus, %."},"eps_diluted":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"GAAP diluted EPS of the quarter from the filings (the income statement's `eps_diluted`), `null` until filed, $."},"revenue_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Reported revenue and the consensus."},"revenue_estimate_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Reported revenue and the consensus."},"revenue_surprise_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue against the consensus, %."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsEstimatesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the fiscal period."},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year."},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Q1` to `Q4` or `FY`."},"revenue_low_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue: the lowest, average and highest estimate."},"revenue_average_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue: the lowest, average and highest estimate."},"revenue_high_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue: the lowest, average and highest estimate."},"eps_low":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EPS, $."},"eps_average":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EPS, $."},"eps_high":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EPS, $."},"ebitda_low_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EBITDA."},"ebitda_average_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EBITDA."},"ebitda_high_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"EBITDA."},"net_income_low_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income."},"net_income_average_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income."},"net_income_high_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net income."},"revenue_analysts":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Analysts behind the revenue and EPS estimates."},"eps_analysts":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Analysts behind the revenue and EPS estimates."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsAnalystsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"consensus":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`rating` (`strong_buy` to `strong_sell`, the firms' average) and the firms at each on their latest call of the last 12 months: `strong_buy`, `buy`, `hold`, `sell`, `strong_sell`."},"price_target":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`low`, `median`, `average`, `high`, $."},"grades":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`date`, `firm`, `action` (`upgrade`, `downgrade`, `maintain` …), `previous_grade`, `grade` in the firm's own words."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"FundamentalsTranscriptsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fiscal year."},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`Q1` to `Q4`."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Call date."},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The whole call, one speaker per paragraph."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FundamentalsEtfHoldingsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The holding's ticker."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its name."},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the fund, decimal."},"shares":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares held."},"market_value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Value of the position."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FilingsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Accession number, the filing's id."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker of the company it is about, null for a filer without one."},"cik":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"SEC CIK of that company."},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as filed."},"form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Form type, e.g. `10-K`, `8-K/A`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR accepted it, UTC."},"period_of_report":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Period it covers, `YYYY-MM-DD`."},"items":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"8-K items, e.g. `[\"2.02\", \"9.01\"]`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What it is: the form, or an 8-K's items in words."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing on EDGAR."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its main document."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"FilingsAccessionResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Accession number, the filing's id."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker of the company it is about, null for a filer without one."},"cik":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"SEC CIK of that company."},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name as filed."},"form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Form type, e.g. `10-K`, `8-K/A`."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When EDGAR accepted it, UTC."},"period_of_report":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Period it covers, `YYYY-MM-DD`."},"items":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"8-K items, e.g. `[\"2.02\", \"9.01\"]`."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What it is: the form, or an 8-K's items in words."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing on EDGAR."},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its main document."},"documents":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`sequence`, `type` (e.g. `10-K`, `EX-99.1`, `EX-101.INS`), `description`, `url`, and `size_bytes` when available."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"FilingsAccessionSectionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its name, e.g. `risk_factors` or `2.02`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its heading, e.g. `Risk factors`."},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The section's text."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DisclosuresInsidersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the Form 4 was accepted, UTC."},"transaction_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trade date, `YYYY-MM-DD`."},"symbol":{"description":"The company and its SEC CIK."},"company":{"description":"The company and its SEC CIK."},"cik":{"description":"The company and its SEC CIK."},"insider":{"description":"Who traded and their SEC CIK."},"insider_cik":{"description":"Who traded and their SEC CIK."},"relationship":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Their ties to the company, e.g. `Chief Financial Officer`, `Director, 10% owner`."},"form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`4` or `4/A`."},"security":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was traded, e.g. `Common Stock`, `Stock Option (Right to Buy)`."},"derivative":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"An option, unit or other derivative."},"transaction_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC code, e.g. `P`, `S`, `A`, `M`, `F`."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code in a word: `buy`, `sell`, `grant`, `exercise`, `tax`, `gift`, …"},"direction":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`acquired` or `disposed`."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares (or derivative units) and price per share."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares (or derivative units) and price per share."},"value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares times price."},"shares_owned_after":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Holding after the trade."},"ownership":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`direct` or `indirect`."},"rule_10b5_1":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The filing's Rule 10b5-1 plan box; null on forms without it (before April 2023)."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Form 4 filing."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DisclosuresInstitutionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter end, `YYYY-MM-DD`."},"manager":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The institution."},"cik":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Its SEC CIK."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker of the security, null when unknown."},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Security as filed and its CUSIP."},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Security as filed and its CUSIP."},"put_call":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`call` or `put` for an option position, else null."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares (or principal) held at quarter end."},"prior_shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares the quarter before, null if new."},"shares_change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares bought (sold if negative) over the quarter."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change in shares, percent."},"value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market value at quarter end in dollars; a 13F filed in thousands is multiplied by 1,000."},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the manager's reported book, decimal."},"new":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Opened this quarter; sold out this quarter (`shares` 0). `new` and the changes are null when the quarter before isn't on file."},"closed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Opened this quarter; sold out this quarter (`shares` 0). `new` and the changes are null when the quarter before isn't on file."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the 13F was accepted, UTC."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 13F filing."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DisclosuresInstitutionsCikResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"quarter":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Quarter end, `YYYY-MM-DD`."},"manager":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The institution."},"cik":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Its SEC CIK."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker of the security, null when unknown."},"issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Security as filed and its CUSIP."},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Security as filed and its CUSIP."},"put_call":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`call` or `put` for an option position, else null."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares (or principal) held at quarter end."},"prior_shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares the quarter before, null if new."},"shares_change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares bought (sold if negative) over the quarter."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change in shares, percent."},"value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Market value at quarter end in dollars; a 13F filed in thousands is multiplied by 1,000."},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share of the manager's reported book, decimal."},"new":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Opened this quarter; sold out this quarter (`shares` 0). `new` and the changes are null when the quarter before isn't on file."},"closed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Opened this quarter; sold out this quarter (`shares` 0). `new` and the changes are null when the quarter before isn't on file."},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the 13F was accepted, UTC."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The 13F filing."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DisclosuresActivistsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it was accepted, UTC."},"symbol":{"description":"The company and its SEC CIK."},"company":{"description":"The company and its SEC CIK."},"cik":{"description":"The company and its SEC CIK."},"filer":{"description":"Who filed it."},"filer_cik":{"description":"Who filed it."},"form":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`13D` or `13G`."},"amendment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"An amendment to an earlier filing."},"owned_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percent of the class owned."},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares owned."},"event_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Date of the event that required it, `YYYY-MM-DD`."},"cusip":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CUSIP of the class."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The filing."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"DisclosuresCongressResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"chamber":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`house` or `senate`."},"member":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The member and their Bioguide id, e.g. `P000197`."},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The member and their Bioguide id, e.g. `P000197`."},"party":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`democrat`, `republican` or `independent`."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `CA` and `11`; no district for senators."},"district":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. `CA` and `11`; no district for senators."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was traded, as reported."},"asset":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was traded, as reported."},"asset_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What was traded, as reported."},"owner":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`self`, `spouse`, `joint` or `child`."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`buy`, `sell`, `exchange` or `other`."},"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The range reported, e.g. `$1,001 - $15,000`."},"amount_min_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its bounds; an exact amount is both, an `Over` range has no max."},"amount_max_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its bounds; an exact amount is both, an `Over` range has no max."},"transaction_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`YYYY-MM-DD`."},"disclosure_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`YYYY-MM-DD`."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The report."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"KpisResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"kpi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"KPI id, e.g. `vehicle_deliveries`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its name, e.g. `Vehicle deliveries`."},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fiscal quarter `2026-Q3`, ISO week `2026-W44` or day `2026-11-04`."},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the period, `YYYY-MM-DD`."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"As first reported, in whole units: `486532` vehicles, `59800000000` dollars, `3.1` for 3.1%."},"restated_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The figure a filing a year later printed for this period, when it differs from `value`; else null."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`usd`, `percent`, `basis_points`, or what is counted, e.g. `vehicles`, `members`, `nights`."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`reported` or `tracked`. Reported values come from filings. Tracked values come from the web."},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The document or page it was read from."},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The SEC filing, null for tracked."},"quote":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sentence or table row holding the number, as printed."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"KpisDefinitionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"kpi":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"KPI id."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its name."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`usd`, `percent`, `basis_points`, or what is counted, e.g. `vehicles`, `members`, `nights`."},"frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`quarterly`, `weekly` or `daily`."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`reported` or `tracked`. Reported values come from filings. Tracked values come from the web."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What it counts."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`active`, `stopped` (not reported in the company's last two quarters, or dropped by the company) or `replaced` (redefined)."},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For `replaced`: the KPI id that carries on. Else null."},"added_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The quarter it was first tracked."},"first_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The earliest period with a value."},"last_period":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The latest."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"MarketStatusResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"open":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the regular session is open."},"session":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`pre_market`, `regular`, `after_hours` or `closed`."},"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Now, UTC."},"next_open_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The next regular open and close, UTC."},"next_close_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The next regular open and close, UTC."},"holidays":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`date`, `name`, `status` (`closed` or `early_close`), and an early close's `open_at` and `close_at`, UTC."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"MarketIndicesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`SPX`, `NDX`, `RUT`, `DJI` or `VIX`, and its name."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`SPX`, `NDX`, `RUT`, `DJI` or `VIX`, and its name."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The index level."},"change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change from the previous close, in points and percent."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Change from the previous close, in points and percent."},"previous_close":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The previous close."},"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the level was taken, UTC."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"MarketBreadthResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"up":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stocks up, down and counted."},"down":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stocks up, down and counted."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Stocks up, down and counted."},"strong_up":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Up or down 4% or more."},"strong_down":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Up or down 4% or more."},"buckets":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`min_change_pct`, `max_change_pct` (null at the open ends) and `count`, from below -4% to above 4%."},"equal_weight_change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The equal-weight S&P 500 (RSP) today."},"cap_weight_change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The S&P 500 (SPY) today."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"MarketSectorsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sector, named as `sector` is everywhere (`Healthcare`), or the theme; and `sector` or `theme`."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sector, named as `sector` is everywhere (`Healthcare`), or the theme; and `sector` or `theme`."},"etf":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sectors: the SPDR ETF. Null for themes."},"basket":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Themes: the member tickers. Null for sectors."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Themes: what it holds."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sectors: the ETF's price."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Session of the ETF price, or the theme return."},"stale":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"True when the ETF price is from an earlier session. Null for themes or a missing quote."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Daily return. Null without a quote from the session, or without current quotes for any theme member."},"return_1w_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns over a week, a month, three months, the year so far and a year (sectors)."},"return_1m_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns over a week, a month, three months, the year so far and a year (sectors)."},"return_3m_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns over a week, a month, three months, the year so far and a year (sectors)."},"return_ytd_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns over a week, a month, three months, the year so far and a year (sectors)."},"return_1y_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns over a week, a month, three months, the year so far and a year (sectors)."},"members":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Members ($10B+ companies for sectors)."},"members_quoted":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Members quoted in the session, and those with positive, negative and unchanged returns."},"members_up":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Members quoted in the session, and those with positive, negative and unchanged returns."},"members_down":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Members quoted in the session, and those with positive, negative and unchanged returns."},"members_flat":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Members quoted in the session, and those with positive, negative and unchanged returns."},"best":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"The top and bottom three members today: `symbol`, `name`, `change_pct`."},"worst":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"The top and bottom three members today: `symbol`, `name`, `change_pct`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta","properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The session used for daily returns and rankings."}}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"CalendarEarningsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and short name."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and short name."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Report day, New York."},"timing":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`before_open`, `after_close` or `unknown`."},"confirmed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The company itself has given this day: its press release, filing or investor site."},"fiscal_period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last day of the quarter reported."},"eps_estimate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Expected EPS and reported EPS. Actuals use verified adjusted EPS when available and are null until supported."},"eps_actual":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Expected EPS and reported EPS. Actuals use verified adjusted EPS when available and are null until supported."},"revenue_estimate_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Revenue expected and reported."},"revenue_actual_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Revenue expected and reported."},"market_cap_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Market cap."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"CalendarEconomicResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Release time, UTC."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where, and its currency."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where, and its currency."},"event":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The release, e.g. `Nonfarm Payrolls (Oct)`."},"impact":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`low`, `medium`, `high` or null."},"actual":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The reading, the consensus and the prior."},"estimate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The reading, the consensus and the prior."},"previous":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The reading, the consensus and the prior."},"change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The actual against the prior."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The actual against the prior."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unit, e.g. `%` or `K`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"NewsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Story id."},"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Published, UTC."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Headline and a short summary."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Headline and a short summary."},"symbols":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Tickers it covers."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Publisher and the article."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Publisher and the article."},"sentiment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`positive`, `negative`, `neutral` or `mixed`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"ScreenerStocksResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, name, `stock`, `etf` or `adr`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, name, `stock`, `etf` or `adr`."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, name, `stock`, `etf` or `adr`."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's sector and industry, named as on every endpoint; null for funds."},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's sector and industry, named as on every endpoint; null for funds."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The session of the completed scan. Returned with price, change, gap or dollar volume."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Scan price, its change in dollars and percent, the opening gap and the after-hours move recorded by the scan."},"change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Scan price, its change in dollars and percent, the opening gap and the after-hours move recorded by the scan."},"change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Scan price, its change in dollars and percent, the opening gap and the after-hours move recorded by the scan."},"gap_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Scan price, its change in dollars and percent, the opening gap and the after-hours move recorded by the scan."},"after_hours_change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Scan price, its change in dollars and percent, the opening gap and the after-hours move recorded by the scan."},"open":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"high":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"low":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The session's prices."},"return_1w_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns."},"return_1m_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns."},"return_3m_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns."},"return_6m_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns."},"return_ytd_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns."},"return_1y_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns."},"from_52w_high_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distance from the 52-week high and low."},"from_52w_low_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distance from the 52-week high and low."},"dollar_volume_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Scan price times scan volume."},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares, the 20-session average, its dollars, and session volume divided by average volume."},"average_volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares, the 20-session average, its dollars, and session volume divided by average volume."},"average_dollar_volume_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares, the 20-session average, its dollars, and session volume divided by average volume."},"relative_volume":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Shares, the 20-session average, its dollars, and session volume divided by average volume."},"volume_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The session used for volume, dollar volume and relative volume. Returned with any of these fields."},"average_true_range":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ATR in dollars and percent, average daily range, beta."},"average_true_range_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ATR in dollars and percent, average daily range, beta."},"average_daily_range_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ATR in dollars and percent, average daily range, beta."},"beta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ATR in dollars and percent, average daily range, beta."},"rsi":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"RSI (14), stochastic %K, ADX (14)."},"stochastic":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"RSI (14), stochastic %K, ADX (14)."},"adx":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"RSI (14), stochastic %K, ADX (14)."},"macd_histogram_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"MACD histogram as a percent of price."},"vs_sma_20_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Price against each moving average."},"vs_sma_50_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Price against each moving average."},"vs_sma_200_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Price against each moving average."},"bollinger_width_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Bollinger band width."},"relative_strength":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The year's return weighted to its last quarter, ranked across the market, 1 to 99."},"technical_rating":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"-1 (strong sell) to 1 (strong buy)."},"closes_30d":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"The last 30 closes scaled 0 to 99 within their range."},"market_cap_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"pe_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"peg_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"price_to_sales":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"price_to_book":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"price_to_free_cash_flow":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"ev_to_ebitda":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size and trailing valuation."},"free_cash_flow_yield_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Yields."},"dividend_yield_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Yields."},"eps_ttm":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Trailing twelve-month EPS."},"gross_margin_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Margins."},"operating_margin_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Margins."},"net_margin_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Margins."},"return_on_equity_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns on capital."},"return_on_assets_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns on capital."},"return_on_invested_capital_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns on capital."},"debt_to_equity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Leverage, liquidity, payout."},"current_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Leverage, liquidity, payout."},"payout_ratio_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Leverage, liquidity, payout."},"analyst_rating":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average rating 1 (strong sell) to 5 (strong buy), analysts covering, share rating it a buy."},"analysts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average rating 1 (strong sell) to 5 (strong buy), analysts covering, share rating it a buy."},"analyst_buy_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average rating 1 (strong sell) to 5 (strong buy), analysts covering, share rating it a buy."},"price_target":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average target and the distance to it."},"upside_to_target_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average target and the distance to it."},"next_earnings_date":{"description":"Next report and days until it."},"days_to_earnings":{"description":"Next report and days until it."},"last_surprise_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The last EPS surprise and days since."},"days_since_earnings":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The last EPS surprise and days since."},"insider_net_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Insider buys less sells over 30 days."},"congress_net_trades":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Congress buys less sells over 45 days."},"short_interest_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short interest of shares outstanding, days to cover, short share of volume."},"days_to_cover":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short interest of shares outstanding, days to cover, short share of volume."},"short_volume_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Short interest of shares outstanding, days to cover, short share of volume."},"options_premium_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Options premium in the session, bullish less bearish, and the bullish share."},"options_net_premium_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Options premium in the session, bullish less bearish, and the bullish share."},"options_bullish_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Options premium in the session, bullish less bearish, and the bullish share."},"put_call_premium_ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Put premium over call premium."},"options_net_premium_5d_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net premium over five sessions, and as a percent of their premium."},"options_net_premium_5d_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Net premium over five sessions, and as a percent of their premium."},"options_premium_relative":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Premium over the 20-session average."},"sweep_premium_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Premium in sweeps and in opening trades."},"opening_premium_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Premium in sweeps and in opening trades."},"million_dollar_trades":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Prints of $1M or more."},"implied_volatility_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV, its rank over the year 0 to 100, its change in points."},"iv_rank":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV, its rank over the year 0 to 100, its change in points."},"iv_change":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV, its rank over the year 0 to 100, its change in points."},"implied_move_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The daily move IV implies."},"dark_pool_value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Off-exchange block value on `dark_pool_date`, over its 20-session average, and against its 5-session average."},"dark_pool_relative":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Off-exchange block value on `dark_pool_date`, over its 20-session average, and against its 5-session average."},"dark_pool_vs_5d_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Off-exchange block value on `dark_pool_date`, over its 20-session average, and against its 5-session average."},"dark_pool_average_5d_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The 5-session daily average and total."},"dark_pool_5d_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The 5-session daily average and total."},"exchange_blocks_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Exchange blocks and the auctions, apart."},"closing_auction_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Exchange blocks and the auctions, apart."},"opening_auction_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Exchange blocks and the auctions, apart."},"dark_pool_ask_share_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ask-side share of classified prints, and off-exchange share of block value, over five sessions."},"off_exchange_share_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Ask-side share of classified prints, and off-exchange share of block value, over five sessions."},"labels":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Label ids the row carries."}}}},"meta":{"$ref":"#/components/schemas/ListMeta","properties":{"volume_basis":{"type":"string","enum":["regular_live","last_completed_scan"],"description":"`last_completed_scan`."},"quote_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null because this endpoint reads the completed scan."}}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"ScreenerFieldsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"fields":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name`, `group` (Price, Technical, Options, Dark pool …), `type` (`number`, `string`, `date` or `array`)."},"labels":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`id`, `name`, `group`, `lean` (1 bullish, -1 bearish, 0 neither)."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"SignalsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Id, session, and when it fired, UTC."},"date":{"description":"Id, session, and when it fired, UTC."},"fired_at":{"description":"Id, session, and when it fired, UTC."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pattern's id and name."},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pattern's id and name."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying and the contract the flow bought (OCC)."},"contract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying and the contract the flow bought (OCC)."},"type":{"description":"`call` or `put`, strike, expiry."},"strike":{"description":"`call` or `put`, strike, expiry."},"expiry":{"description":"`call` or `put`, strike, expiry."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The print's price and the NBBO at its second; the signal is bought at `ask`."},"bid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The print's price and the NBBO at its second; the signal is bought at `ask`."},"ask":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The print's price and the NBBO at its second; the signal is bought at `ask`."},"premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The order's premium, contracts, and open interest before today."},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The order's premium, contracts, and open interest before today."},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The order's premium, contracts, and open interest before today."},"iv":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV and delta (decimals), and the stock's price."},"delta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV and delta (decimals), and the stock's price."},"spot":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV and delta (decimals), and the stock's price."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The signal in a line and a paragraph."},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The signal in a line and a paragraph."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`open` or `settled` (at expiry)."},"return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its latest mark, or its settlement, and its best mark so far against the ask, as decimals (0.25 is 25%)."},"best_return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its latest mark, or its settlement, and its best mark so far against the ask, as decimals (0.25 is 25%)."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"SignalsPerformanceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pattern (`all` for every signal) and its name."},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pattern (`all` for every signal) and its name."},"window":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`7d`, `30d`, `90d` or `all`, by the day it fired."},"signals":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Signals, and how many have settled."},"settled":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Signals, and how many have settled."},"win_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Share with a gain, decimal."},"average_return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns against the ask, decimals."},"median_return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns against the ask, decimals."},"best_return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns against the ask, decimals."},"worst_return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Returns against the ask, decimals."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"SignalsIdResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"Id, session, and when it fired, UTC."},"date":{"description":"Id, session, and when it fired, UTC."},"fired_at":{"description":"Id, session, and when it fired, UTC."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pattern's id and name."},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pattern's id and name."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying and the contract the flow bought (OCC)."},"contract":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying and the contract the flow bought (OCC)."},"type":{"description":"`call` or `put`, strike, expiry."},"strike":{"description":"`call` or `put`, strike, expiry."},"expiry":{"description":"`call` or `put`, strike, expiry."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The print's price and the NBBO at its second; the signal is bought at `ask`."},"bid":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The print's price and the NBBO at its second; the signal is bought at `ask`."},"ask":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The print's price and the NBBO at its second; the signal is bought at `ask`."},"premium_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The order's premium, contracts, and open interest before today."},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The order's premium, contracts, and open interest before today."},"open_interest":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The order's premium, contracts, and open interest before today."},"iv":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV and delta (decimals), and the stock's price."},"delta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV and delta (decimals), and the stock's price."},"spot":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"IV and delta (decimals), and the stock's price."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The signal in a line and a paragraph."},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The signal in a line and a paragraph."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`open` or `settled` (at expiry)."},"return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its latest mark, or its settlement, and its best mark so far against the ask, as decimals (0.25 is 25%)."},"best_return":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its latest mark, or its settlement, and its best mark so far against the ask, as decimals (0.25 is 25%)."},"facts":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`stock_price`, `stock_change`, `stock_prior_change`, `market_change`, `days_to_expiry`, `out_of_the_money` (share of spot, negative in the money), `size_to_open_interest`, `day_volume_to_open_interest`, `repeats_today`, `repeat_sessions` (of the last five), `net_premium_lean`, `premium_pace`, `premium_burst`, `iv_relative`, `realized_volatility_20d`, `dollar_volume_20d_usd`. Changes are decimals."},"prints":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"The contract's prints and the underlying's flow in the 15 minutes before it fired: `role`, `time`, `symbol`, `type`, `strike`, `expiry`, `price`, `bid`, `ask`, `size`, `premium_usd`, `side` (`bought`, `sold` or `mid`), `sweep`, `open_interest`, `iv`."},"marks":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`time` and `value`: the NBBO mid every five minutes, then the settlement."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"InsightsMarketResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Headline and summary."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Headline and summary."},"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it was written, UTC."},"sections":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`title`, `summary` and `symbols` per story."},"events":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Upcoming events, one line each."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"InsightsMoversResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and short name."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker and short name."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The story in a line and a paragraph."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The story in a line and a paragraph."},"time":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Written, UTC."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"ProbabilitiesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question, and `close`, `range`, `hit` or `earnings`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question, and `close`, `range`, `hit` or `earnings`."},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question, and `close`, `range`, `hit` or `earnings`."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`kalshi` or `polymarket`."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying, e.g. `SPX`, `NVDA`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying, e.g. `SPX`, `NVDA`."},"resolves_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it resolves, UTC."},"underlying_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The underlying's price."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Earnings questions: the report day, `before_open` or `after_close`."},"report_timing":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Earnings questions: the report day, `before_open` or `after_close`."},"outcomes":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`market` (Kalshi ticker or Polymarket condition id), `label`, `kind`, `level`, `level_high`, `resolves_at`, `chance` (0.62 is 62%)."},"distribution":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`kind` and `bins` (`low`, `high`, `chance`): the crowd's distribution of the outcome."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"ProbabilitiesOutlookResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"description":"`SPX` and its level."},"price":{"description":"`SPX` and its level."},"horizons":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`resolves_at`, `horizon` (`close`, `week`, `month`, `year`), `basis` (`close` or `touch`), `levels` (`level`, `chance_at_or_above`)."},"track":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`symbol` (`SPX` or `NDX`), `date`, `called_low`, `called_middle`, `called_high` (the crowd at 10 AM) and `close`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"ProbabilitiesSettledResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The market."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The market."},"series":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The market."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The market."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The market."},"event_title":{"description":"Polymarket: the event and its outcomes."},"outcomes":{"description":"Polymarket: the event and its outcomes."},"outcome":{"description":"Kalshi: the yes outcome and its levels."},"strike_type":{"description":"Kalshi: the yes outcome and its levels."},"floor":{"description":"Kalshi: the yes outcome and its levels."},"cap":{"description":"Kalshi: the yes outcome and its levels."},"opened_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC."},"closed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC."},"settled_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC."},"result":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Kalshi `yes` or `no`; Polymarket the winning outcome."},"settled_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Kalshi: the value it settled on."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"ProbabilitiesIdHistoryResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"question":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question's `id`, null for a settled market."},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The outcome and its label."},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The outcome and its label."},"interval":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`hour` or `day`."},"points":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`time` (UTC) and `chance`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"ProbabilitiesIdResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question, and `close`, `range`, `hit` or `earnings`."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question, and `close`, `range`, `hit` or `earnings`."},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The question, and `close`, `range`, `hit` or `earnings`."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`kalshi` or `polymarket`."},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying, e.g. `SPX`, `NVDA`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The underlying, e.g. `SPX`, `NVDA`."},"resolves_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When it resolves, UTC."},"underlying_price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The underlying's price."},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Earnings questions: the report day, `before_open` or `after_close`."},"report_timing":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Earnings questions: the report day, `before_open` or `after_close`."},"outcomes":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`market` (Kalshi ticker or Polymarket condition id), `label`, `kind`, `level`, `level_high`, `resolves_at`, `chance` (0.62 is 62%)."},"distribution":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`kind` and `bins` (`low`, `high`, `chance`): the crowd's distribution of the outcome."},"reports":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Earnings questions: `beats` of `rated`, `up`, `median_move_pct`, and `rows` (`date`, `eps`, `eps_estimate`, `beat`, `surprise_pct`, `move_pct`)."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"FundResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"started_date":{"description":"The first day, and the return since as a decimal."},"total_return":{"description":"The first day, and the return since as a decimal."},"exposure":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`names`, `net_delta`, `gross_delta`, `beta_adjusted_net_delta`, `largest_name_gross_delta`, `largest_sector_gross_delta`, `theta_per_day`, `vega_per_vol_point`, `premium_long`, `premium_short` (fractions of the fund) and `sectors` (`name`, `net_delta`, `gross_delta`)."},"positions":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Open trades as in Fund trades, without fills."},"posts":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`id`, `time`, `kind` (`post` or `letter`), `trade_id`, `title`, `markdown`, newest first."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"FundTradesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The trade: `open` or `closed`, `long` or `short`."},"title":{"description":"The trade: `open` or `closed`, `long` or `short`."},"symbols":{"description":"The trade: `open` or `closed`, `long` or `short`."},"status":{"description":"The trade: `open` or `closed`, `long` or `short`."},"direction":{"description":"The trade: `open` or `closed`, `long` or `short`."},"opened_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC."},"closed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"UTC."},"catalyst":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was opened, and its post."},"idea_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was opened, and its post."},"post_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was opened, and its post."},"net_premium":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Premium paid (negative when collected) and the most it can lose at expiry, as fractions of the fund."},"max_loss":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Premium paid (negative when collected) and the most it can lose at expiry, as fractions of the fund."},"loss_unbounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the loss has no cap."},"legs":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name`, `contract`, `symbol`, `type`, `strike`, `expiry`, `side` (`long` or `short`), `quantity`, `entry_price`, `bid`, `ask`, `mid`."},"fills":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name`, `contract`, `symbol`, `type`, `strike`, `expiry`, `side` (`bought` or `sold`), `quantity`, `price`, `time`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"SymbolsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Short company or fund name."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`stock`, `etf`, `adr` or `index`."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"SymbolsSymbolResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, short name, `stock`, `etf`, `adr` or `index`."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, short name, `stock`, `etf`, `adr` or `index`."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticker, short name, `stock`, `etf`, `adr` or `index`."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's sector and industry, named as on every endpoint; null for funds and indices."},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The company's sector and industry, named as on every endpoint; null for funds and indices."},"market_cap_usd":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Shares outstanding at the price."},"intraday_bars":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether it has intraday bars (Bars)."},"quote":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"The live quote as in Quotes: `date` (the session it's from), `price`, `change`, `change_pct`, `previous_close`, `volume`, `dollar_volume_usd`, `gap_pct`, `relative_volume`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AccountPortfolioResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"connected":{"description":"The link's state."},"syncing":{"description":"The link's state."},"synced_at":{"description":"The link's state."},"accounts":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`id`, `broker`, `name`, `currency`, `value`, `cash`, `buying_power`, `disabled`, `duplicate` (a brokerage listed twice), `synced_at`."},"stocks":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`account_id`, `symbol`, `name`, `kind`, `sector`, `quantity`, `price`, `average_cost`, `value`, `cost`, `pnl`, `pnl_pct`, `day_change`, `day_change_pct`, `currency`."},"options":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`account_id`, `contract`, `symbol`, `type`, `strike`, `expiry`, `days_to_expiry`, `contracts`, `multiplier`, `price`, `average_cost`, `value`, `cost`, `pnl`, `pnl_pct`, `underlying_price`, `underlying_change_pct`."},"orders":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"The latest 80 order legs: `id`, `account_id`, `time`, `status`, `open`, `action`, `symbol`, `type`, `strike`, `expiry`, `quantity`, `filled`, `price`, `order_type`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AccountPortfolioTradesResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"since_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the history starts."},"unmatched_closes":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Closes with no opening in the history."},"income":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Per account id: `dividends` and `fees`."},"trips":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`id`, `account_id`, `kind`, `symbol`, `type`, `strike`, `expiry`, `side`, `quantity`, `opened_date`, `closed_date`, `open_price`, `close_price`, `pnl`, `pnl_pct`, `days_held`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AccountPortfolioFactorsResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"model_date":{"description":"The model's day, the book and its cash."},"value":{"description":"The model's day, the book and its cash."},"cash":{"description":"The model's day, the book and its cash."},"risk":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"`volatility`, `beta`, `value_at_risk_95_1d`, `tracking_error`, `long`, `short`, `cash_share`, and the risk shares `market_share`, `sector_share`, `style_share`, `interaction_share`, `specific_share`."},"factors":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`factor`, `name`, `group`, `exposure`, `volatility`, `risk_share`, `active_exposure`, `tracking_error_share`."},"holdings":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`symbol`, `name`, `value`, `weight`, `options`, `beta`, `volatility`, `specific_volatility`, `risk_share`, `specific_risk_share`, `tracking_error_share`, `marginal_risk`, `sector`, `industry`, `kind`, `country`; `others` counts small holdings merged into one row."},"not_modeled":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`symbol` and `value` of holdings the model can't price."},"stress_tests":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`name`, `story`, `start_date`, `end_date`, `sp500_return`, `portfolio_return`, `market_part`, `other_part`, `change` (in money)."},"attribution":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`window` (`1D` to `1Y`), `days`, `portfolio_return`, `sp500_return`, `market_part`, `style_part`, `sector_part`, `specific_part`, `options_part`."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AccountBacktestsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The backtest."},"title":{"description":"The backtest."},"messages":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Messages in it."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last activity, UTC."},"match":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"With `q`: the words around the first hit."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"AccountBacktestsIdResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The backtest."},"title":{"description":"The backtest."},"messages":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`role`, `content`, `time`."},"runs":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`run_id`, `name`, `summary`, `spec`; `stats` (`strategy` and `benchmark`: `total_return`, `cagr`, `volatility`, `sharpe`, `sortino`, `max_drawdown`, `max_drawdown_start`, `max_drawdown_end`, `best_year`, `worst_year`; `start_date`, `end_date`, `fills`, `round_trips`, `win_rate`, `beta`, `fees_usd`); `equity` (`date`, `equity_usd`, `benchmark_usd`); `round_trips` (`symbol`, `entry_date`, `exit_date`, `shares`, `entry_price`, `exit_price`, `pnl_usd`, `return`, `days_held`, `exit_reason`)."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AccountDashboardsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The dashboard."},"name":{"description":"The dashboard."},"revision":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bumped on every save."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last save, UTC."},"widgets":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Widgets it holds."},"copied_from":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The public dashboard it was copied from."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]},"AccountDashboardsIdResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The dashboard."},"name":{"description":"The dashboard."},"revision":{"description":"The dashboard."},"updated_at":{"description":"The dashboard."},"widgets":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`id`, `widget`, `symbol`, `link_group`, `x`, `y`, `width`, `height`, `auto_height`, `options`."},"links":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"`link_group` and the `symbol` its widgets share."}}},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AccountWatchlistsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list."},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether it is your default list."},"symbols":{"anyOf":[{"type":"array"},{"type":"null"}],"description":"Its tickers."}}}},"meta":{"$ref":"#/components/schemas/ListMeta"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null at the end."},"next_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Next page URL without the API key, or null."}},"required":["data","meta","next_cursor","next_url"]}},"securitySchemes":{"apiKey":{"type":"apiKey","in":"query","name":"apiKey"}},"responses":{"Error400":{"description":"Invalid or missing request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error401":{"description":"Missing, invalid or revoked API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error402":{"description":"x402 payment required or payment could not be settled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"PAYMENT-REQUIRED":{"description":"x402 payment requirements, when a challenge is issued.","schema":{"type":"string"}}}},"Error403":{"description":"Account disabled or endpoint scope required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error404":{"description":"Requested data was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error429":{"description":"Rate limit or daily quota exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"Retry-After":{"description":"Seconds until the limit resets.","schema":{"type":"integer"}}}},"Error500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error503":{"description":"Data or payments temporarily unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying, when available.","schema":{"type":"integer"}}}}}},"security":[{"apiKey":[]}]}