finviz-api
v1.1.0
Published
An API Wrapper/Scrapper for FinViz
Readme
finviz-api
An API wrapper for FinViz
Functions
statement(ticker, [params], [corsBypass]) ⇒ Promise.<Object>
Get financial statement data for a stock
Kind: global function
Returns: Promise.<Object> - - A promise that resolves to the financial statement data
| Param | Type | Default | Description | | --- | --- | --- | --- | | ticker | string | | Stock ticker | | [params] | Object | {} | Fetch API options | | [corsBypass] | boolean | false | Attempt to bypass CORS (allOrigins) |
quote(ticker, [instrument], [params], [corsBypass]) ⇒ Promise.<Object>
Get quote data for a stock or cryptocurrency
Kind: global function
Returns: Promise.<Object> - - A promise that resolves to the quote data
| Param | Type | Default | Description | | --- | --- | --- | --- | | ticker | string | | Stock/Crypto ticker | | [instrument] | string | "stock" | Instrument type (stock[default] or crypto) | | [params] | Object | {} | Fetch API options | | [corsBypass] | boolean | false | Attempt to bypass CORS (allOrigins) |
Developer Deps
© 2024 nulxn
