fmp-node-api 0.0.3 → 0.0.4
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 +6 -3
- package/dist/index.d.mts +288 -202
- package/dist/index.d.ts +288 -202
- package/dist/index.js +166 -40
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +166 -40
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -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
|
|
|
@@ -173,7 +175,7 @@ const unemployment = await fmp.economic.getUnemployment();
|
|
|
173
175
|
|
|
174
176
|
### Other Asset Classes
|
|
175
177
|
|
|
176
|
-
|
|
178
|
+
```typescript
|
|
177
179
|
// Forex
|
|
178
180
|
const forexQuote = await fmp.forex.getQuote({ symbol: 'EURUSD' });
|
|
179
181
|
const forexList = await fmp.forex.getForexList();
|
|
@@ -204,6 +206,7 @@ const companies = await fmp.company.searchCompany({ query: 'Apple' });
|
|
|
204
206
|
|
|
205
207
|
// Company profile
|
|
206
208
|
const companyProfile = await fmp.company.getCompanyProfile({ symbol: 'AAPL' });
|
|
209
|
+
```
|
|
207
210
|
|
|
208
211
|
## Testing
|
|
209
212
|
|
|
@@ -213,7 +216,7 @@ This package includes comprehensive tests for all endpoints. There are two test
|
|
|
213
216
|
|
|
214
217
|
```bash
|
|
215
218
|
pnpm test
|
|
216
|
-
|
|
219
|
+
```
|
|
217
220
|
|
|
218
221
|
- Uses Jest to run all tests
|
|
219
222
|
- Automatically loads API key from `.env` file
|