# symbols-list

> Get a list of all stock and crypto symbols supported by IEX, and their associated information. This is a work in progress as I work to understand npm modules, so please don't mind the dust for now...

Latest version **0.2.4** (published 2020-10-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install symbols-list
pnpm add symbols-list
yarn add symbols-list
bun add symbols-list
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2020-10-15 |
| First published | 2020-09-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.6 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Daniel Raeder |
| Maintainers | draeder |
| Keywords | symbols, stocks, tickers, finance |

## Links

- npm: https://www.npmjs.com/package/symbols-list
- Repository: https://github.com/draeder/symbols-list
- Homepage: https://github.com/draeder/symbols-list#readme
- Issues: https://github.com/draeder/symbols-list/issues
- npm.io page: https://npm.io/package/symbols-list

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.88.2

## Recent versions

- 0.2.4 (latest) — 2020-10-15
- 0.2.3 — 2020-10-15
- 0.2.2 — 2020-10-15
- 0.2.1 — 2020-09-29
- 0.2.0 — 2020-09-29
- 0.1.9 — 2020-09-26
- 0.1.8 — 2020-09-26
- 0.1.7 — 2020-09-26
- 0.1.5 — 2020-09-26
- 0.1.4 — 2020-09-26
- 0.1.3 — 2020-09-26
- 0.1.2 — 2020-09-26
- 0.1.0 — 2020-09-26
- 0.0.9 — 2020-09-26
- 0.0.8 — 2020-09-26
- … 7 more at https://npm.io/package/symbols-list/versions

## 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
`<script src="https://draeder.github.io/symbols-list/symbols.min.js"></script>`

## 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"
```

---
_Source: https://npm.io/package/symbols-list · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._