fmp-node-types
Version:
Shared TypeScript types for FMP Node Wrapper ecosystem (internal package)
1,335 lines (1,317 loc) • 36.8 kB
TypeScript
interface EarningsCalendar {
date: string;
symbol: string;
eps: number | null;
epsEstimated: number | null;
time: string;
revenue: number | null;
revenueEstimated: number | null;
fiscalDateEnding: string;
updatedFromDate: string;
}
interface EarningsConfirmed {
symbol: string;
exchange: string;
time: string;
when: string;
date: string;
publicationDate: string;
title: string;
url: string;
}
interface DividendsCalendar {
date: string;
label: string;
adjDividend: number;
symbol: string;
dividend: number;
recordDate: string;
paymentDate: string;
declarationDate: string;
}
interface EconomicsCalendar {
date: string;
country: string;
event: string;
currency: string;
previous: number;
estimate: number | null;
actual: number | null;
change: number;
impact: string;
changePercentage: number;
unit: string | null;
}
interface IPOCalendar {
date: string;
company: string;
symbol: string;
exchange: string;
actions: string;
shares: number | null;
priceRange: string | null;
marketCap: number | null;
}
interface SplitsCalendar {
date: string;
label: string;
symbol: string;
numerator: number;
denominator: number;
}
interface APIResponse<T = unknown> {
success: boolean;
data: T | null;
error: string | null;
status: number;
}
interface FMPConfig {
apiKey?: string;
timeout?: number;
}
interface SymbolParams {
symbol: string;
}
interface DateRangeParams {
from?: string;
to?: string;
}
interface PaginationParams {
limit?: number;
page?: number;
}
interface PeriodParams {
period?: 'annual' | 'quarter';
}
interface QueryParams {
[key: string]: string | number | boolean | undefined;
}
declare enum Period {
ANNUAL = "annual",
QUARTER = "quarter"
}
declare enum Exchange {
NYSE = "NYSE",
NASDAQ = "NASDAQ",
AMEX = "AMEX",
TSX = "TSX",
LSE = "LSE",
ASX = "ASX",
NSE = "NSE",
BSE = "BSE"
}
interface CompanyProfile {
symbol: string;
price: number;
marketCap: number;
beta: number;
lastDividend: number;
range: string;
change: number;
changePercentage: number;
volume: number;
averageVolume: number;
companyName: string;
currency: string;
cik: string;
isin: string;
cusip: string;
exchangeFullName: string;
exchange: string;
industry: string;
website: string;
description: string;
ceo: string;
sector: string;
country: string;
fullTimeEmployees: string;
phone: string;
address: string;
city: string;
state: string;
zip: string;
image: string;
ipoDate: string;
defaultImage: boolean;
isEtf: boolean;
isActivelyTrading: boolean;
isAdr: boolean;
isFund: boolean;
}
interface ExecutiveCompensation {
cik: string;
symbol: string;
companyName: string;
filingDate: string;
acceptedDate: string;
nameAndPosition: string;
year: number;
salary: number;
bonus: number;
stockAward: number;
optionAward: number;
incentivePlanCompensation: number;
allOtherCompensation: number;
total: number;
link: string;
}
interface CompanyNotes {
cik: string;
symbol: string;
title: string;
exchange: string;
}
interface HistoricalEmployeeCount {
symbol: string;
cik: string;
acceptanceTime: string;
periodOfReport: string;
companyName: string;
formType: string;
filingDate: string;
employeeCount: number;
source: string;
}
interface SharesFloat {
symbol: string;
freeFloat: number;
floatShares: number;
outstandingShares: number;
source: string;
date: string;
}
interface HistoricalSharesFloat {
symbol: string;
freeFloat: number;
floatShares: string;
outstandingShares: string;
source: string;
date: string;
}
interface EarningsCallTranscript {
symbol: string;
quarter: number;
year: number;
date: string;
content: string;
}
type CompanyTranscriptData = [number, number, string];
interface EconomicIndicator {
name: string;
date: string;
value: number;
}
interface TreasuryRate {
date: string;
month1: number;
month2: number;
month3: number;
month6: number;
year1: number;
year2: number;
year3: number;
year5: number;
year7: number;
year10: number;
year20: number;
year30: number;
}
type EconomicIndicatorName = 'GDP' | 'realGDP' | 'nominalPotentialGDP' | 'realGDPPerCapita' | 'federalFunds' | 'CPI' | 'inflationRate' | 'inflation' | 'retailSales' | 'consumerSentiment' | 'durableGoods' | 'unemploymentRate' | 'totalNonfarmPayroll' | 'initialClaims' | 'industrialProductionTotalIndex' | 'newPrivatelyOwnedHousingUnitsStartedTotalUnits' | 'totalVehicleSales' | 'retailMoneyFunds' | 'smoothedUSRecessionProbabilities' | '3MonthOr90DayRatesAndYieldsCertificatesOfDeposit' | 'commercialBankInterestRateOnCreditCardPlansAllAccounts' | '30YearFixedRateMortgageAverage' | '15YearFixedRateMortgageAverage';
interface ETFHoldingDates {
date: string;
}
interface ETFHolding {
cik: string;
acceptanceTime: string;
date: string;
symbol: string;
name: string;
lei: string;
title: string;
cusip: string;
isin: string;
balance: number;
units: string;
cur_cd: string;
valUsd: number;
pctVal: number;
payoffProfile: string;
assetCat: string;
issuerCat: string;
invCountry: string;
isRestrictedSec: string;
fairValLevel: string;
isCashCollateral: string;
isNonCashCollateral: string;
isLoanByFund: string;
}
interface ETFHolder {
asset: string;
name: string;
isin: string;
cusip: string;
sharesNumber: number;
weightPercentage: number;
marketValue: number;
updated: string;
}
interface ETFProfile {
symbol: string;
name: string;
description: string;
isin: string;
assetClass: string;
securityCusip: string;
domicile: string;
website: string;
etfCompany: string;
expenseRatio: number;
assetsUnderManagement: number;
avgVolume: number;
inceptionDate: string;
nav: number;
navCurrency: string;
holdingsCount: number;
updatedAt: string;
sectorsList: {
exposure: string;
industry: string;
}[];
}
interface ETFWeighting {
symbol: string;
sector: string;
weightPercentage: string;
}
interface ETFCountryWeighting {
country: string;
weightPercentage: string;
}
interface ETFStockExposure {
etfSymbol: string;
assetExposure: string;
sharesNumber: number;
weightPercentage: number;
marketValue: number;
}
interface IncomeStatement {
date: string;
symbol: string;
reportedCurrency: string;
cik: string;
filingDate: string;
acceptedDate: string;
fiscalYear: string;
period: string;
revenue: number;
costOfRevenue: number;
grossProfit: number;
researchAndDevelopmentExpenses: number;
generalAndAdministrativeExpenses: number;
sellingAndMarketingExpenses: number;
sellingGeneralAndAdministrativeExpenses: number;
otherExpenses: number;
operatingExpenses: number;
costAndExpenses: number;
netInterestIncome: number;
interestIncome: number;
interestExpense: number;
depreciationAndAmortization: number;
ebitda: number;
ebit: number;
nonOperatingIncomeExcludingInterest: number;
operatingIncome: number;
totalOtherIncomeExpensesNet: number;
incomeBeforeTax: number;
incomeTaxExpense: number;
netIncomeFromContinuingOperations: number;
netIncomeFromDiscontinuedOperations: number;
otherAdjustmentsToNetIncome: number;
netIncome: number;
netIncomeDeductions: number;
bottomLineNetIncome: number;
eps: number;
epsDiluted: number;
weightedAverageShsOut: number;
weightedAverageShsOutDil: number;
}
interface BalanceSheet {
date: string;
symbol: string;
reportedCurrency: string;
cik: string;
filingDate: string;
acceptedDate: string;
fiscalYear: string;
period: string;
cashAndCashEquivalents: number;
shortTermInvestments: number;
cashAndShortTermInvestments: number;
netReceivables: number;
accountsReceivables: number;
otherReceivables: number;
inventory: number;
prepaids: number;
otherCurrentAssets: number;
totalCurrentAssets: number;
propertyPlantEquipmentNet: number;
goodwill: number;
intangibleAssets: number;
goodwillAndIntangibleAssets: number;
longTermInvestments: number;
taxAssets: number;
otherNonCurrentAssets: number;
totalNonCurrentAssets: number;
otherAssets: number;
totalAssets: number;
totalPayables: number;
accountPayables: number;
otherPayables: number;
accruedExpenses: number;
shortTermDebt: number;
capitalLeaseObligationsCurrent: number;
taxPayables: number;
deferredRevenue: number;
otherCurrentLiabilities: number;
totalCurrentLiabilities: number;
longTermDebt: number;
deferredRevenueNonCurrent: number;
deferredTaxLiabilitiesNonCurrent: number;
otherNonCurrentLiabilities: number;
totalNonCurrentLiabilities: number;
otherLiabilities: number;
capitalLeaseObligations: number;
totalLiabilities: number;
treasuryStock: number;
preferredStock: number;
commonStock: number;
retainedEarnings: number;
additionalPaidInCapital: number;
accumulatedOtherComprehensiveIncomeLoss: number;
otherTotalStockholdersEquity: number;
totalStockholdersEquity: number;
totalEquity: number;
minorityInterest: number;
totalLiabilitiesAndTotalEquity: number;
totalInvestments: number;
totalDebt: number;
netDebt: number;
}
interface CashFlowStatement {
date: string;
symbol: string;
reportedCurrency: string;
cik: string;
filingDate: string;
acceptedDate: string;
fiscalYear: string;
period: string;
netIncome: number;
depreciationAndAmortization: number;
deferredIncomeTax: number;
stockBasedCompensation: number;
changeInWorkingCapital: number;
accountsReceivables: number;
inventory: number;
accountsPayables: number;
otherWorkingCapital: number;
otherNonCashItems: number;
netCashProvidedByOperatingActivities: number;
investmentsInPropertyPlantAndEquipment: number;
acquisitionsNet: number;
purchasesOfInvestments: number;
salesMaturitiesOfInvestments: number;
otherInvestingActivities: number;
netCashProvidedByInvestingActivities: number;
netDebtIssuance: number;
longTermNetDebtIssuance: number;
shortTermNetDebtIssuance: number;
netStockIssuance: number;
netCommonStockIssuance: number;
commonStockIssuance: number;
commonStockRepurchased: number;
netPreferredStockIssuance: number;
netDividendsPaid: number;
commonDividendsPaid: number;
preferredDividendsPaid: number;
otherFinancingActivities: number;
netCashProvidedByFinancingActivities: number;
effectOfForexChangesOnCash: number;
netChangeInCash: number;
cashAtEndOfPeriod: number;
cashAtBeginningOfPeriod: number;
operatingCashFlow: number;
capitalExpenditure: number;
freeCashFlow: number;
incomeTaxesPaid: number;
interestPaid: number;
}
interface KeyMetrics {
symbol: string;
date: string;
fiscalYear: string;
period: string;
reportedCurrency: string;
marketCap: number;
enterpriseValue: number;
evToSales: number;
evToOperatingCashFlow: number;
evToFreeCashFlow: number;
evToEBITDA: number;
netDebtToEBITDA: number;
currentRatio: number;
incomeQuality: number;
grahamNumber: number;
grahamNetNet: number;
taxBurden: number;
interestBurden: number;
workingCapital: number;
investedCapital: number;
returnOnAssets: number;
operatingReturnOnAssets: number;
returnOnTangibleAssets: number;
returnOnEquity: number;
returnOnInvestedCapital: number;
returnOnCapitalEmployed: number;
earningsYield: number;
freeCashFlowYield: number;
capexToOperatingCashFlow: number;
capexToDepreciation: number;
capexToRevenue: number;
salesGeneralAndAdministrativeToRevenue: number;
researchAndDevelopementToRevenue: number;
stockBasedCompensationToRevenue: number;
intangiblesToTotalAssets: number;
averageReceivables: number;
averagePayables: number;
averageInventory: number;
daysOfSalesOutstanding: number;
daysOfPayablesOutstanding: number;
daysOfInventoryOutstanding: number;
operatingCycle: number;
cashConversionCycle: number;
freeCashFlowToEquity: number;
freeCashFlowToFirm: number;
tangibleAssetValue: number;
netCurrentAssetValue: number;
}
interface FinancialRatios {
symbol: string;
date: string;
fiscalYear: string;
period: string;
reportedCurrency: string;
grossProfitMargin: number;
ebitMargin: number;
ebitdaMargin: number;
operatingProfitMargin: number;
pretaxProfitMargin: number;
continuousOperationsProfitMargin: number;
netProfitMargin: number;
bottomLineProfitMargin: number;
receivablesTurnover: number;
payablesTurnover: number;
inventoryTurnover: number;
fixedAssetTurnover: number;
assetTurnover: number;
currentRatio: number;
quickRatio: number;
solvencyRatio: number;
cashRatio: number;
priceToEarningsRatio: number;
priceToEarningsGrowthRatio: number;
forwardPriceToEarningsGrowthRatio: number;
priceToBookRatio: number;
priceToSalesRatio: number;
priceToFreeCashFlowRatio: number;
priceToOperatingCashFlowRatio: number;
debtToAssetsRatio: number;
debtToEquityRatio: number;
debtToCapitalRatio: number;
longTermDebtToCapitalRatio: number;
financialLeverageRatio: number;
workingCapitalTurnoverRatio: number;
operatingCashFlowRatio: number;
operatingCashFlowSalesRatio: number;
freeCashFlowOperatingCashFlowRatio: number;
debtServiceCoverageRatio: number;
interestCoverageRatio: number;
shortTermOperatingCashFlowCoverageRatio: number;
operatingCashFlowCoverageRatio: number;
capitalExpenditureCoverageRatio: number;
dividendPaidAndCapexCoverageRatio: number;
dividendPayoutRatio: number;
dividendYield: number;
dividendYieldPercentage: number;
revenuePerShare: number;
netIncomePerShare: number;
interestDebtPerShare: number;
cashPerShare: number;
bookValuePerShare: number;
tangibleBookValuePerShare: number;
shareholdersEquityPerShare: number;
operatingCashFlowPerShare: number;
capexPerShare: number;
freeCashFlowPerShare: number;
netIncomePerEBT: number;
ebtPerEbit: number;
priceToFairValue: number;
debtToMarketCap: number;
effectiveTaxRate: number;
enterpriseValueMultiple: number;
}
interface EnterpriseValue {
symbol: string;
date: string;
stockPrice: number;
numberOfShares: number;
marketCapitalization: number;
minusCashAndCashEquivalents: number;
addTotalDebt: number;
enterpriseValue: number;
}
interface CashflowGrowth {
symbol: string;
date: string;
fiscalYear: string;
period: string;
reportedCurrency: string;
growthNetIncome: number;
growthDepreciationAndAmortization: number;
growthDeferredIncomeTax: number;
growthStockBasedCompensation: number;
growthChangeInWorkingCapital: number;
growthAccountsReceivables: number;
growthInventory: number;
growthAccountsPayables: number;
growthOtherWorkingCapital: number;
growthOtherNonCashItems: number;
growthNetCashProvidedByOperatingActivites: number;
growthInvestmentsInPropertyPlantAndEquipment: number;
growthAcquisitionsNet: number;
growthPurchasesOfInvestments: number;
growthSalesMaturitiesOfInvestments: number;
growthOtherInvestingActivites: number;
growthNetCashUsedForInvestingActivites: number;
growthDebtRepayment: number;
growthCommonStockIssued: number;
growthCommonStockRepurchased: number;
growthDividendsPaid: number;
growthOtherFinancingActivites: number;
growthNetCashUsedProvidedByFinancingActivities: number;
growthEffectOfForexChangesOnCash: number;
growthNetChangeInCash: number;
growthCashAtEndOfPeriod: number;
growthCashAtBeginningOfPeriod: number;
growthOperatingCashFlow: number;
growthCapitalExpenditure: number;
growthFreeCashFlow: number;
growthNetDebtIssuance: number;
growthLongTermNetDebtIssuance: number;
growthShortTermNetDebtIssuance: number;
growthNetStockIssuance: number;
growthPreferredDividendsPaid: number;
growthIncomeTaxesPaid: number;
growthInterestPaid: number;
}
interface IncomeGrowth {
symbol: string;
date: string;
fiscalYear: string;
period: string;
reportedCurrency: string;
growthRevenue: number;
growthCostOfRevenue: number;
growthGrossProfit: number;
growthGrossProfitRatio: number;
growthResearchAndDevelopmentExpenses: number;
growthGeneralAndAdministrativeExpenses: number;
growthSellingAndMarketingExpenses: number;
growthOtherExpenses: number;
growthOperatingExpenses: number;
growthCostAndExpenses: number;
growthInterestIncome: number;
growthInterestExpense: number;
growthDepreciationAndAmortization: number;
growthEBITDA: number;
growthOperatingIncome: number;
growthIncomeBeforeTax: number;
growthIncomeTaxExpense: number;
growthNetIncome: number;
growthEPS: number;
growthEPSDiluted: number;
growthWeightedAverageShsOut: number;
growthWeightedAverageShsOutDil: number;
growthEBIT: number;
growthNonOperatingIncomeExcludingInterest: number;
growthNetInterestIncome: number;
growthTotalOtherIncomeExpensesNet: number;
growthNetIncomeFromContinuingOperations: number;
growthOtherAdjustmentsToNetIncome: number;
growthNetIncomeDeductions: number;
}
interface BalanceSheetGrowth {
symbol: string;
date: string;
fiscalYear: string;
period: string;
reportedCurrency: string;
growthCashAndCashEquivalents: number;
growthShortTermInvestments: number;
growthCashAndShortTermInvestments: number;
growthNetReceivables: number;
growthInventory: number;
growthOtherCurrentAssets: number;
growthTotalCurrentAssets: number;
growthPropertyPlantEquipmentNet: number;
growthGoodwill: number;
growthIntangibleAssets: number;
growthGoodwillAndIntangibleAssets: number;
growthLongTermInvestments: number;
growthTaxAssets: number;
growthOtherNonCurrentAssets: number;
growthTotalNonCurrentAssets: number;
growthOtherAssets: number;
growthTotalAssets: number;
growthAccountPayables: number;
growthShortTermDebt: number;
growthTaxPayables: number;
growthDeferredRevenue: number;
growthOtherCurrentLiabilities: number;
growthTotalCurrentLiabilities: number;
growthLongTermDebt: number;
growthDeferredRevenueNonCurrent: number;
growthDeferredTaxLiabilitiesNonCurrent: number;
growthOtherNonCurrentLiabilities: number;
growthTotalNonCurrentLiabilities: number;
growthOtherLiabilities: number;
growthTotalLiabilities: number;
growthPreferredStock: number;
growthCommonStock: number;
growthRetainedEarnings: number;
growthAccumulatedOtherComprehensiveIncomeLoss: number;
growthOthertotalStockholdersEquity: number;
growthTotalStockholdersEquity: number;
growthMinorityInterest: number;
growthTotalEquity: number;
growthTotalLiabilitiesAndStockholdersEquity: number;
growthTotalInvestments: number;
growthTotalDebt: number;
growthNetDebt: number;
growthAccountsReceivables: number;
growthOtherReceivables: number;
growthPrepaids: number;
growthTotalPayables: number;
growthOtherPayables: number;
growthAccruedExpenses: number;
growthCapitalLeaseObligationsCurrent: number;
growthAdditionalPaidInCapital: number;
growthTreasuryStock: number;
}
interface FinancialGrowth {
symbol: string;
date: string;
fiscalYear: string;
period: string;
reportedCurrency: string;
revenueGrowth: number;
grossProfitGrowth: number;
ebitgrowth: number;
operatingIncomeGrowth: number;
netIncomeGrowth: number;
epsgrowth: number;
epsdilutedGrowth: number;
weightedAverageSharesGrowth: number;
weightedAverageSharesDilutedGrowth: number;
dividendsPerShareGrowth: number;
operatingCashFlowGrowth: number;
receivablesGrowth: number;
inventoryGrowth: number;
assetGrowth: number;
bookValueperShareGrowth: number;
debtGrowth: number;
rdexpenseGrowth: number;
sgaexpensesGrowth: number;
freeCashFlowGrowth: number;
tenYRevenueGrowthPerShare: number;
fiveYRevenueGrowthPerShare: number;
threeYRevenueGrowthPerShare: number;
tenYOperatingCFGrowthPerShare: number;
fiveYOperatingCFGrowthPerShare: number;
threeYOperatingCFGrowthPerShare: number;
tenYNetIncomeGrowthPerShare: number;
fiveYNetIncomeGrowthPerShare: number;
threeYNetIncomeGrowthPerShare: number;
tenYShareholdersEquityGrowthPerShare: number;
fiveYShareholdersEquityGrowthPerShare: number;
threeYShareholdersEquityGrowthPerShare: number;
tenYDividendperShareGrowthPerShare: number;
fiveYDividendperShareGrowthPerShare: number;
threeYDividendperShareGrowthPerShare: number;
ebitdaGrowth: number;
growthCapitalExpenditure: number;
tenYBottomLineNetIncomeGrowthPerShare: number;
fiveYBottomLineNetIncomeGrowthPerShare: number;
threeYBottomLineNetIncomeGrowthPerShare: number;
}
interface EarningsHistorical {
date: string;
symbol: string;
epsActual: number;
epsEstimated: number;
revenueActual: number;
revenueEstimated: number;
lastUpdated: string;
}
interface EarningsSurprises {
date: string;
symbol: string;
actualEarningResult: number;
estimatedEarning: number;
}
interface InsiderTradingRSSResponse {
symbol: string;
filingDate: string;
transactionDate: string;
reportingCik: string;
companyCik: string;
transactionType: string;
securitiesOwned: number;
reportingName: string;
typeOfOwner: string;
acquisitionOrDisposition: string;
directOrIndirect: string;
formType: string;
securitiesTransacted: number;
price: number;
securityName: string;
url: string;
}
interface InsiderTradingSearchResponse {
symbol: string;
filingDate: string;
transactionDate: string;
reportingCik: string;
companyCik: string;
transactionType: string;
securitiesOwned: number;
reportingName: string;
typeOfOwner: string;
acquisitionOrDisposition: string;
directOrIndirect: string;
formType: string;
securitiesTransacted: number;
price: number;
securityName: string;
url: string;
}
type TransactionTypesResponse = {
transactionType: string;
}[];
interface InsidersBySymbolResponse {
typeOfOwner: string;
transactionDate: string;
owner: string;
}
interface InsiderTradeStatisticsResponse {
symbol: string;
cik: string;
year: number;
quarter: number;
acquiredTransactions: number;
disposedTransactions: number;
acquiredDisposedRatio: number;
totalAcquired: number;
totalDisposed: number;
averageAcquired: number;
averageDisposed: number;
totalPurchases: number;
totalSales: number;
}
interface CikMapperResponse {
reportingCik: string;
reportingName: string;
}
interface CikMapperBySymbolResponse {
symbol: string;
companyCik: string;
}
interface BeneficialOwnershipResponse {
cik: string;
symbol: string;
filingDate: string;
acceptedDate: string;
cusip: string;
nameOfReportingPerson: string;
citizenshipOrPlaceOfOrganization: string;
soleVotingPower: string;
sharedVotingPower: string;
soleDispositivePower: string;
sharedDispositivePower: string;
amountBeneficiallyOwned: string;
percentOfClass: string;
typeOfReportingPerson: string;
url: string;
}
interface FailToDeliverResponse {
symbol: string;
date: string;
price: number;
quantity: number;
cusip: string;
name: string;
}
declare enum TransactionType {
AWARD = "A-Award",
CONVERSION = "C-Conversion",
RETURN = "D-Return",
EXPIRE_SHORT = "E-ExpireShort",
IN_KIND = "F-InKind",
GIFT = "G-Gift",
EXPIRE_LONG = "H-ExpireLong",
DISCRETIONARY = "I-Discretionary",
OTHER = "J-Other",
SMALL = "L-Small",
EXEMPT = "M-Exempt",
OUT_OF_THE_MONEY = "O-OutOfTheMoney",
PURCHASE = "P-Purchase",
SALE = "S-Sale",
TENDER = "U-Tender",
WILL = "W-Will",
IN_THE_MONEY = "X-InTheMoney",
TRUST = "Z-Trust"
}
interface Form13FResponse {
date: string;
fillingDate: string;
acceptedDate: string;
cik: string;
cusip: string;
tickercusip: string;
nameOfIssuer: string;
shares: number;
titleOfClass: string;
value: number;
link: string;
finalLink: string;
}
interface InstitutionalHolderResponse {
holder: string;
shares: number;
dateReported: string;
change: number;
}
interface StockList {
symbol: string;
exchange: string;
exchangeShortName: string;
price: number;
name: string;
type: string;
}
interface ETFList {
symbol: string;
exchange: string;
exchangeShortName: string;
price: number;
name: string;
}
interface CryptoList {
symbol: string;
name: string;
currency: string;
stockExchange: string;
exchangeShortName: string;
}
interface ForexList {
symbol: string;
name: string;
currency: string;
stockExchange: string;
exchangeShortName: string;
}
interface AvailableIndexesList {
symbol: string;
name: string;
currency: string;
stockExchange: string;
exchangeShortName: string;
}
interface MarketHours {
stockExchangeName: string;
stockMarketHours: {
openingHour: string;
closingHour: string;
};
stockMarketHolidays: MarketHoliday[];
isTheStockMarketOpen: boolean;
isTheEuronextMarketOpen: boolean;
isTheForexMarketOpen: boolean;
isTheCryptoMarketOpen: boolean;
}
interface MarketHoliday {
year: number;
'Martin Luther King, Jr. Day': string;
"Presidents' Day": string;
'Good Friday': string;
'Memorial Day': string;
Juneteenth: string;
'Independence Day': string;
'Labor Day': string;
'Thanksgiving Day': string;
Christmas: string;
}
interface MarketPerformance {
symbol: string;
name: string;
change: number;
price: number;
changesPercentage: number;
}
interface MarketSectorPerformance {
sector: string;
changesPercentage: number;
}
interface MarketIndex {
symbol: string;
price: number;
extendedPrice: number | null;
change: number;
dayHigh: number;
dayLow: number;
previousClose: number;
volume: number | null;
open: number;
close: number | null;
lastTradeTime: string;
lastExtendedTradeTime: string | null;
updatedAt: string;
createdAt: string;
type: string;
name: string;
range: string;
yearHigh: number;
yearLow: number;
priceAvg50: number | null;
priceAvg200: number | null;
changesPercentage: number;
}
interface MutualFundHolding {
holder: string;
shares: number;
dateReported: string;
change: number;
weightPercent: number;
}
interface News {
symbol: string;
publishedDate: string;
publisher: string;
title: string;
image: string;
site: string;
text: string;
url: string;
}
interface Article {
title: string;
date: string;
content: string;
tickers: string;
image: string;
link: string;
author: string;
site: string;
}
interface Quote {
symbol: string;
name: string;
price: number;
changesPercentage: number;
change: number;
dayLow: number;
dayHigh: number;
yearHigh: number;
yearLow: number;
marketCap: number | null;
priceAvg50: number;
priceAvg200: number;
exchange: string;
volume: number;
avgVolume: number;
open: number;
previousClose: number;
eps: number | null;
pe: number | null;
earningsAnnouncement: string | null;
sharesOutstanding: number | null;
timestamp: number;
}
interface HistoricalPriceData {
date: string;
open: number;
high: number;
low: number;
close: number;
adjClose: number;
volume: number;
unadjustedVolume: number;
change: number;
changePercent: number;
vwap: number;
label: string;
changeOverTime: number;
}
interface HistoricalPriceResponse {
symbol: string;
historical: HistoricalPriceData[];
}
interface RSSFeedItem {
title: string;
date: string;
link: string;
cik: string;
form_type: string;
ticker: string;
done: boolean;
}
interface RSSFeedV3Item {
title: string;
date: string;
link: string;
cik: string;
form_type: string;
ticker: string;
done: boolean;
}
interface RSSFeed8KItem {
title: string;
symbol: string;
cik: string;
link: string;
finalLink: string;
date: string;
process: string;
hasFinancials: string;
}
interface SECFiling {
symbol: string;
cik: string;
type: string;
link: string;
finalLink: string;
acceptedDate: string;
fillingDate: string;
}
interface IndustryClassification {
symbol: string;
name: string;
cik: string;
sicCode: string;
industryTitle: string;
businessAdress: string;
phoneNumber: string;
}
interface IndustryClassificationCode {
office: string;
sicCode: string;
industryTitle: string;
}
interface RSSFeedParams {
limit?: number;
type?: string;
from?: string;
to?: string;
isDone?: boolean;
}
interface RSSFeedV3Params {
page?: number;
datatype?: string;
}
interface RSSFeedAllItem {
symbol: string;
fillingDate: string;
acceptedDate: string;
cik: string;
type: string;
link: string;
finalLink: string;
}
interface RSSFeed8KParams {
page?: number;
from?: string;
to?: string;
hasFinancial?: boolean;
limit?: number;
}
interface SECFilingsParams {
page?: number;
type?: string;
}
interface IndividualIndustryClassificationParams {
symbol?: string;
cik?: number;
sicCode?: number;
}
interface IndustryClassificationCodesParams {
industryTitle?: string;
sicCode?: number;
}
interface ScreenerParams {
marketCapMoreThan?: number;
marketCapLowerThan?: number;
sector?: string;
industry?: string;
betaMoreThan?: number;
betaLowerThan?: number;
priceMoreThan?: number;
priceLowerThan?: number;
dividendMoreThan?: number;
dividendLowerThan?: number;
volumeMoreThan?: number;
volumeLowerThan?: number;
exchange?: string;
country?: string;
isEtf?: boolean;
isFund?: boolean;
isActivelyTrading?: boolean;
limit?: number;
includeAllShareClasses?: boolean;
}
interface Screener {
symbol: string;
companyName: string;
marketCap: number;
sector: string;
industry: string;
beta: number;
price: number;
lastAnnualDividend: number;
volume: number;
exchange: string;
exchangeShortName: string;
country: string;
isEtf: boolean;
isFund: boolean;
isActivelyTrading: boolean;
}
interface AvailableExchanges {
exchange: string;
name: string;
countryName: string;
countryCode: string;
symbolSuffix: string;
delay: string;
}
interface AvailableSectors {
sector: string;
}
interface AvailableIndustries {
industry: string;
}
interface AvailableCountries {
country: string;
}
interface SenateTradingResponse {
symbol: string;
disclosureDate: string;
transactionDate: string;
firstName: string;
lastName: string;
office: string;
district: string;
owner: string;
assetDescription: string;
assetType: string;
type: string;
amount: string;
capitalGainsOver200USD: string;
comment: string;
link: string;
}
interface HouseTradingResponse {
symbol: string;
disclosureDate: string;
transactionDate: string;
firstName: string;
lastName: string;
office: string;
district: string;
owner: string;
assetDescription: string;
assetType: string;
type: string;
amount: string;
capitalGainsOver200USD: string;
comment: string;
link: string;
}
interface SenateHouseTradingByNameResponse {
symbol: string;
disclosureDate: string;
transactionDate: string;
firstName: string;
lastName: string;
office: string;
district: string;
owner: string;
assetDescription: string;
assetType: string;
type: string;
amount: string;
capitalGainsOver200USD: string;
comment: string;
link: string;
}
interface StockSplit {
date: string;
label: string;
numerator: number;
denominator: number;
}
interface StockSplitResponse {
symbol: string;
historical: StockSplit[];
}
interface StockDividend {
date: string;
label: string;
adjDividend: number;
dividend: number;
recordDate: string;
paymentDate: string;
declarationDate: string;
}
interface StockDividendResponse {
symbol: string;
historical: StockDividend[];
}
interface MarketCap {
symbol: string;
date: string;
marketCap: number;
}
interface StockRealTimePrice {
symbol: string;
price: number;
}
interface StockRealTimePriceFull {
bidSize: number;
askPrice: number;
volume: number;
askSize: number;
bidPrice: number;
lastSalePrice: number;
lastSaleSize: number;
lastSaleTime: number;
fmpLast: number;
lastUpdated: number;
symbol: string;
}
interface StockListResponse<T> {
stockList: T[];
}
interface CompaniesPriceListResponse<T> {
companiesPriceList: T[];
}
export { type APIResponse, type Article, type AvailableCountries, type AvailableExchanges, type AvailableIndexesList, type AvailableIndustries, type AvailableSectors, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type News, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type Screener, type ScreenerParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };