fmp-node-api 0.1.8 → 0.1.9
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/dist/index.d.mts +294 -6
- package/dist/index.d.ts +294 -6
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/dist/types-only.d.mts +55 -21
- package/dist/types-only.d.ts +55 -21
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { FMPConfig, APIResponse, EarningsCalendar, EarningsConfirmed, DividendsCalendar, EconomicsCalendar, IPOCalendar, SplitsCalendar, CompanyProfile, ExecutiveCompensation, CompanyNotes, HistoricalEmployeeCount, SharesFloat, HistoricalSharesFloat, EarningsCallTranscript, CompanyTranscriptData, TreasuryRate, EconomicIndicator, ETFHoldingDates, ETFHolding, ETFHolder, ETFProfile, ETFWeighting, ETFCountryWeighting, ETFStockExposure, IncomeStatement, BalanceSheet, CashFlowStatement, KeyMetrics, FinancialRatios, EnterpriseValue, CashflowGrowth, IncomeGrowth, BalanceSheetGrowth, FinancialGrowth, EarningsHistorical, EarningsSurprises, InsiderTradingRSSResponse, InsiderTradingSearchResponse, TransactionTypesResponse, InsidersBySymbolResponse, InsiderTradeStatisticsResponse, CikMapperResponse, CikMapperBySymbolResponse, BeneficialOwnershipResponse, FailToDeliverResponse, TransactionType, Form13FResponse, InstitutionalHolderResponse, StockList, ETFList, CryptoList, ForexList, AvailableIndexesList, MarketHours, MarketPerformance, MarketSectorPerformance, MarketIndex, MutualFundHolding, Quote, HistoricalPriceResponse, HistoricalPriceData, ScreenerParams, Screener, AvailableExchanges, AvailableSectors, AvailableIndustries, AvailableCountries, RSSFeedItem, RSSFeedAllItem, RSSFeedV3Item, RSSFeed8KItem, SECFiling, IndustryClassification, IndustryClassificationCode, SenateTradingResponse, SenateHouseTradingByNameResponse, HouseTradingResponse, MarketCap, StockSplitResponse, StockDividendResponse, StockRealTimePrice, StockRealTimePriceFull } from './types-only.mjs';
|
|
1
|
+
import { FMPConfig, APIResponse, EarningsCalendar, EarningsConfirmed, DividendsCalendar, EconomicsCalendar, IPOCalendar, SplitsCalendar, CompanyProfile, ExecutiveCompensation, CompanyNotes, HistoricalEmployeeCount, SharesFloat, HistoricalSharesFloat, EarningsCallTranscript, CompanyTranscriptData, TreasuryRate, EconomicIndicator, ETFHoldingDates, ETFHolding, ETFHolder, ETFProfile, ETFWeighting, ETFCountryWeighting, ETFStockExposure, IncomeStatement, BalanceSheet, CashFlowStatement, KeyMetrics, FinancialRatios, EnterpriseValue, CashflowGrowth, IncomeGrowth, BalanceSheetGrowth, FinancialGrowth, EarningsHistorical, EarningsSurprises, InsiderTradingRSSResponse, InsiderTradingSearchResponse, TransactionTypesResponse, InsidersBySymbolResponse, InsiderTradeStatisticsResponse, CikMapperResponse, CikMapperBySymbolResponse, BeneficialOwnershipResponse, FailToDeliverResponse, TransactionType, Form13FResponse, InstitutionalHolderResponse, StockList, ETFList, CryptoList, ForexList, AvailableIndexesList, MarketHours, MarketPerformance, MarketSectorPerformance, MarketIndex, MutualFundHolding, Article, News, Quote, HistoricalPriceResponse, HistoricalPriceData, ScreenerParams, Screener, AvailableExchanges, AvailableSectors, AvailableIndustries, AvailableCountries, RSSFeedItem, RSSFeedAllItem, RSSFeedV3Item, RSSFeed8KItem, SECFiling, IndustryClassification, IndustryClassificationCode, SenateTradingResponse, SenateHouseTradingByNameResponse, HouseTradingResponse, MarketCap, StockSplitResponse, StockDividendResponse, StockRealTimePrice, StockRealTimePriceFull } from './types-only.mjs';
|
|
2
2
|
export { CompaniesPriceListResponse, DateRangeParams, EconomicIndicatorName, Exchange, IndividualIndustryClassificationParams, IndustryClassificationCodesParams, MarketHoliday, PaginationParams, Period, PeriodParams, QueryParams, RSSFeed8KParams, RSSFeedParams, RSSFeedV3Params, SECFilingsParams, StockDividend, StockListResponse, StockSplit, SymbolParams } from './types-only.mjs';
|
|
3
3
|
export { FMPValidation } from './utils/validation.mjs';
|
|
4
4
|
|
|
@@ -1167,6 +1167,7 @@ declare class InsiderEndpoints {
|
|
|
1167
1167
|
*
|
|
1168
1168
|
* @param params - RSS feed request parameters
|
|
1169
1169
|
* @param params.page - Page number for pagination (default: 0)
|
|
1170
|
+
* @param params.limit - Limit number of results (default: 100)
|
|
1170
1171
|
*
|
|
1171
1172
|
* @returns Promise resolving to array of insider trading RSS feed data
|
|
1172
1173
|
*
|
|
@@ -1182,10 +1183,11 @@ declare class InsiderEndpoints {
|
|
|
1182
1183
|
* const nextPage = await fmp.insider.getInsiderTradingRSS({ page: 1 });
|
|
1183
1184
|
* ```
|
|
1184
1185
|
*
|
|
1185
|
-
* @see {@link https://site.financialmodelingprep.com/developer/docs#
|
|
1186
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#latest-insider-trade|FMP Insider Trading RSS Documentation}
|
|
1186
1187
|
*/
|
|
1187
1188
|
getInsiderTradingRSS(params: {
|
|
1188
1189
|
page?: number;
|
|
1190
|
+
limit?: number;
|
|
1189
1191
|
}): Promise<APIResponse<InsiderTradingRSSResponse[]>>;
|
|
1190
1192
|
/**
|
|
1191
1193
|
* Search for insider trades with advanced filtering
|
|
@@ -1200,6 +1202,7 @@ declare class InsiderEndpoints {
|
|
|
1200
1202
|
* @param params.companyCik - Company CIK to filter by (optional)
|
|
1201
1203
|
* @param params.transactionType - Transaction type to filter by (optional)
|
|
1202
1204
|
* @param params.page - Page number for pagination (default: 0)
|
|
1205
|
+
* @param params.limit - Limit number of results (default: 100)
|
|
1203
1206
|
*
|
|
1204
1207
|
* @returns Promise resolving to array of insider trading search results
|
|
1205
1208
|
*
|
|
@@ -1227,7 +1230,7 @@ declare class InsiderEndpoints {
|
|
|
1227
1230
|
* });
|
|
1228
1231
|
* ```
|
|
1229
1232
|
*
|
|
1230
|
-
* @see {@link https://site.financialmodelingprep.com/developer/docs#
|
|
1233
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#search-insider-trades|FMP Insider Trading Search Documentation}
|
|
1231
1234
|
*/
|
|
1232
1235
|
searchInsiderTrading(params: {
|
|
1233
1236
|
symbol?: string;
|
|
@@ -1235,6 +1238,7 @@ declare class InsiderEndpoints {
|
|
|
1235
1238
|
companyCik?: string;
|
|
1236
1239
|
transactionType?: string;
|
|
1237
1240
|
page?: number;
|
|
1241
|
+
limit?: number;
|
|
1238
1242
|
}): Promise<APIResponse<InsiderTradingSearchResponse[]>>;
|
|
1239
1243
|
/**
|
|
1240
1244
|
* Get all available transaction types
|
|
@@ -1254,7 +1258,7 @@ declare class InsiderEndpoints {
|
|
|
1254
1258
|
* });
|
|
1255
1259
|
* ```
|
|
1256
1260
|
*
|
|
1257
|
-
* @see {@link https://site.financialmodelingprep.com/developer/docs#transaction-types
|
|
1261
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#all-transaction-types|FMP Transaction Types Documentation}
|
|
1258
1262
|
*/
|
|
1259
1263
|
getTransactionTypes(): Promise<APIResponse<TransactionTypesResponse>>;
|
|
1260
1264
|
/**
|
|
@@ -1264,6 +1268,8 @@ declare class InsiderEndpoints {
|
|
|
1264
1268
|
* for a specific company. Essential for understanding corporate governance
|
|
1265
1269
|
* structure and identifying key personnel.
|
|
1266
1270
|
*
|
|
1271
|
+
* @deprecated This endpoint uses API version v4 which will be deprecated.
|
|
1272
|
+
*
|
|
1267
1273
|
* @param params - Insiders request parameters
|
|
1268
1274
|
* @param params.symbol - Stock symbol to get insiders for
|
|
1269
1275
|
*
|
|
@@ -1310,7 +1316,7 @@ declare class InsiderEndpoints {
|
|
|
1310
1316
|
* const msftStats = await fmp.insider.getInsiderTradeStatistics({ symbol: 'MSFT' });
|
|
1311
1317
|
* ```
|
|
1312
1318
|
*
|
|
1313
|
-
* @see {@link https://site.financialmodelingprep.com/developer/docs#insider-trade-statistics
|
|
1319
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#insider-trade-statistics|FMP Insider Trade Statistics Documentation}
|
|
1314
1320
|
*/
|
|
1315
1321
|
getInsiderTradeStatistics(params: {
|
|
1316
1322
|
symbol: string;
|
|
@@ -1322,6 +1328,8 @@ declare class InsiderEndpoints {
|
|
|
1322
1328
|
* names. Essential for converting between CIK numbers and company
|
|
1323
1329
|
* identifiers in insider trading analysis.
|
|
1324
1330
|
*
|
|
1331
|
+
* @deprecated This endpoint uses API version v4 which will be deprecated.
|
|
1332
|
+
*
|
|
1325
1333
|
* @param params - CIK mapper request parameters
|
|
1326
1334
|
* @param params.page - Page number for pagination (default: 0)
|
|
1327
1335
|
*
|
|
@@ -1351,6 +1359,8 @@ declare class InsiderEndpoints {
|
|
|
1351
1359
|
* Useful for finding companies by partial name matches and
|
|
1352
1360
|
* converting company names to CIK numbers.
|
|
1353
1361
|
*
|
|
1362
|
+
* @deprecated This endpoint uses API version v4 which will be deprecated.
|
|
1363
|
+
*
|
|
1354
1364
|
* @param params - CIK mapper by name request parameters
|
|
1355
1365
|
* @param params.name - Company name or partial name to search for
|
|
1356
1366
|
* @param params.page - Page number for pagination (default: 0)
|
|
@@ -1388,6 +1398,8 @@ declare class InsiderEndpoints {
|
|
|
1388
1398
|
* Essential for converting stock symbols to CIK numbers for use
|
|
1389
1399
|
* in insider trading searches and analysis.
|
|
1390
1400
|
*
|
|
1401
|
+
* @deprecated This endpoint uses API version v4 which will be deprecated.
|
|
1402
|
+
*
|
|
1391
1403
|
* @param params - CIK mapper by symbol request parameters
|
|
1392
1404
|
* @param params.symbol - Stock symbol to get CIK for
|
|
1393
1405
|
*
|
|
@@ -1417,6 +1429,7 @@ declare class InsiderEndpoints {
|
|
|
1417
1429
|
*
|
|
1418
1430
|
* @param params - Beneficial ownership request parameters
|
|
1419
1431
|
* @param params.symbol - Stock symbol to get beneficial ownership data for
|
|
1432
|
+
* @param params.limit - Limit number of results (default: 100)
|
|
1420
1433
|
*
|
|
1421
1434
|
* @returns Promise resolving to array of beneficial ownership acquisition data
|
|
1422
1435
|
*
|
|
@@ -1436,6 +1449,7 @@ declare class InsiderEndpoints {
|
|
|
1436
1449
|
*/
|
|
1437
1450
|
getBeneficialOwnership(params: {
|
|
1438
1451
|
symbol: string;
|
|
1452
|
+
limit?: number;
|
|
1439
1453
|
}): Promise<APIResponse<BeneficialOwnershipResponse[]>>;
|
|
1440
1454
|
/**
|
|
1441
1455
|
* Get fail to deliver data
|
|
@@ -1444,6 +1458,8 @@ declare class InsiderEndpoints {
|
|
|
1444
1458
|
* when market participants fail to deliver securities on settlement date.
|
|
1445
1459
|
* Important for understanding market mechanics and potential short interest.
|
|
1446
1460
|
*
|
|
1461
|
+
* @deprecated This endpoint uses API version v4 which will be deprecated.
|
|
1462
|
+
*
|
|
1447
1463
|
* @param params - Fail to deliver request parameters
|
|
1448
1464
|
* @param params.symbol - Stock symbol to get fail to deliver data for
|
|
1449
1465
|
* @param params.page - Page number for pagination (default: 0)
|
|
@@ -2133,6 +2149,277 @@ declare class MutualFundEndpoints {
|
|
|
2133
2149
|
getHolders(symbol: string): Promise<APIResponse<MutualFundHolding[]>>;
|
|
2134
2150
|
}
|
|
2135
2151
|
|
|
2152
|
+
declare class NewsEndpoints {
|
|
2153
|
+
private client;
|
|
2154
|
+
constructor(client: FMPClient);
|
|
2155
|
+
/**
|
|
2156
|
+
* Get FMP's curated financial articles and market insights
|
|
2157
|
+
*
|
|
2158
|
+
* Retrieves Financial Modeling Prep's own articles covering market analysis,
|
|
2159
|
+
* financial insights, and educational content. These articles provide valuable
|
|
2160
|
+
* context and analysis beyond raw market data.
|
|
2161
|
+
*
|
|
2162
|
+
* @param params - Article request parameters
|
|
2163
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2164
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2165
|
+
*
|
|
2166
|
+
* @returns Promise resolving to an array of FMP articles with content and metadata
|
|
2167
|
+
*
|
|
2168
|
+
* @example
|
|
2169
|
+
* ```typescript
|
|
2170
|
+
* // Get latest FMP articles
|
|
2171
|
+
* const articles = await fmp.news.getArticles({
|
|
2172
|
+
* page: 1,
|
|
2173
|
+
* limit: 10
|
|
2174
|
+
* });
|
|
2175
|
+
*
|
|
2176
|
+
* // Get first page with default limit
|
|
2177
|
+
* const latestArticles = await fmp.news.getArticles({ page: 1 });
|
|
2178
|
+
* ```
|
|
2179
|
+
*
|
|
2180
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#fmp-articles|FMP Articles Documentation}
|
|
2181
|
+
*/
|
|
2182
|
+
getArticles(params?: {
|
|
2183
|
+
page?: number;
|
|
2184
|
+
limit?: number;
|
|
2185
|
+
}): Promise<APIResponse<Article[]>>;
|
|
2186
|
+
/**
|
|
2187
|
+
* Get latest stock market news from various financial sources
|
|
2188
|
+
*
|
|
2189
|
+
* Retrieves the most recent stock market news articles from multiple financial
|
|
2190
|
+
* news sources. Perfect for staying updated on market movements, earnings
|
|
2191
|
+
* announcements, and corporate developments.
|
|
2192
|
+
*
|
|
2193
|
+
* @param params - Stock news request parameters
|
|
2194
|
+
* @param params.from - Start date in YYYY-MM-DD format (optional)
|
|
2195
|
+
* @param params.to - End date in YYYY-MM-DD format (optional)
|
|
2196
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2197
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2198
|
+
*
|
|
2199
|
+
* @returns Promise resolving to an array of stock news articles with timestamps and sources
|
|
2200
|
+
*
|
|
2201
|
+
* @example
|
|
2202
|
+
* ```typescript
|
|
2203
|
+
* // Get latest stock news
|
|
2204
|
+
* const stockNews = await fmp.news.getStockNews({
|
|
2205
|
+
* limit: 20
|
|
2206
|
+
* });
|
|
2207
|
+
*
|
|
2208
|
+
* // Get stock news from specific date range
|
|
2209
|
+
* const recentNews = await fmp.news.getStockNews({
|
|
2210
|
+
* from: '2024-01-01',
|
|
2211
|
+
* to: '2024-01-15',
|
|
2212
|
+
* limit: 50
|
|
2213
|
+
* });
|
|
2214
|
+
* ```
|
|
2215
|
+
*
|
|
2216
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#stock-news|Stock News Documentation}
|
|
2217
|
+
*/
|
|
2218
|
+
getStockNews(params?: {
|
|
2219
|
+
from?: string;
|
|
2220
|
+
to?: string;
|
|
2221
|
+
page?: number;
|
|
2222
|
+
limit?: number;
|
|
2223
|
+
}): Promise<APIResponse<News[]>>;
|
|
2224
|
+
/**
|
|
2225
|
+
* Get latest cryptocurrency news from various sources
|
|
2226
|
+
*
|
|
2227
|
+
* Retrieves the most recent cryptocurrency news articles covering market trends,
|
|
2228
|
+
* regulatory updates, technology developments, and major crypto events.
|
|
2229
|
+
* Essential for crypto traders and investors.
|
|
2230
|
+
*
|
|
2231
|
+
* @param params - Crypto news request parameters
|
|
2232
|
+
* @param params.from - Start date in YYYY-MM-DD format (optional)
|
|
2233
|
+
* @param params.to - End date in YYYY-MM-DD format (optional)
|
|
2234
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2235
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2236
|
+
*
|
|
2237
|
+
* @returns Promise resolving to an array of cryptocurrency news articles
|
|
2238
|
+
*
|
|
2239
|
+
* @example
|
|
2240
|
+
* ```typescript
|
|
2241
|
+
* // Get latest crypto news
|
|
2242
|
+
* const cryptoNews = await fmp.news.getCryptoNews({
|
|
2243
|
+
* limit: 15
|
|
2244
|
+
* });
|
|
2245
|
+
*
|
|
2246
|
+
* // Get crypto news from last week
|
|
2247
|
+
* const weeklyCryptoNews = await fmp.news.getCryptoNews({
|
|
2248
|
+
* from: '2024-01-08',
|
|
2249
|
+
* to: '2024-01-15'
|
|
2250
|
+
* });
|
|
2251
|
+
* ```
|
|
2252
|
+
*
|
|
2253
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#crypto-news|Crypto News Documentation}
|
|
2254
|
+
*/
|
|
2255
|
+
getCryptoNews(params?: {
|
|
2256
|
+
from?: string;
|
|
2257
|
+
to?: string;
|
|
2258
|
+
page?: number;
|
|
2259
|
+
limit?: number;
|
|
2260
|
+
}): Promise<APIResponse<News[]>>;
|
|
2261
|
+
/**
|
|
2262
|
+
* Get latest forex (foreign exchange) market news
|
|
2263
|
+
*
|
|
2264
|
+
* Retrieves the most recent forex market news covering currency movements,
|
|
2265
|
+
* central bank announcements, economic indicators, and geopolitical events
|
|
2266
|
+
* that impact currency markets.
|
|
2267
|
+
*
|
|
2268
|
+
* @param params - Forex news request parameters
|
|
2269
|
+
* @param params.from - Start date in YYYY-MM-DD format (optional)
|
|
2270
|
+
* @param params.to - End date in YYYY-MM-DD format (optional)
|
|
2271
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2272
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2273
|
+
*
|
|
2274
|
+
* @returns Promise resolving to an array of forex news articles
|
|
2275
|
+
*
|
|
2276
|
+
* @example
|
|
2277
|
+
* ```typescript
|
|
2278
|
+
* // Get latest forex news
|
|
2279
|
+
* const forexNews = await fmp.news.getForexNews({
|
|
2280
|
+
* limit: 25
|
|
2281
|
+
* });
|
|
2282
|
+
*
|
|
2283
|
+
* // Get forex news from specific period
|
|
2284
|
+
* const forexUpdates = await fmp.news.getForexNews({
|
|
2285
|
+
* from: '2024-01-10',
|
|
2286
|
+
* limit: 30
|
|
2287
|
+
* });
|
|
2288
|
+
* ```
|
|
2289
|
+
*
|
|
2290
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#forex-news|Forex News Documentation}
|
|
2291
|
+
*/
|
|
2292
|
+
getForexNews(params?: {
|
|
2293
|
+
from?: string;
|
|
2294
|
+
to?: string;
|
|
2295
|
+
page?: number;
|
|
2296
|
+
limit?: number;
|
|
2297
|
+
}): Promise<APIResponse<News[]>>;
|
|
2298
|
+
/**
|
|
2299
|
+
* Get stock news filtered by specific company symbols
|
|
2300
|
+
*
|
|
2301
|
+
* Retrieves news articles specifically related to the provided stock symbols.
|
|
2302
|
+
* Perfect for monitoring news about specific companies in your portfolio or
|
|
2303
|
+
* watchlist. Supports multiple symbols for efficient batch news retrieval.
|
|
2304
|
+
*
|
|
2305
|
+
* @param params - Symbol-specific stock news request parameters
|
|
2306
|
+
* @param params.symbols - Array of stock symbols to get news for (required)
|
|
2307
|
+
* @param params.from - Start date in YYYY-MM-DD format (optional)
|
|
2308
|
+
* @param params.to - End date in YYYY-MM-DD format (optional)
|
|
2309
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2310
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2311
|
+
*
|
|
2312
|
+
* @returns Promise resolving to an array of news articles filtered by the specified symbols
|
|
2313
|
+
*
|
|
2314
|
+
* @example
|
|
2315
|
+
* ```typescript
|
|
2316
|
+
* // Get news for specific stocks
|
|
2317
|
+
* const appleNews = await fmp.news.getStockNewsBySymbol({
|
|
2318
|
+
* symbols: ['AAPL'],
|
|
2319
|
+
* limit: 10
|
|
2320
|
+
* });
|
|
2321
|
+
*
|
|
2322
|
+
* // Get news for multiple tech stocks
|
|
2323
|
+
* const techNews = await fmp.news.getStockNewsBySymbol({
|
|
2324
|
+
* symbols: ['AAPL', 'MSFT', 'GOOGL', 'AMZN'],
|
|
2325
|
+
* from: '2024-01-01',
|
|
2326
|
+
* limit: 20
|
|
2327
|
+
* });
|
|
2328
|
+
* ```
|
|
2329
|
+
*
|
|
2330
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#search-stock-news|Search Stock News Documentation}
|
|
2331
|
+
*/
|
|
2332
|
+
getStockNewsBySymbol(params: {
|
|
2333
|
+
symbols: string[];
|
|
2334
|
+
from?: string;
|
|
2335
|
+
to?: string;
|
|
2336
|
+
page?: number;
|
|
2337
|
+
limit?: number;
|
|
2338
|
+
}): Promise<APIResponse<News[]>>;
|
|
2339
|
+
/**
|
|
2340
|
+
* Get cryptocurrency news filtered by specific crypto symbols
|
|
2341
|
+
*
|
|
2342
|
+
* Retrieves news articles specifically related to the provided cryptocurrency
|
|
2343
|
+
* symbols. Ideal for monitoring news about specific cryptocurrencies in your
|
|
2344
|
+
* portfolio or tracking particular digital assets.
|
|
2345
|
+
*
|
|
2346
|
+
* @param params - Symbol-specific crypto news request parameters
|
|
2347
|
+
* @param params.symbols - Array of cryptocurrency symbols to get news for (required)
|
|
2348
|
+
* @param params.from - Start date in YYYY-MM-DD format (optional)
|
|
2349
|
+
* @param params.to - End date in YYYY-MM-DD format (optional)
|
|
2350
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2351
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2352
|
+
*
|
|
2353
|
+
* @returns Promise resolving to an array of news articles filtered by the specified crypto symbols
|
|
2354
|
+
*
|
|
2355
|
+
* @example
|
|
2356
|
+
* ```typescript
|
|
2357
|
+
* // Get news for Bitcoin
|
|
2358
|
+
* const bitcoinNews = await fmp.news.getCryptoNewsBySymbol({
|
|
2359
|
+
* symbols: ['BTCUSD'],
|
|
2360
|
+
* limit: 15
|
|
2361
|
+
* });
|
|
2362
|
+
*
|
|
2363
|
+
* // Get news for multiple cryptocurrencies
|
|
2364
|
+
* const cryptoNews = await fmp.news.getCryptoNewsBySymbol({
|
|
2365
|
+
* symbols: ['BTCUSD', 'ETHUSD', 'ADAUSD'],
|
|
2366
|
+
* from: '2024-01-01',
|
|
2367
|
+
* limit: 25
|
|
2368
|
+
* });
|
|
2369
|
+
* ```
|
|
2370
|
+
*
|
|
2371
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#search-crypto-news|Search Crypto News Documentation}
|
|
2372
|
+
*/
|
|
2373
|
+
getCryptoNewsBySymbol(params: {
|
|
2374
|
+
symbols: string[];
|
|
2375
|
+
from?: string;
|
|
2376
|
+
to?: string;
|
|
2377
|
+
page?: number;
|
|
2378
|
+
limit?: number;
|
|
2379
|
+
}): Promise<APIResponse<News[]>>;
|
|
2380
|
+
/**
|
|
2381
|
+
* Get forex news filtered by specific currency pair symbols
|
|
2382
|
+
*
|
|
2383
|
+
* Retrieves news articles specifically related to the provided forex currency
|
|
2384
|
+
* pairs. Perfect for monitoring news about specific currency pairs you're
|
|
2385
|
+
* trading or analyzing for forex market movements.
|
|
2386
|
+
*
|
|
2387
|
+
* @param params - Symbol-specific forex news request parameters
|
|
2388
|
+
* @param params.symbols - Array of forex currency pair symbols to get news for (required)
|
|
2389
|
+
* @param params.from - Start date in YYYY-MM-DD format (optional)
|
|
2390
|
+
* @param params.to - End date in YYYY-MM-DD format (optional)
|
|
2391
|
+
* @param params.page - Page number for pagination (optional, defaults to 1)
|
|
2392
|
+
* @param params.limit - Number of articles per page (optional, defaults to 100)
|
|
2393
|
+
*
|
|
2394
|
+
* @returns Promise resolving to an array of news articles filtered by the specified forex symbols
|
|
2395
|
+
*
|
|
2396
|
+
* @example
|
|
2397
|
+
* ```typescript
|
|
2398
|
+
* // Get news for EUR/USD pair
|
|
2399
|
+
* const eurUsdNews = await fmp.news.getForexNewsBySymbol({
|
|
2400
|
+
* symbols: ['EURUSD'],
|
|
2401
|
+
* limit: 10
|
|
2402
|
+
* });
|
|
2403
|
+
*
|
|
2404
|
+
* // Get news for multiple currency pairs
|
|
2405
|
+
* const forexNews = await fmp.news.getForexNewsBySymbol({
|
|
2406
|
+
* symbols: ['EURUSD', 'GBPUSD', 'USDJPY'],
|
|
2407
|
+
* from: '2024-01-01',
|
|
2408
|
+
* limit: 20
|
|
2409
|
+
* });
|
|
2410
|
+
* ```
|
|
2411
|
+
*
|
|
2412
|
+
* @see {@link https://site.financialmodelingprep.com/developer/docs#search-forex-news|Search Forex News Documentation}
|
|
2413
|
+
*/
|
|
2414
|
+
getForexNewsBySymbol(params: {
|
|
2415
|
+
symbols: string[];
|
|
2416
|
+
from?: string;
|
|
2417
|
+
to?: string;
|
|
2418
|
+
page?: number;
|
|
2419
|
+
limit?: number;
|
|
2420
|
+
}): Promise<APIResponse<News[]>>;
|
|
2421
|
+
}
|
|
2422
|
+
|
|
2136
2423
|
declare class QuoteEndpoints {
|
|
2137
2424
|
private client;
|
|
2138
2425
|
constructor(client: FMPClient);
|
|
@@ -3080,6 +3367,7 @@ declare class FMP {
|
|
|
3080
3367
|
readonly list: ListEndpoints;
|
|
3081
3368
|
readonly market: MarketEndpoints;
|
|
3082
3369
|
readonly mutualFund: MutualFundEndpoints;
|
|
3370
|
+
readonly news: NewsEndpoints;
|
|
3083
3371
|
readonly quote: QuoteEndpoints;
|
|
3084
3372
|
readonly screener: ScreenerEndpoints;
|
|
3085
3373
|
readonly sec: SECEndpoints;
|
|
@@ -3144,4 +3432,4 @@ declare const SECTORS: {
|
|
|
3144
3432
|
readonly COMMUNICATION_SERVICES: "Communication Services";
|
|
3145
3433
|
};
|
|
3146
3434
|
|
|
3147
|
-
export { APIResponse, AvailableCountries, AvailableExchanges, AvailableIndexesList, AvailableIndustries, AvailableSectors, BalanceSheet, BalanceSheetGrowth, BeneficialOwnershipResponse, CalendarEndpoints, CashFlowStatement, CashflowGrowth, CikMapperBySymbolResponse, CikMapperResponse, CompanyEndpoints, CompanyNotes, CompanyProfile, CompanyTranscriptData, CryptoList, DEFAULT_LIMIT, DEFAULT_TIMEOUT, DividendsCalendar, ETFCountryWeighting, ETFEndpoints, ETFHolder, ETFHolding, ETFHoldingDates, ETFList, ETFProfile, ETFStockExposure, ETFWeighting, EXCHANGES, EarningsCalendar, EarningsCallTranscript, EarningsConfirmed, EarningsHistorical, EarningsSurprises, EconomicEndpoints, EconomicIndicator, EconomicsCalendar, EnterpriseValue, ExecutiveCompensation, FMP, FMPClient, FMPConfig, FailToDeliverResponse, FinancialEndpoints, FinancialGrowth, FinancialRatios, ForexList, Form13FResponse, HistoricalEmployeeCount, HistoricalPriceData, HistoricalPriceResponse, HistoricalSharesFloat, HouseTradingResponse, IPOCalendar, IncomeGrowth, IncomeStatement, IndustryClassification, IndustryClassificationCode, InsiderEndpoints, InsiderTradeStatisticsResponse, InsiderTradingRSSResponse, InsiderTradingSearchResponse, InsidersBySymbolResponse, InstitutionalEndpoints, InstitutionalHolderResponse, KeyMetrics, ListEndpoints, MAX_LIMIT, MarketCap, MarketEndpoints, MarketHours, MarketIndex, MarketPerformance, MarketSectorPerformance, MutualFundEndpoints, MutualFundHolding, PERIODS, Quote, QuoteEndpoints, RSSFeed8KItem, RSSFeedAllItem, RSSFeedItem, RSSFeedV3Item, SECEndpoints, SECFiling, SECTORS, Screener, ScreenerParams, SenateHouseEndpoints, SenateHouseTradingByNameResponse, SenateTradingResponse, SharesFloat, SplitsCalendar, StockDividendResponse, StockEndpoints, StockList, StockRealTimePrice, StockRealTimePriceFull, StockSplitResponse, TransactionType, TransactionTypesResponse, TreasuryRate, formatCurrency, formatDate, formatLargeNumber, formatPercentage, formatVolume };
|
|
3435
|
+
export { APIResponse, Article, AvailableCountries, AvailableExchanges, AvailableIndexesList, AvailableIndustries, AvailableSectors, BalanceSheet, BalanceSheetGrowth, BeneficialOwnershipResponse, CalendarEndpoints, CashFlowStatement, CashflowGrowth, CikMapperBySymbolResponse, CikMapperResponse, CompanyEndpoints, CompanyNotes, CompanyProfile, CompanyTranscriptData, CryptoList, DEFAULT_LIMIT, DEFAULT_TIMEOUT, DividendsCalendar, ETFCountryWeighting, ETFEndpoints, ETFHolder, ETFHolding, ETFHoldingDates, ETFList, ETFProfile, ETFStockExposure, ETFWeighting, EXCHANGES, EarningsCalendar, EarningsCallTranscript, EarningsConfirmed, EarningsHistorical, EarningsSurprises, EconomicEndpoints, EconomicIndicator, EconomicsCalendar, EnterpriseValue, ExecutiveCompensation, FMP, FMPClient, FMPConfig, FailToDeliverResponse, FinancialEndpoints, FinancialGrowth, FinancialRatios, ForexList, Form13FResponse, HistoricalEmployeeCount, HistoricalPriceData, HistoricalPriceResponse, HistoricalSharesFloat, HouseTradingResponse, IPOCalendar, IncomeGrowth, IncomeStatement, IndustryClassification, IndustryClassificationCode, InsiderEndpoints, InsiderTradeStatisticsResponse, InsiderTradingRSSResponse, InsiderTradingSearchResponse, InsidersBySymbolResponse, InstitutionalEndpoints, InstitutionalHolderResponse, KeyMetrics, ListEndpoints, MAX_LIMIT, MarketCap, MarketEndpoints, MarketHours, MarketIndex, MarketPerformance, MarketSectorPerformance, MutualFundEndpoints, MutualFundHolding, News, NewsEndpoints, PERIODS, Quote, QuoteEndpoints, RSSFeed8KItem, RSSFeedAllItem, RSSFeedItem, RSSFeedV3Item, SECEndpoints, SECFiling, SECTORS, Screener, ScreenerEndpoints, ScreenerParams, SenateHouseEndpoints, SenateHouseTradingByNameResponse, SenateTradingResponse, SharesFloat, SplitsCalendar, StockDividendResponse, StockEndpoints, StockList, StockRealTimePrice, StockRealTimePriceFull, StockSplitResponse, TransactionType, TransactionTypesResponse, TreasuryRate, formatCurrency, formatDate, formatLargeNumber, formatPercentage, formatVolume };
|