fmp-node-api 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -5
- package/dist/index.d.mts +379 -242
- package/dist/index.d.ts +379 -242
- package/dist/index.js +242 -42
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +242 -43
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
A comprehensive Node.js wrapper for the Financial Modeling Prep (FMP) API with full TypeScript support and organized endpoint structure.
|
|
4
4
|
|
|
5
|
-
> **📖
|
|
5
|
+
> **📖 Visit the [Documentation](https://fmp-node-wrapper-docs.vercel.app/) for detailed information.**
|
|
6
|
+
|
|
7
|
+
> **🔧 For development information, contributing guidelines, and project details, visit the [main repository](https://github.com/e-roy/fmp-node-wrapper).**
|
|
6
8
|
|
|
7
9
|
## Features
|
|
8
10
|
|
|
@@ -62,13 +64,12 @@ const fmp = new FMP({
|
|
|
62
64
|
|
|
63
65
|
### Available Modules
|
|
64
66
|
|
|
67
|
+
- **`fmp.quote`** - Quote data for stocks, forex, crypto, commodities, and ETFs
|
|
65
68
|
- **`fmp.stock`** - Stock market data (quotes, profiles, historical prices, etc.)
|
|
66
69
|
- **`fmp.financial`** - Financial statements (income, balance sheet, cash flow)
|
|
67
|
-
- **`fmp.forex`** - Foreign exchange data
|
|
68
70
|
- **`fmp.crypto`** - Cryptocurrency data
|
|
69
71
|
- **`fmp.etf`** - ETF data and holdings
|
|
70
72
|
- **`fmp.mutualFund`** - Mutual fund data
|
|
71
|
-
- **`fmp.bond`** - Bond market data
|
|
72
73
|
- **`fmp.economic`** - Economic indicators
|
|
73
74
|
- **`fmp.market`** - Market-wide data and performance
|
|
74
75
|
- **`fmp.list`** - Stock lists and indices
|
|
@@ -173,7 +174,7 @@ const unemployment = await fmp.economic.getUnemployment();
|
|
|
173
174
|
|
|
174
175
|
### Other Asset Classes
|
|
175
176
|
|
|
176
|
-
|
|
177
|
+
```typescript
|
|
177
178
|
// Forex
|
|
178
179
|
const forexQuote = await fmp.forex.getQuote({ symbol: 'EURUSD' });
|
|
179
180
|
const forexList = await fmp.forex.getForexList();
|
|
@@ -204,6 +205,7 @@ const companies = await fmp.company.searchCompany({ query: 'Apple' });
|
|
|
204
205
|
|
|
205
206
|
// Company profile
|
|
206
207
|
const companyProfile = await fmp.company.getCompanyProfile({ symbol: 'AAPL' });
|
|
208
|
+
```
|
|
207
209
|
|
|
208
210
|
## Testing
|
|
209
211
|
|
|
@@ -213,7 +215,7 @@ This package includes comprehensive tests for all endpoints. There are two test
|
|
|
213
215
|
|
|
214
216
|
```bash
|
|
215
217
|
pnpm test
|
|
216
|
-
|
|
218
|
+
```
|
|
217
219
|
|
|
218
220
|
- Uses Jest to run all tests
|
|
219
221
|
- Automatically loads API key from `.env` file
|