fmp-node-api 0.0.6 → 0.0.8

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 CHANGED
@@ -1,17 +1,7 @@
1
1
  interface APIResponse<T = unknown> {
2
2
  success: boolean;
3
- data?: T;
4
- error?: string;
5
- status?: number;
6
- }
7
- interface SuccessResponse<T> extends APIResponse<T> {
8
- success: true;
9
- data: T;
10
- status: number;
11
- }
12
- interface ErrorResponse extends APIResponse<never> {
13
- success: false;
14
- error: string;
3
+ data: T | null;
4
+ error: string | null;
15
5
  status: number;
16
6
  }
17
7
  interface FMPConfig {
@@ -161,6 +151,29 @@ interface MarketCap {
161
151
  date: string;
162
152
  marketCap: number;
163
153
  }
154
+ interface StockRealTimePrice {
155
+ symbol: string;
156
+ price: number;
157
+ }
158
+ interface StockRealTimePriceFull {
159
+ bidSize: number;
160
+ askPrice: number;
161
+ volume: number;
162
+ askSize: number;
163
+ bidPrice: number;
164
+ lastSalePrice: number;
165
+ lastSaleSize: number;
166
+ lastSaleTime: number;
167
+ fmpLast: number;
168
+ lastUpdated: number;
169
+ symbol: string;
170
+ }
171
+ interface StockListResponse<T> {
172
+ stockList: T[];
173
+ }
174
+ interface CompaniesPriceListResponse<T> {
175
+ companiesPriceList: T[];
176
+ }
164
177
 
165
178
  interface FinancialStatementsParams extends SymbolParams, PeriodParams {
166
179
  limit?: number;
@@ -830,7 +843,7 @@ interface MarketIndex {
830
843
  interface EarningsCalendar {
831
844
  date: string;
832
845
  symbol: string;
833
- eps: number;
846
+ eps: number | null;
834
847
  epsEstimated: number | null;
835
848
  time: string;
836
849
  revenue: number | null;
@@ -838,6 +851,16 @@ interface EarningsCalendar {
838
851
  fiscalDateEnding: string;
839
852
  updatedFromDate: string;
840
853
  }
854
+ interface EarningsConfirmed {
855
+ symbol: string;
856
+ exchange: string;
857
+ time: string;
858
+ when: string;
859
+ date: string;
860
+ publicationDate: string;
861
+ title: string;
862
+ url: string;
863
+ }
841
864
  interface DividendsCalendar {
842
865
  date: string;
843
866
  label: string;
@@ -1011,6 +1034,7 @@ interface EarningsCallTranscript {
1011
1034
  date: string;
1012
1035
  content: string;
1013
1036
  }
1037
+ type CompanyTranscriptData = [number, number, string];
1014
1038
 
1015
1039
  interface SenateHouseTradingParams {
1016
1040
  symbol: string;
@@ -1018,6 +1042,9 @@ interface SenateHouseTradingParams {
1018
1042
  interface SenateHouseTradingRSSFeedParams {
1019
1043
  page: number;
1020
1044
  }
1045
+ interface SenateHouseTradingByNameParams {
1046
+ name: string;
1047
+ }
1021
1048
  interface SenateTradingResponse {
1022
1049
  firstName: string;
1023
1050
  lastName: string;
@@ -1047,6 +1074,279 @@ interface HouseTradingResponse {
1047
1074
  link: string;
1048
1075
  capitalGainsOver200USD: string;
1049
1076
  }
1077
+ interface SenateHouseTradingByNameResponse {
1078
+ symbol: string;
1079
+ disclosureDate: string;
1080
+ transactionDate: string;
1081
+ firstName: string;
1082
+ lastName: string;
1083
+ office: string;
1084
+ district: string;
1085
+ owner: string;
1086
+ assetDescription: string;
1087
+ assetType: string;
1088
+ type: string;
1089
+ amount: string;
1090
+ capitalGainsOver200USD: string;
1091
+ comment: string;
1092
+ link: string;
1093
+ }
1094
+
1095
+ interface Form13FParams {
1096
+ cik: string;
1097
+ date: string;
1098
+ }
1099
+ interface Form13FDatesParams {
1100
+ cik: string;
1101
+ }
1102
+ interface InstitutionalHolderParams {
1103
+ symbol: string;
1104
+ }
1105
+ interface Form13FResponse {
1106
+ date: string;
1107
+ fillingDate: string;
1108
+ acceptedDate: string;
1109
+ cik: string;
1110
+ cusip: string;
1111
+ tickerCusip: string;
1112
+ nameOfIssuer: string;
1113
+ shares: number;
1114
+ titleOfClass: string;
1115
+ value: number;
1116
+ link: string;
1117
+ finalLink: string;
1118
+ }
1119
+ interface InstitutionalHolderResponse {
1120
+ holder: string;
1121
+ shares: number;
1122
+ dateReported: string;
1123
+ change: number;
1124
+ }
1125
+
1126
+ interface InsiderTradingRSSResponse {
1127
+ title: string;
1128
+ fillingDate: string;
1129
+ symbol: string;
1130
+ link: string;
1131
+ reportingCik: string;
1132
+ issuerCik: string;
1133
+ }
1134
+ interface InsiderTradingSearchResponse {
1135
+ symbol: string;
1136
+ filingDate: string;
1137
+ transactionDate: string;
1138
+ reportingCik: string;
1139
+ transactionType: string;
1140
+ securitiesOwned: number;
1141
+ securitiesTransacted: number;
1142
+ companyCik: string;
1143
+ reportingName: string;
1144
+ typeOfOwner: string;
1145
+ link: string;
1146
+ securityName: string;
1147
+ price: number;
1148
+ formType: string;
1149
+ acquistionOrDisposition: string;
1150
+ }
1151
+ type TransactionTypesResponse = string[];
1152
+ interface InsidersBySymbolResponse {
1153
+ typeOfOwner: string;
1154
+ transactionDate: string;
1155
+ owner: string;
1156
+ }
1157
+ interface InsiderTradeStatisticsResponse {
1158
+ symbol: string;
1159
+ cik: string;
1160
+ year: number;
1161
+ quarter: number;
1162
+ purchases: number;
1163
+ sales: number;
1164
+ buySellRatio: number;
1165
+ totalBought: number;
1166
+ totalSold: number;
1167
+ averageBought: number;
1168
+ averageSold: number;
1169
+ pPurchases: number;
1170
+ sSales: number;
1171
+ }
1172
+ interface CikMapperResponse {
1173
+ reportingCik: string;
1174
+ reportingName: string;
1175
+ }
1176
+ interface CikMapperBySymbolResponse {
1177
+ symbol: string;
1178
+ companyCik: string;
1179
+ }
1180
+ interface BeneficialOwnershipResponse {
1181
+ cik: string;
1182
+ symbol: string;
1183
+ filingDate: string;
1184
+ acceptedDate: string;
1185
+ cusip: string;
1186
+ nameOfReportingPerson: string;
1187
+ citizenshipOrPlaceOfOrganization: string;
1188
+ soleVotingPower: string;
1189
+ sharedVotingPower: string;
1190
+ soleDispositivePower: string;
1191
+ sharedDispositivePower: string;
1192
+ amountBeneficiallyOwned: string;
1193
+ percentOfClass: string;
1194
+ typeOfReportingPerson: string;
1195
+ url: string;
1196
+ }
1197
+ interface FailToDeliverResponse {
1198
+ symbol: string;
1199
+ date: string;
1200
+ price: number;
1201
+ quantity: number;
1202
+ cusip: string;
1203
+ name: string;
1204
+ }
1205
+ interface InsiderTradingRSSParams {
1206
+ page: number;
1207
+ }
1208
+ interface InsiderTradingSearchParams {
1209
+ symbol?: string;
1210
+ reportingCik?: string;
1211
+ companyCik?: string;
1212
+ transactionType?: string;
1213
+ page: number;
1214
+ }
1215
+ interface InsidersBySymbolParams {
1216
+ symbol: string;
1217
+ }
1218
+ interface InsiderTradeStatisticsParams {
1219
+ symbol: string;
1220
+ }
1221
+ interface CikMapperParams {
1222
+ page: number;
1223
+ }
1224
+ interface CikMapperByNameParams {
1225
+ name: string;
1226
+ page?: number;
1227
+ }
1228
+ interface CikMapperBySymbolParams {
1229
+ symbol: string;
1230
+ }
1231
+ interface BeneficialOwnershipParams {
1232
+ symbol: string;
1233
+ }
1234
+ interface FailToDeliverParams {
1235
+ symbol: string;
1236
+ page?: number;
1237
+ }
1238
+ declare enum TransactionType {
1239
+ AWARD = "A-Award",
1240
+ CONVERSION = "C-Conversion",
1241
+ RETURN = "D-Return",
1242
+ EXPIRE_SHORT = "E-ExpireShort",
1243
+ IN_KIND = "F-InKind",
1244
+ GIFT = "G-Gift",
1245
+ EXPIRE_LONG = "H-ExpireLong",
1246
+ DISCRETIONARY = "I-Discretionary",
1247
+ OTHER = "J-Other",
1248
+ SMALL = "L-Small",
1249
+ EXEMPT = "M-Exempt",
1250
+ OUT_OF_THE_MONEY = "O-OutOfTheMoney",
1251
+ PURCHASE = "P-Purchase",
1252
+ SALE = "S-Sale",
1253
+ TENDER = "U-Tender",
1254
+ WILL = "W-Will",
1255
+ IN_THE_MONEY = "X-InTheMoney",
1256
+ TRUST = "Z-Trust"
1257
+ }
1258
+
1259
+ interface RSSFeedItem {
1260
+ title: string;
1261
+ date: string;
1262
+ link: string;
1263
+ cik: string;
1264
+ form_type: string;
1265
+ ticker: string;
1266
+ done: boolean;
1267
+ }
1268
+ interface RSSFeedV3Item {
1269
+ title: string;
1270
+ date: string;
1271
+ link: string;
1272
+ cik: string;
1273
+ form_type: string;
1274
+ ticker: string;
1275
+ done: boolean;
1276
+ }
1277
+ interface RSSFeed8KItem {
1278
+ title: string;
1279
+ symbol: string;
1280
+ cik: string;
1281
+ link: string;
1282
+ finalLink: string;
1283
+ date: string;
1284
+ process: string;
1285
+ hasFinancials: string;
1286
+ }
1287
+ interface SECFiling {
1288
+ symbol: string;
1289
+ cik: string;
1290
+ type: string;
1291
+ link: string;
1292
+ finalLink: string;
1293
+ acceptedDate: string;
1294
+ fillingDate: string;
1295
+ }
1296
+ interface IndustryClassification {
1297
+ symbol: string;
1298
+ name: string;
1299
+ cik: string;
1300
+ sicCode: string;
1301
+ industryTitle: string;
1302
+ businessAdress: string;
1303
+ phoneNumber: string;
1304
+ }
1305
+ interface IndustryClassificationCode {
1306
+ office: string;
1307
+ sicCode: string;
1308
+ industryTitle: string;
1309
+ }
1310
+ interface RSSFeedParams {
1311
+ limit?: number;
1312
+ type?: string;
1313
+ from?: string;
1314
+ to?: string;
1315
+ isDone?: boolean;
1316
+ }
1317
+ interface RSSFeedV3Params {
1318
+ page?: number;
1319
+ datatype?: string;
1320
+ }
1321
+ interface RSSFeedAllItem {
1322
+ symbol: string;
1323
+ fillingDate: string;
1324
+ acceptedDate: string;
1325
+ cik: string;
1326
+ type: string;
1327
+ link: string;
1328
+ finalLink: string;
1329
+ }
1330
+ interface RSSFeed8KParams {
1331
+ page?: number;
1332
+ from?: string;
1333
+ to?: string;
1334
+ hasFinancial?: boolean;
1335
+ limit?: number;
1336
+ }
1337
+ interface SECFilingsParams {
1338
+ page?: number;
1339
+ type?: string;
1340
+ }
1341
+ interface IndividualIndustryClassificationParams {
1342
+ symbol?: string;
1343
+ cik?: number;
1344
+ sicCode?: number;
1345
+ }
1346
+ interface IndustryClassificationCodesParams {
1347
+ industryTitle?: string;
1348
+ sicCode?: number;
1349
+ }
1050
1350
 
1051
1351
  declare class FMPClient {
1052
1352
  private v3Client;
@@ -1055,7 +1355,18 @@ declare class FMPClient {
1055
1355
  private apiKey;
1056
1356
  constructor(config: FMPConfig);
1057
1357
  private createClient;
1358
+ /**
1359
+ * Standard get method - returns raw API response
1360
+ *
1361
+ * For endpoints that return arrays, this will always return an array (possibly empty) for `data` when success is true.
1362
+ * For endpoints that return objects, data is returned as-is.
1363
+ */
1058
1364
  get<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<APIResponse<T>>;
1365
+ /**
1366
+ * Get method for single-object endpoints - unwraps single-item arrays
1367
+ *
1368
+ * For endpoints that return single objects, this will always return an object (possibly empty) for `data` when success is true.
1369
+ */
1059
1370
  getSingle<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<APIResponse<T>>;
1060
1371
  private getClientForVersion;
1061
1372
  }
@@ -1071,7 +1382,7 @@ declare class StockEndpoints {
1071
1382
  */
1072
1383
  getQuote({ symbol }: {
1073
1384
  symbol: string;
1074
- }): Promise<APIResponse<StockQuote | null>>;
1385
+ }): Promise<APIResponse<StockQuote>>;
1075
1386
  /**
1076
1387
  * Get historical stock prices
1077
1388
  * @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
@@ -1093,7 +1404,7 @@ declare class StockEndpoints {
1093
1404
  */
1094
1405
  getMarketCap({ symbol }: {
1095
1406
  symbol: string;
1096
- }): Promise<APIResponse<MarketCap | null>>;
1407
+ }): Promise<APIResponse<MarketCap>>;
1097
1408
  /**
1098
1409
  * Get stock splits
1099
1410
  * https://site.financialmodelingprep.com/developer/docs#splits-historical-splits
@@ -1112,6 +1423,23 @@ declare class StockEndpoints {
1112
1423
  getDividendHistory({ symbol, }: {
1113
1424
  symbol: string;
1114
1425
  }): Promise<APIResponse<StockDividendResponse>>;
1426
+ /**
1427
+ * Get stock real time price
1428
+ * @param symbol - The stock symbol to get the real time price for
1429
+ * @returns The real time price for the stock
1430
+ */
1431
+ getRealTimePrice({ symbols, }: {
1432
+ symbols: string[];
1433
+ }): Promise<APIResponse<StockRealTimePrice[]>>;
1434
+ /**
1435
+ * Get stock real time price full
1436
+ * https://site.financialmodelingprep.com/developer/docs#real-time-full-price-quote
1437
+ * @param symbols - The stock symbols to get the real time price for
1438
+ * @returns The real time price for the stocks
1439
+ */
1440
+ getRealTimePriceForMultipleStocks({ symbols, }: {
1441
+ symbols: string[];
1442
+ }): Promise<APIResponse<StockRealTimePriceFull[]>>;
1115
1443
  }
1116
1444
 
1117
1445
  declare class FinancialEndpoints {
@@ -1311,7 +1639,7 @@ declare class ETFEndpoints {
1311
1639
  * @param symbol - The symbol of the ETF to get the profile for
1312
1640
  * @returns The FMP ETF Information endpoint provides basic information about an ETF, such as its ticker symbol, name, expense ratio, and asset under management. For example, an investor may want to compare the expense ratios of different ETFs to find the one that is most cost-effective.
1313
1641
  */
1314
- getProfile({ symbol }: SymbolParams): Promise<APIResponse<ETFProfile | null>>;
1642
+ getProfile({ symbol }: SymbolParams): Promise<APIResponse<ETFProfile>>;
1315
1643
  /**
1316
1644
  * Get ETF sector weighting
1317
1645
  * https://site.financialmodelingprep.com/developer/docs#etf-sector-weighting-etf-holdings
@@ -1463,6 +1791,14 @@ declare class CalendarEndpoints {
1463
1791
  * @returns The earnings calendar
1464
1792
  */
1465
1793
  getEarningsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<EarningsCalendar[]>>;
1794
+ /**
1795
+ * Get earnings confirmed
1796
+ * https://site.financialmodelingprep.com/developer/docs#earnings-confirmed-earnings
1797
+ * @param from - The start date to get the earnings confirmed for
1798
+ * @param to - The end date to get the earnings confirmed for
1799
+ * @returns The earnings confirmed
1800
+ */
1801
+ getEarningsConfirmed({ from, to }?: DateRangeParams): Promise<APIResponse<EarningsConfirmed[]>>;
1466
1802
  /**
1467
1803
  * Get dividends calendar
1468
1804
  * https://site.financialmodelingprep.com/developer/docs#dividends-calendar-dividends
@@ -1506,9 +1842,9 @@ declare class CompanyEndpoints {
1506
1842
  * @param symbol - The stock symbol to get the profile for
1507
1843
  * @returns Get a comprehensive overview of a company with our Company Profile endpoint. This endpoint provides key information such as price, beta, market capitalization, description, headquarters, and more.
1508
1844
  */
1509
- getCompanyProfile({ symbol, }: {
1845
+ getCompanyProfile({ symbol }: {
1510
1846
  symbol: string;
1511
- }): Promise<APIResponse<CompanyProfile | null>>;
1847
+ }): Promise<APIResponse<CompanyProfile>>;
1512
1848
  /**
1513
1849
  * Get executive compensation
1514
1850
  * https://site.financialmodelingprep.com/developer/docs#executive-compensation-company-information
@@ -1517,16 +1853,16 @@ declare class CompanyEndpoints {
1517
1853
  */
1518
1854
  getExecutiveCompensation({ symbol, }: {
1519
1855
  symbol: string;
1520
- }): Promise<APIResponse<ExecutiveCompensation[] | null>>;
1856
+ }): Promise<APIResponse<ExecutiveCompensation[]>>;
1521
1857
  /**
1522
1858
  * Get company notes
1523
1859
  * https://site.financialmodelingprep.com/developer/docs#company-notes-company-information
1524
1860
  * @param symbol - The stock symbol to get the notes for
1525
1861
  * @returns Stay up-to-date on a company's financial condition, operations, and risks with our Company Notes endpoint. This endpoint provides information about notes reported by a company in their financial statements.
1526
1862
  */
1527
- getCompanyNotes({ symbol, }: {
1863
+ getCompanyNotes({ symbol }: {
1528
1864
  symbol: string;
1529
- }): Promise<APIResponse<CompanyNotes[] | null>>;
1865
+ }): Promise<APIResponse<CompanyNotes[]>>;
1530
1866
  /**
1531
1867
  * Get historical employee count
1532
1868
  * https://site.financialmodelingprep.com/developer/docs#historical-employee-company-information
@@ -1535,7 +1871,7 @@ declare class CompanyEndpoints {
1535
1871
  */
1536
1872
  getHistoricalEmployeeCount({ symbol, }: {
1537
1873
  symbol: string;
1538
- }): Promise<APIResponse<HistoricalEmployeeCount[] | null>>;
1874
+ }): Promise<APIResponse<HistoricalEmployeeCount[]>>;
1539
1875
  /**
1540
1876
  * Get shares float
1541
1877
  * https://site.financialmodelingprep.com/developer/docs#company-share-float-share-float
@@ -1544,7 +1880,7 @@ declare class CompanyEndpoints {
1544
1880
  */
1545
1881
  getSharesFloat({ symbol }: {
1546
1882
  symbol: string;
1547
- }): Promise<APIResponse<SharesFloat | null>>;
1883
+ }): Promise<APIResponse<SharesFloat>>;
1548
1884
  /**
1549
1885
  * Get historical shares float
1550
1886
  * https://site.financialmodelingprep.com/developer/docs#company-historical-share-float
@@ -1553,7 +1889,7 @@ declare class CompanyEndpoints {
1553
1889
  */
1554
1890
  getHistoricalSharesFloat({ symbol, }: {
1555
1891
  symbol: string;
1556
- }): Promise<APIResponse<HistoricalSharesFloat[] | null>>;
1892
+ }): Promise<APIResponse<HistoricalSharesFloat[]>>;
1557
1893
  /**
1558
1894
  * Get earnings call transcript
1559
1895
  * https://site.financialmodelingprep.com/developer/docs#earnings-transcript-earnings-transcripts
@@ -1566,7 +1902,16 @@ declare class CompanyEndpoints {
1566
1902
  symbol: string;
1567
1903
  year: number;
1568
1904
  quarter: number;
1569
- }): Promise<APIResponse<EarningsCallTranscript[] | null>>;
1905
+ }): Promise<APIResponse<EarningsCallTranscript[]>>;
1906
+ /**
1907
+ * Get company transcript dates
1908
+ * https://site.financialmodelingprep.com/developer/docs#transcript-dates-earnings-transcripts
1909
+ * @param symbol - The stock symbol to get the transcript data for
1910
+ * @returns The FMP Company Transcript Data endpoint provides the transcript data for a company's earnings call.
1911
+ */
1912
+ getCompanyTranscriptData({ symbol, }: {
1913
+ symbol: string;
1914
+ }): Promise<APIResponse<CompanyTranscriptData[]>>;
1570
1915
  }
1571
1916
 
1572
1917
  declare class QuoteEndpoints {
@@ -1577,7 +1922,7 @@ declare class QuoteEndpoints {
1577
1922
  * @param params - Parameters for the quote request
1578
1923
  * @returns Quote data for the specified asset
1579
1924
  */
1580
- getQuote(params: QuoteParams): Promise<APIResponse<Quote | null>>;
1925
+ getQuote(params: QuoteParams): Promise<APIResponse<Quote>>;
1581
1926
  /**
1582
1927
  * Get historical prices for any asset type
1583
1928
  * @param params - Parameters for the historical price request
@@ -1614,6 +1959,12 @@ declare class SenateHouseEndpoints {
1614
1959
  * @returns Senate trading RSS feed
1615
1960
  */
1616
1961
  getSenateTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<SenateTradingResponse[]>>;
1962
+ /** Get Senate trades by name
1963
+ * https://site.financialmodelingprep.com/developer/docs/stable#senate-trading-by-name
1964
+ * @param name - The name of the senator to get the trades for
1965
+ * @returns Senate trades by name
1966
+ */
1967
+ getSenateTradingByName(params: SenateHouseTradingByNameParams): Promise<APIResponse<SenateHouseTradingByNameResponse[]>>;
1617
1968
  /**
1618
1969
  * Get house trading data only
1619
1970
  * https://site.financialmodelingprep.com/developer/docs#house-disclosure
@@ -1626,7 +1977,206 @@ declare class SenateHouseEndpoints {
1626
1977
  * @param page - The page number to get
1627
1978
  * @returns House trading RSS feed
1628
1979
  */
1629
- getHouseTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<SenateTradingResponse[]>>;
1980
+ getHouseTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<HouseTradingResponse[]>>;
1981
+ /** Get house trading by name
1982
+ * https://site.financialmodelingprep.com/developer/docs/stable#house-trading-by-name
1983
+ * @param name - The name of the representative to get the trades for
1984
+ * @returns House trading by name
1985
+ */
1986
+ getHouseTradingByName(params: SenateHouseTradingByNameParams): Promise<APIResponse<SenateHouseTradingByNameResponse[]>>;
1987
+ }
1988
+
1989
+ declare class InstitutionalEndpoints {
1990
+ private client;
1991
+ constructor(client: FMPClient);
1992
+ /**
1993
+ * Get Form 13F institutional stock ownership data
1994
+ * https://site.financialmodelingprep.com/developer/docs#form-13f-13f---institutional-stock-ownership
1995
+ * @param symbol - The stock symbol to get the Form 13F data for
1996
+ * @param date - The date to get the Form 13F data for (optional)
1997
+ * @returns Form 13F institutional stock ownership data
1998
+ */
1999
+ getForm13F(params: Form13FParams): Promise<APIResponse<Form13FResponse[]>>;
2000
+ /**
2001
+ * Get Form 13F dates for institutional stock ownership
2002
+ * https://site.financialmodelingprep.com/developer/docs#form-13f-dates-13f---institutional-stock-ownership
2003
+ * @param symbol - The stock symbol to get the Form 13F dates for
2004
+ * @returns Form 13F dates for institutional stock ownership
2005
+ */
2006
+ getForm13FDates(params: Form13FDatesParams): Promise<APIResponse<string[]>>;
2007
+ /**
2008
+ * Get institutional holders data
2009
+ * https://site.financialmodelingprep.com/developer/docs#institutional-holder-13f---institutional-stock-ownership
2010
+ * @param symbol - The stock symbol to get the institutional holders for
2011
+ * @returns Institutional holders data
2012
+ */
2013
+ getInstitutionalHolders(params: InstitutionalHolderParams): Promise<APIResponse<InstitutionalHolderResponse[]>>;
2014
+ }
2015
+
2016
+ declare class InsiderEndpoints {
2017
+ private client;
2018
+ constructor(client: FMPClient);
2019
+ /**
2020
+ * Get insider trading RSS feed
2021
+ * https://site.financialmodelingprep.com/developer/docs#insider-trades-rss-insider-trading
2022
+ * @param params - Parameters for the RSS feed request
2023
+ * @returns An RSS feed of insider trades, updated in real time
2024
+ */
2025
+ getInsiderTradingRSS({ page, }: InsiderTradingRSSParams): Promise<APIResponse<InsiderTradingRSSResponse[]>>;
2026
+ /**
2027
+ * Search for insider trades
2028
+ * https://site.financialmodelingprep.com/developer/docs#insider-trades-search-insider-trading
2029
+ * @param params - Parameters for the insider trading search
2030
+ * @returns A list of insider trades filtered by the provided parameters
2031
+ */
2032
+ searchInsiderTrading({ symbol, reportingCik, companyCik, transactionType, page, }: InsiderTradingSearchParams): Promise<APIResponse<InsiderTradingSearchResponse[]>>;
2033
+ /**
2034
+ * Get transaction types
2035
+ * https://site.financialmodelingprep.com/developer/docs#transaction-types-insider-trading
2036
+ * @returns A list of all insider transaction types
2037
+ */
2038
+ getTransactionTypes(): Promise<APIResponse<TransactionTypesResponse>>;
2039
+ /**
2040
+ * Get insiders by symbol
2041
+ * https://site.financialmodelingprep.com/developer/docs#insiders-by-symbol-insider-trading
2042
+ * @param params - Parameters for the insiders request
2043
+ * @returns A list of insiders for a specific company
2044
+ */
2045
+ getInsidersBySymbol({ symbol, }: InsidersBySymbolParams): Promise<APIResponse<InsidersBySymbolResponse[]>>;
2046
+ /**
2047
+ * Get insider trade statistics
2048
+ * https://site.financialmodelingprep.com/developer/docs#insider-trade-statistics-insider-trading
2049
+ * @param params - Parameters for the statistics request
2050
+ * @returns Statistics on insider trading activity for a specific company
2051
+ */
2052
+ getInsiderTradeStatistics({ symbol, }: InsiderTradeStatisticsParams): Promise<APIResponse<InsiderTradeStatisticsResponse[]>>;
2053
+ /**
2054
+ * Get CIK mapper
2055
+ * https://site.financialmodelingprep.com/developer/docs#cik-mapper-insider-trading
2056
+ * @param params - Parameters for the CIK mapper request
2057
+ * @returns A list of CIK numbers and corresponding company names
2058
+ */
2059
+ getCikMapper({ page }: CikMapperParams): Promise<APIResponse<CikMapperResponse[]>>;
2060
+ /**
2061
+ * Get CIK mapper by name
2062
+ * https://site.financialmodelingprep.com/developer/docs#cik-mapper-by-name-insider-trading
2063
+ * @param params - Parameters for the CIK mapper by name request
2064
+ * @returns A list of CIK numbers and corresponding names matching the search term
2065
+ */
2066
+ getCikMapperByName({ name, page, }: CikMapperByNameParams): Promise<APIResponse<CikMapperResponse[]>>;
2067
+ /**
2068
+ * Get CIK mapper by symbol
2069
+ * https://site.financialmodelingprep.com/developer/docs#cik-mapper-company-insider-trading
2070
+ * @param params - Parameters for the CIK mapper by symbol request
2071
+ * @returns CIK number and corresponding company name for a specific symbol
2072
+ */
2073
+ getCikMapperBySymbol({ symbol, }: CikMapperBySymbolParams): Promise<APIResponse<CikMapperBySymbolResponse>>;
2074
+ /**
2075
+ * Get beneficial ownership acquisitions
2076
+ * https://site.financialmodelingprep.com/developer/docs#acquisition-of-beneficial-ownership
2077
+ * @param params - Parameters for the beneficial ownership request
2078
+ * @returns A list of acquisitions of beneficial ownership for a specific company
2079
+ */
2080
+ getBeneficialOwnership({ symbol, }: BeneficialOwnershipParams): Promise<APIResponse<BeneficialOwnershipResponse[]>>;
2081
+ /**
2082
+ * Get fail to deliver data
2083
+ * https://site.financialmodelingprep.com/developer/docs#fail-to-deliver
2084
+ * @param params - Parameters for the fail to deliver request
2085
+ * @returns A list of fail to deliver data for a specific company
2086
+ */
2087
+ getFailToDeliver({ symbol, page, }: FailToDeliverParams): Promise<APIResponse<FailToDeliverResponse[]>>;
2088
+ /**
2089
+ * Get all insider trades for a symbol (convenience method)
2090
+ * @param symbol - The stock symbol to get insider trades for
2091
+ * @param page - Page number for pagination (default: 0)
2092
+ * @returns A list of insider trades for the specified symbol
2093
+ */
2094
+ getInsiderTradesBySymbol(symbol: string, page?: number): Promise<APIResponse<InsiderTradingSearchResponse[]>>;
2095
+ /**
2096
+ * Get insider trades by transaction type (convenience method)
2097
+ * @param transactionType - The transaction type to filter by
2098
+ * @param page - Page number for pagination (default: 0)
2099
+ * @returns A list of insider trades filtered by transaction type
2100
+ */
2101
+ getInsiderTradesByType(transactionType: TransactionType | string, page?: number): Promise<APIResponse<InsiderTradingSearchResponse[]>>;
2102
+ /**
2103
+ * Get insider trades by reporting CIK (convenience method)
2104
+ * @param reportingCik - The reporting CIK to filter by
2105
+ * @param page - Page number for pagination (default: 0)
2106
+ * @returns A list of insider trades filtered by reporting CIK
2107
+ */
2108
+ getInsiderTradesByReportingCik(reportingCik: string, page?: number): Promise<APIResponse<InsiderTradingSearchResponse[]>>;
2109
+ /**
2110
+ * Get insider trades by company CIK (convenience method)
2111
+ * @param companyCik - The company CIK to filter by
2112
+ * @param page - Page number for pagination (default: 0)
2113
+ * @returns A list of insider trades filtered by company CIK
2114
+ */
2115
+ getInsiderTradesByCompanyCik(companyCik: string, page?: number): Promise<APIResponse<InsiderTradingSearchResponse[]>>;
2116
+ }
2117
+
2118
+ declare class SECEndpoints {
2119
+ private client;
2120
+ constructor(client: FMPClient);
2121
+ /**
2122
+ * Get RSS feed of SEC filings
2123
+ * https://site.financialmodelingprep.com/developer/docs#rss-feed-securities-and-exchange-commission-(s.e.c)
2124
+ * @param params - RSS feed parameters
2125
+ * @returns A real-time feed of SEC filings from publicly traded companies, including the filing type, link to SEC page, and direct link to the filing. This endpoint can be used to stay up-to-date on the latest SEC filings for all companies or for a specific set of companies.
2126
+ */
2127
+ getRSSFeed(params?: RSSFeedParams): Promise<APIResponse<RSSFeedItem[]>>;
2128
+ /**
2129
+ * Get RSS feed of all SEC filings
2130
+ * https://site.financialmodelingprep.com/developer/docs#rss-feed-all-securities-and-exchange-commission-(s.e.c)
2131
+ * @param params - RSS feed all parameters
2132
+ * @returns A real-time feed of all SEC filings from publicly traded companies in the latest RSS feed format. This endpoint provides a comprehensive overview of all SEC filings, including the filing type, link to SEC page, and direct link to the filing.
2133
+ */
2134
+ getRSSFeedAll(params?: RSSFeedV3Params): Promise<APIResponse<RSSFeedAllItem[]>>;
2135
+ /**
2136
+ * Get RSS feed V3 of SEC filings
2137
+ * https://site.financialmodelingprep.com/developer/docs#rss-feed-v3-securities-and-exchange-commission-(s.e.c)
2138
+ * @param params - RSS feed V3 parameters
2139
+ * @returns A real-time feed of SEC filings from publicly traded companies in the latest RSS feed format (V3)
2140
+ */
2141
+ getRSSFeedV3(params?: RSSFeedV3Params): Promise<APIResponse<RSSFeedV3Item[]>>;
2142
+ /**
2143
+ * Get RSS feed of 8-K SEC filings
2144
+ * https://site.financialmodelingprep.com/developer/docs#rss-feed-8-k-securities-and-exchange-commission-(s.e.c)
2145
+ * @param params - RSS feed 8-K parameters
2146
+ * @returns A real-time feed of 8-K SEC filings from publicly traded companies
2147
+ */
2148
+ getRSSFeed8K(params?: RSSFeed8KParams): Promise<APIResponse<RSSFeed8KItem[]>>;
2149
+ /**
2150
+ * Get SEC filings for a specific company
2151
+ * https://site.financialmodelingprep.com/developer/docs#sec-filings-securities-and-exchange-commission-(s.e.c)
2152
+ * @param symbol - The stock symbol to get SEC filings for
2153
+ * @param params - SEC filings parameters
2154
+ * @returns Access direct links to SEC filings, including the filing type, link to the SEC page, and direct link to the specific filing
2155
+ */
2156
+ getSECFilings({ symbol, params, }: {
2157
+ symbol: string;
2158
+ params?: SECFilingsParams;
2159
+ }): Promise<APIResponse<SECFiling[]>>;
2160
+ /**
2161
+ * Get individual industry classification
2162
+ * https://site.financialmodelingprep.com/developer/docs#individual-industry-classification-standard-industrial-classification
2163
+ * @param params - Industry classification parameters
2164
+ * @returns Identify the industry in which a particular company operates, based on the Standard Industrial Classification (SIC) system
2165
+ */
2166
+ getIndividualIndustryClassification(params: IndividualIndustryClassificationParams): Promise<APIResponse<IndustryClassification>>;
2167
+ /**
2168
+ * Get all industry classifications
2169
+ * https://site.financialmodelingprep.com/developer/docs#all-industry-classification-standard-industrial-classification
2170
+ * @returns Get a comprehensive overview of all industries, classified according to the SIC system
2171
+ */
2172
+ getAllIndustryClassifications(): Promise<APIResponse<IndustryClassification[]>>;
2173
+ /**
2174
+ * Get industry classification codes
2175
+ * https://site.financialmodelingprep.com/developer/docs#industry-classification-codes-standard-industrial-classification
2176
+ * @param params - Industry classification codes parameters
2177
+ * @returns Learn more about the SIC system and identify the SIC code for a particular industry
2178
+ */
2179
+ getIndustryClassificationCodes(params: IndustryClassificationCodesParams): Promise<APIResponse<IndustryClassificationCode[]>>;
1630
2180
  }
1631
2181
 
1632
2182
  /**
@@ -1665,6 +2215,9 @@ declare class FMP {
1665
2215
  readonly company: CompanyEndpoints;
1666
2216
  readonly quote: QuoteEndpoints;
1667
2217
  readonly senateHouse: SenateHouseEndpoints;
2218
+ readonly institutional: InstitutionalEndpoints;
2219
+ readonly insider: InsiderEndpoints;
2220
+ readonly sec: SECEndpoints;
1668
2221
  constructor(config: FMPConfig);
1669
2222
  /**
1670
2223
  * Get the underlying client instance for advanced usage
@@ -1796,4 +2349,4 @@ declare const HTTP_STATUS: {
1796
2349
  readonly INTERNAL_SERVER_ERROR: 500;
1797
2350
  };
1798
2351
 
1799
- export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth, COUNTRIES, CalendarEndpoints, type CashFlowStatement, type CashflowGrowth, CompanyEndpoints, type CompanyNotes, type CompanyProfile, CryptoEndpoints, type CryptoHistoricalParams, type CryptoList, type CryptoListParams, type CryptoQuote, DEFAULT_LIMIT, DEFAULT_TIMEOUT, type DateRangeParams, type DividendsCalendar, ERROR_MESSAGES, type ETFCountryWeighting, ETFEndpoints, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, EXCHANGES, type EarningsCalendar, type EarningsCallTranscript, type EarningsHistorical, type EarningsSurprises, EconomicEndpoints, type EconomicIndicator, type EconomicIndicatorName, type EconomicIndicatorParams, type EconomicsCalendar, type EnterpriseValue, type ErrorResponse, Exchange, type ExecutiveCompensation, FMP, FMPClient, type FMPConfig, FinancialEndpoints, type FinancialGrowth, type FinancialRatios, type FinancialStatementBase, type FinancialStatementsParams, ForexEndpoints, type ForexHistoricalParams, type ForexList, type ForexQuote, type GrowthStatementBase, HTTP_STATUS, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceParams, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IntradayParams, type KeyMetrics, ListEndpoints, MAX_LIMIT, type MarketCap, MarketEndpoints, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, MutualFundEndpoints, type MutualFundHolding, type MutualFundQuote, PERIODS, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, QuoteEndpoints, type QuoteParams, SECTORS, SenateHouseEndpoints, type SenateHouseTradingParams, type SenateHouseTradingRSSFeedParams, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, StockEndpoints, type StockList, type StockQuote, type StockSplit, type StockSplitResponse, type SuccessResponse, type SymbolParams, type TreasuryRate, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };
2352
+ export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipParams, type BeneficialOwnershipResponse, COUNTRIES, CalendarEndpoints, type CashFlowStatement, type CashflowGrowth, type CikMapperByNameParams, type CikMapperBySymbolParams, type CikMapperBySymbolResponse, type CikMapperParams, type CikMapperResponse, type CompaniesPriceListResponse, CompanyEndpoints, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, CryptoEndpoints, type CryptoHistoricalParams, type CryptoList, type CryptoListParams, type CryptoQuote, DEFAULT_LIMIT, DEFAULT_TIMEOUT, type DateRangeParams, type DividendsCalendar, ERROR_MESSAGES, type ETFCountryWeighting, ETFEndpoints, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, EXCHANGES, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, EconomicEndpoints, type EconomicIndicator, type EconomicIndicatorName, type EconomicIndicatorParams, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, FMP, FMPClient, type FMPConfig, type FailToDeliverParams, type FailToDeliverResponse, FinancialEndpoints, type FinancialGrowth, type FinancialRatios, type FinancialStatementBase, type FinancialStatementsParams, ForexEndpoints, type ForexHistoricalParams, type ForexList, type ForexQuote, type Form13FDatesParams, type Form13FParams, type Form13FResponse, type GrowthStatementBase, HTTP_STATUS, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceParams, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, InsiderEndpoints, type InsiderTradeStatisticsParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSParams, type InsiderTradingRSSResponse, type InsiderTradingSearchParams, type InsiderTradingSearchResponse, type InsidersBySymbolParams, type InsidersBySymbolResponse, InstitutionalEndpoints, type InstitutionalHolderParams, type InstitutionalHolderResponse, type IntradayParams, type KeyMetrics, ListEndpoints, MAX_LIMIT, type MarketCap, MarketEndpoints, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, MutualFundEndpoints, type MutualFundHolding, type MutualFundQuote, PERIODS, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, QuoteEndpoints, type QuoteParams, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, SECEndpoints, type SECFiling, type SECFilingsParams, SECTORS, SenateHouseEndpoints, type SenateHouseTradingByNameParams, type SenateHouseTradingByNameResponse, type SenateHouseTradingParams, type SenateHouseTradingRSSFeedParams, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, StockEndpoints, type StockList, type StockListResponse, type StockQuote, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };