https://github.com/draeder/symbols-list
Get a list of all stock and crypto symbols supported by IEX, and their associated information.
https://github.com/draeder/symbols-list
finance iex stocks symbols
Last synced: about 1 month ago
JSON representation
Get a list of all stock and crypto symbols supported by IEX, and their associated information.
- Host: GitHub
- URL: https://github.com/draeder/symbols-list
- Owner: draeder
- Created: 2020-09-25T21:57:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-15T03:15:05.000Z (over 4 years ago)
- Last Synced: 2024-10-29T20:00:03.969Z (6 months ago)
- Topics: finance, iex, stocks, symbols
- Language: JavaScript
- Homepage:
- Size: 2.37 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# symbols-list
Get a list of all stock and crypto symbols supported by [IEX](https://iextrading.com/apiexhibita), and their associated information.
# Usage
## Example
```
const Symbol = require('symbols-list')
const symbol = new Symbol
symbol.on("results", data => console.log(data))
symbol.get("random", 2)
```
## Installation
### Server
`npm i symbols-list`
### Browser
``
## Initialize symbols-list
### Server
```
const Symbols = require("symbols-list")
const symbols = new Symbols
```
### Browser
`const symbols = new Symbols()`
## Register the event listener to handler results
```
symbols.on("results", data => {
console.log(data)
})
```
## Make requests
### Return all symbols
`symbols.get("all")`
> Note: This will return 9000+ results so it will take some time
### Return one symbol
`symbols.get("find", "TSLA")`
### Return a list of symbols
`symbols.get("find", ["TSLA", "MSFT", "AAPL"])`
### Return only stock market symbols
`symbols.get("type", "stock")`
> Note: This will return 9000+ results so it will take some time
### Return only crypto market symbols
`symbols.get("type", "crypto")`
> Note: IEX supports very few crypto symbols
### Return random symbols
`symbols.get("random", 3)`
#### Return random symbols of a given type and size
```
symbols.get("random", {type: "crypto", size: 2})
symbols.get("random", {type: "stock", size: 2})
symbols.get("random", {size: 2}) // defaults to type "all"
```