https://github.com/harsohailb/ticker-symbol-search
Seamlessly integrate a search engine to find live ticker symbols into your web app
https://github.com/harsohailb/ticker-symbol-search
npm react react-library search stocks ticker typescript typescript-library yarn
Last synced: 3 months ago
JSON representation
Seamlessly integrate a search engine to find live ticker symbols into your web app
- Host: GitHub
- URL: https://github.com/harsohailb/ticker-symbol-search
- Owner: harsohailB
- Created: 2021-04-17T22:06:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T01:10:56.000Z (over 4 years ago)
- Last Synced: 2025-06-30T15:03:40.260Z (3 months ago)
- Topics: npm, react, react-library, search, stocks, ticker, typescript, typescript-library, yarn
- Language: TypeScript
- Homepage: ticker-symbol-search.vercel.app
- Size: 1.69 MB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Ticker Symbol Search
Seamlessly integrate a search engine to find live ticker symbols into your web app
View Demo
·
Report Bug
·
Request Feature
## Usage
## Installation
`npm install ticker-symbol-search`
or
`yarn add ticker-symbol-search`
## Quick Start
### Search Component
```JSX
import { TickerSymbolSearch } from ticker-symbol-search
export default () => {
const customTheme = {
paper: {
background: "rgba(128, 128, 128, 0.75)",
color: "white",
},
search: {
icon: {
color: "rgba(188, 204, 221, 0.25)",
},
input: {
color: "white",
placeholderColor: "rgba(188, 204, 221, 0.25)",
},
},
markets: {
background: "rgba(0, 0, 0, 0.25)",
color: "white",
},
selector: {
color: "white",
},
}
return console.log(data)}
theme={customTheme} // optional
/>;
}
```
### Hook
```javascript
import { useSearchSymbols } from ticker-symbol-search
export default () => {
const { symbols,
isSuccess,
isLoading,
isError } = useSearchSymbols(search, market);
}
```
where,
`search` ticker symbol query
`market` "ALL" | "Futures" | "Forex" | "CFD" | "Crypto" | "Index" | "Economic"
### Symbol Data Fetched
#### Stock Data Example
```json
{
"symbol": "AAPL",
"description": "APPLE INC",
"type": "stock",
"exchange": "NASDAQ",
"provider_id": "ice",
"typespecs": ["common"],
"country": "US"
}
```
### Types
```javascript
import {
StockSymbol,
FuturesSymbol,
ForexSymbol,
CFDSymbol,
CryptoSymbol,
IndexSymbol,
EconomicSymbol,
SymbolData, // union type of all symbols
} from "ticker-symbol-search";
```
## Development
To develop this package you need to install its dependencies and the dependencies of the example to test your changes
- Run `npm install` in `root` and `/example`
To concurrently develop and watch for your changes do the following:
- `yarn build:watch` in `root` to build your package
- `yarn start`in `/example`to run the React app to test
## Support
Please use the issues section to let us know about any bugs or issues. We will try our best to find a fix/solution for you!