SimFin.Free

Documentation

data SimFinContext

The context needed to call every fetch* function.

Constructors

SimFinContext

Fields

• simFinApiKey :: ByteString
• simFinManager :: Manager

data Industry general bank insurance

Distinguish between different industry-specific data.

Constructors

General general

Bank bank

Insurance insurance

Instances

FromJSON IndustryCashFlows

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser IndustryCashFlows

parseJSONList :: Value -> Parser [IndustryCashFlows]

FromJSON IndustryBalanceSheets

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser IndustryBalanceSheets

parseJSONList :: Value -> Parser [IndustryBalanceSheets]

FromJSON IndustryProfitsAndLosses

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser IndustryProfitsAndLosses

parseJSONList :: Value -> Parser [IndustryProfitsAndLosses]

(Show general, Show bank, Show insurance) => Show (Industry general bank insurance)

Defined in SimFin.Types.Industry

Methods

showsPrec :: Int -> Industry general bank insurance -> ShowS

show :: Industry general bank insurance -> String

showList :: [Industry general bank insurance] -> ShowS

data CompanyListingRow

SimFin ID and company ticker. See the SimFin docs.

Constructors

CompanyListingRow

Fields

• simFinId :: Int
• ticker :: Text

Instances

Show CompanyListingRow

Defined in SimFin.Types.CompanyListing

Methods

showsPrec :: Int -> CompanyListingRow -> ShowS

show :: CompanyListingRow -> String

showList :: [CompanyListingRow] -> ShowS

FromJSON CompanyListingRow

Defined in SimFin.Types.CompanyListing

Methods

parseJSON :: Value -> Parser CompanyListingRow

parseJSONList :: Value -> Parser [CompanyListingRow]

data CompanyInfoRow

Genreal information about a company. See the SimFin docs.

Constructors

CompanyInfoRow

Fields

• simFinId :: Int
• ticker :: Text
• companyName :: Text
• industryId :: Int
• monthFYEnd :: Int
• numberEmployees :: Int
• businessSummary :: Text

Instances

Show CompanyInfoRow

Defined in SimFin.Types.CompanyInfo

Methods

showsPrec :: Int -> CompanyInfoRow -> ShowS

show :: CompanyInfoRow -> String

showList :: [CompanyInfoRow] -> ShowS

FromJSON CompanyInfoRow

Defined in SimFin.Types.CompanyInfo

Methods

parseJSON :: Value -> Parser CompanyInfoRow

parseJSONList :: Value -> Parser [CompanyInfoRow]

data GeneralBalanceSheetRow

Balance sheet statement for general companies.

Constructors

GeneralBalanceSheetRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• cashCashEquivalentsAndShortTermInvestments :: Maybe Integer
• cashAndCashEquivalents :: Maybe Integer
• shortTermInvestments :: Maybe Integer
• accountsAndNotesReceivable :: Maybe Integer
• accountsReceivableNet :: Maybe Integer
• notesReceivableNet :: Maybe Integer
• unbilledRevenues :: Maybe Integer
• inventories :: Maybe Integer
• rawMaterials :: Maybe Integer
• workInProcess :: Maybe Integer
• finishedGoods :: Maybe Integer
• otherInventory :: Maybe Integer
• otherShortTermAssets :: Maybe Integer
• prepaidExpenses :: Maybe Integer
• derivativeAndHedgingAssetsShortTerm :: Maybe Integer
• assetsHeldForSale :: Maybe Integer
• deferredTaxAssetsShortTerm :: Maybe Integer
• incomeTaxesReceivable :: Maybe Integer
• discontinuedOperationsShortTerm :: Maybe Integer
• miscShortTermAssets :: Maybe Integer
• totalCurrentAssets :: Maybe Integer
• propertyPlantAndEquipmentNet :: Maybe Integer
• propertyPlantAndEquipment :: Maybe Integer
• accumulatedDepreciation :: Maybe Integer
• longTermInvestmentsAndReceivables :: Maybe Integer
• longTermInvestments :: Maybe Integer
• longTermMarketableSecurities :: Maybe Integer
• longTermReceivables :: Maybe Integer
• otherLongTermAssets :: Maybe Integer
• intangibleAssets :: Maybe Integer
• goodwill :: Maybe Integer
• otherIntangibleAssets :: Maybe Integer
• prepaidExpense :: Maybe Integer
• deferredTaxAssetsLongTerm :: Maybe Integer
• derivativeAndHedgingAssetsLongTerm :: Maybe Integer
• prepaidPensionCosts :: Maybe Integer
• discontinuedOperationsLongTerm :: Maybe Integer
• investmentsinAffiliates :: Maybe Integer
• miscLongTermAssets :: Maybe Integer
• totalNoncurrentAssets :: Maybe Integer
• totalAssets :: Maybe Integer
• payablesAndAccruals :: Maybe Integer
• accountsPayable :: Maybe Integer
• accruedTaxes :: Maybe Integer
• interestAndDividendsPayable :: Maybe Integer
• otherPayablesAndAccruals :: Maybe Integer
• shortTermDebt :: Maybe Integer
• shortTermBorrowings :: Maybe Integer
• shortTermCapitalLeases :: Maybe Integer
• currentPortionOfLongTermDebt :: Maybe Integer
• otherShortTermLiabilities :: Maybe Integer
• deferredRevenueShortTerm :: Maybe Integer
• liabilitiesfromDerivativesAndHedgingShortTerm :: Maybe Integer
• deferredTaxLiabilitiesShortTerm :: Maybe Integer
• liabilitiesfromDiscontinuedOperationsShortTerm :: Maybe Integer
• miscShortTermLiabilities :: Maybe Integer
• totalCurrentLiabilities :: Maybe Integer
• longTermDebt :: Maybe Integer
• longTermBorrowings :: Maybe Integer
• longTermCapitalLeases :: Maybe Integer
• otherLongTermLiabilities :: Maybe Integer
• accruedLiabilities :: Maybe Integer
• pensionLiabilities :: Maybe Integer
• pensions :: Maybe Integer
• otherPostRetirementBenefits :: Maybe Integer
• deferredCompensation :: Maybe Integer
• deferredRevenueLongTerm :: Maybe Integer
• deferredTaxLiabilitiesLongTerm :: Maybe Integer
• liabilitiesfromDerivativesAndHedgingLongTerm :: Maybe Integer
• liabilitiesfromDiscontinuedOperationsLongTerm :: Maybe Integer
• miscLongTermLiabilities :: Maybe Integer
• totalNoncurrentLiabilities :: Maybe Integer
• totalLiabilities :: Maybe Integer
• preferredEquity :: Maybe Integer
• shareCapitalAndAdditionalPaidInCapital :: Maybe Integer
• commonStock :: Maybe Integer
• additionalPaidinCapital :: Maybe Integer
• otherShareCapital :: Maybe Integer
• treasuryStock :: Maybe Integer
• retainedEarnings :: Maybe Integer
• otherEquity :: Maybe Integer
• equityBeforeMinorityInterest :: Maybe Integer
• minorityInterest :: Maybe Integer
• totalEquity :: Maybe Integer
• totalLiabilitiesAndEquity :: Maybe Integer

Instances

Show GeneralBalanceSheetRow

Defined in SimFin.Types.BalanceSheet

Methods

showsPrec :: Int -> GeneralBalanceSheetRow -> ShowS

show :: GeneralBalanceSheetRow -> String

showList :: [GeneralBalanceSheetRow] -> ShowS

FromJSON IndustryBalanceSheets

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser IndustryBalanceSheets

parseJSONList :: Value -> Parser [IndustryBalanceSheets]

FromJSON GeneralBalanceSheetRow

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser GeneralBalanceSheetRow

parseJSONList :: Value -> Parser [GeneralBalanceSheetRow]

data BankBalanceSheetRow

Balance sheet statement for banks.

Constructors

BankBalanceSheetRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• cashCashEquivalentsAndShortTermInvestments :: Maybe Integer
• interbankAssets :: Maybe Integer
• fedFundsSoldAndRepos :: Maybe Integer
• otherInterbankAssets :: Maybe Integer
• shortAndLongTermInvestments :: Maybe Integer
• tradingSecurities :: Maybe Integer
• investmentSecuritiesAvailableforSale :: Maybe Integer
• investmentSecuritiesHeldtoMaturity :: Maybe Integer
• realEstateInvestments :: Maybe Integer
• otherInvestments :: Maybe Integer
• accountsAndNotesReceivable :: Maybe Integer
• netLoans :: Maybe Integer
• reserveforLoanLosses :: Maybe Integer
• totalLoans :: Maybe Integer
• totalCommercialLoans :: Maybe Integer
• commercialRealEstateLoans :: Maybe Integer
• otherCommercialLoans :: Maybe Integer
• totalConsumerLoans :: Maybe Integer
• creditCardLoans :: Maybe Integer
• homeEquityLoans :: Maybe Integer
• familyResidentialLoans :: Maybe Integer
• autoLoans :: Maybe Integer
• studentLoans :: Maybe Integer
• otherConsumerLoans :: Maybe Integer
• otherLoans :: Maybe Integer
• netFixedAssets :: Maybe Integer
• propertyPlantAndEquipmentNet :: Maybe Integer
• operatingLeaseAssets :: Maybe Integer
• otherFixedAssets :: Maybe Integer
• intangibleAssets :: Maybe Integer
• goodwill :: Maybe Integer
• otherIntangibleAssets :: Maybe Integer
• investmentsInAssociates :: Maybe Integer
• deferredTaxAssetsShortTerm :: Maybe Integer
• derivativesAndHedgingAssets :: Maybe Integer
• discontinuedOperationsAssets :: Maybe Integer
• customerAcceptancesAndLiabilities :: Maybe Integer
• otherAssets :: Maybe Integer
• totalAssets :: Maybe Integer
• totalDeposits :: Maybe Integer
• demandDeposits :: Maybe Integer
• interestBearingDeposits :: Maybe Integer
• savingDeposits :: Maybe Integer
• timeDeposits :: Maybe Integer
• otherDeposits :: Maybe Integer
• shortTermDebt :: Maybe Integer
• securitiesSoldUnderRepo :: Maybe Integer
• tradingAccountLiabilities :: Maybe Integer
• shortTermCapitalLeases :: Maybe Integer
• currentPortionofLongTermDebt :: Maybe Integer
• shortTermBorrowings :: Maybe Integer
• payablesBrokerDealers :: Maybe Integer
• longTermDebt :: Maybe Integer
• longTermCapitalLeases :: Maybe Integer
• longTermBorrowings :: Maybe Integer
• pensionLiabilities :: Maybe Integer
• pensions :: Maybe Integer
• otherPostRetirementBenefits :: Maybe Integer
• deferredTaxLiabilitiesShortTerm :: Maybe Integer
• derivativesAndHedgingLiabilities :: Maybe Integer
• discontinuedOperationsLiabilities :: Maybe Integer
• otherLiabilities :: Maybe Integer
• totalLiabilities :: Maybe Integer
• preferredEquity :: Maybe Integer
• shareCapitalAndAdditionalPaidInCapital :: Maybe Integer
• commonStock :: Maybe Integer
• additionalPaidInCapital :: Maybe Integer
• otherShareCapital :: Maybe Integer
• treasuryStock :: Maybe Integer
• retainedEarnings :: Maybe Integer
• otherEquity :: Maybe Integer
• equityBeforeMinorityInterest :: Maybe Integer
• minorityInterest :: Maybe Integer
• totalEquity :: Maybe Integer
• totalLiabilitiesAndEquity :: Maybe Integer

Instances

Show BankBalanceSheetRow

Defined in SimFin.Types.BalanceSheet

Methods

showsPrec :: Int -> BankBalanceSheetRow -> ShowS

show :: BankBalanceSheetRow -> String

showList :: [BankBalanceSheetRow] -> ShowS

FromJSON IndustryBalanceSheets

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser IndustryBalanceSheets

parseJSONList :: Value -> Parser [IndustryBalanceSheets]

FromJSON BankBalanceSheetRow

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser BankBalanceSheetRow

parseJSONList :: Value -> Parser [BankBalanceSheetRow]

data InsuranceBalanceSheetRow

Balance sheet statement for insurance companies.

Constructors

InsuranceBalanceSheetRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• totalInvestments :: Maybe Integer
• fixedIncomeTradingAFSAndShortTermInv :: Maybe Integer
• loansAndMortgages :: Maybe Integer
• fixedIncomeSecuritiesHTM :: Maybe Integer
• equitySecurities :: Maybe Integer
• realEstateInvestments :: Maybe Integer
• otherInvestments :: Maybe Integer
• cashCashEquivalentsAndShortTermInvestments :: Maybe Integer
• accountsAndNotesReceivable :: Maybe Integer
• propertyPlantAndEquipmentNet :: Maybe Integer
• deferredPolicyAcquisitionCosts :: Maybe Integer
• otherAssets :: Maybe Integer
• totalAssets :: Maybe Integer
• insuranceReserves :: Maybe Integer
• reserveForOutstandingClaimsAndLosses :: Maybe Integer
• premiumReserveUnearned :: Maybe Integer
• lifePolicyBenefits :: Maybe Integer
• otherInsuranceReserves :: Maybe Integer
• shortTermDebt :: Maybe Integer
• otherShortTermLiabilities :: Maybe Integer
• longTermDebt :: Maybe Integer
• pensionLiabilities :: Maybe Integer
• pensions :: Maybe Integer
• otherPostRetirementBenefits :: Maybe Integer
• otherLongTermLiabilities :: Maybe Integer
• fundsForFutureAppropriations :: Maybe Integer
• totalLiabilities :: Maybe Integer
• preferredEquity :: Maybe Integer
• policyholdersEquity :: Maybe Integer
• shareCapitalAndAdditionalPaidInCapital :: Maybe Integer
• commonStock :: Maybe Integer
• additionalPaidInCapital :: Maybe Integer
• otherShareCapital :: Maybe Integer
• treasuryStock :: Maybe Integer
• retainedEarnings :: Maybe Integer
• otherEquity :: Maybe Integer
• equityBeforeMinorityInterest :: Maybe Integer
• minorityInterest :: Maybe Integer
• totalEquity :: Maybe Integer
• totalLiabilitiesAndEquity :: Maybe Integer

Instances

Show InsuranceBalanceSheetRow

Defined in SimFin.Types.BalanceSheet

Methods

showsPrec :: Int -> InsuranceBalanceSheetRow -> ShowS

show :: InsuranceBalanceSheetRow -> String

showList :: [InsuranceBalanceSheetRow] -> ShowS

FromJSON IndustryBalanceSheets

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser IndustryBalanceSheets

parseJSONList :: Value -> Parser [IndustryBalanceSheets]

FromJSON InsuranceBalanceSheetRow

Defined in SimFin.Types.BalanceSheet

Methods

parseJSON :: Value -> Parser InsuranceBalanceSheetRow

parseJSONList :: Value -> Parser [InsuranceBalanceSheetRow]

data GeneralProfitAndLossRow

Cash flow statement for general companies.

Constructors

GeneralProfitAndLossRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• revenue :: Maybe Integer
• salesAndServicesRevenue :: Maybe Integer
• financingRevenue :: Maybe Integer
• otherRevenue :: Maybe Integer
• costOfRevenue :: Maybe Integer
• costOfGoodsAndServices :: Maybe Integer
• costOfFinancingRevenue :: Maybe Integer
• costOfOtherRevenue :: Maybe Integer
• grossProfit :: Maybe Integer
• otherOperatingIncome :: Maybe Integer
• operatingExpenses :: Maybe Integer
• sellingGeneralAndAdministrative :: Maybe Integer
• sellingAndMarketing :: Maybe Integer
• generalAndAdministrative :: Maybe Integer
• researchAndDevelopment :: Maybe Integer
• depreciationAndAmortization :: Maybe Integer
• provisionForDoubtfulAccounts :: Maybe Integer
• otherOperatingExpenses :: Maybe Integer
• operatingIncomeLoss :: Maybe Integer
• nonOperatingIncomeLoss :: Maybe Integer
• interestExpenseNet :: Maybe Integer
• interestExpense :: Maybe Integer
• interestIncome :: Maybe Integer
• otherInvestmentIncomeLoss :: Maybe Integer
• foreignExchangeGainLoss :: Maybe Integer
• incomeLossFromAffiliates :: Maybe Integer
• otherNonOperatingIncomeLoss :: Maybe Integer
• pretaxIncomeLossAdj :: Maybe Integer
• abnormalGainsLosses :: Maybe Integer
• acquiredInProcessRAndD :: Maybe Integer
• mergerAndAcquisitionExpense :: Maybe Integer
• abnormalDerivatives :: Maybe Integer
• disposalOfAssets :: Maybe Integer
• earlyExtinguishmentOfDebt :: Maybe Integer
• assetWriteDown :: Maybe Integer
• impairmentOfGoodwillAndIntangibles :: Maybe Integer
• saleOfBusiness :: Maybe Integer
• legalSettlement :: Maybe Integer
• restructuringCharges :: Maybe Integer
• saleOfInvestmentsAndUnrealizedInvestments :: Maybe Integer
• insuranceSettlement :: Maybe Integer
• otherAbnormalItems :: Maybe Integer
• pretaxIncomeLoss :: Maybe Integer
• incomeTaxExpenseBenefitNet :: Maybe Integer
• currentIncomeTax :: Maybe Integer
• deferredIncomeTax :: Maybe Integer
• taxAllowanceCredit :: Maybe Integer
• incomeLossFromAffiliatesNetOfTaxes :: Maybe Integer
• incomeLossFromContinuingOperations :: Maybe Integer
• netExtraordinaryGainsLosses :: Maybe Integer
• discontinuedOperations :: Maybe Integer
• accountingChargesAndOther :: Maybe Integer
• incomeLossInclMinorityInterest :: Maybe Integer
• minorityInterest :: Maybe Integer
• netIncome :: Maybe Integer
• preferredDividends :: Maybe Integer
• otherAdjustments :: Maybe Integer
• netIncomeCommon :: Maybe Integer

Instances

Show GeneralProfitAndLossRow

Defined in SimFin.Types.ProfitAndLoss

Methods

showsPrec :: Int -> GeneralProfitAndLossRow -> ShowS

show :: GeneralProfitAndLossRow -> String

showList :: [GeneralProfitAndLossRow] -> ShowS

FromJSON IndustryProfitsAndLosses

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser IndustryProfitsAndLosses

parseJSONList :: Value -> Parser [IndustryProfitsAndLosses]

FromJSON GeneralProfitAndLossRow

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser GeneralProfitAndLossRow

parseJSONList :: Value -> Parser [GeneralProfitAndLossRow]

data BankProfitAndLossRow

Cash flow statement for banks.

Constructors

BankProfitAndLossRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• revenue :: Maybe Integer
• netInterestIncome :: Maybe Integer
• totalInterestIncome :: Maybe Integer
• totalInterestExpense :: Maybe Integer
• totalNonInterestIncome :: Maybe Integer
• tradingAccountProfitsLosses :: Maybe Integer
• investmentIncomeLoss :: Maybe Integer
• saleOfLoanIncomeLoss :: Maybe Integer
• commissionsAndFeesEarned :: Maybe Integer
• netOTTILossesRecognisedInEarnings :: Maybe Integer
• otherNonInterestIncome :: Maybe Integer
• provisionForLoanLosses :: Maybe Integer
• netRevenueAfterProvisions :: Maybe Integer
• totalNonInterestExpense :: Maybe Integer
• commissionsAndFeesPaid :: Maybe Integer
• otherOperatingExpenses :: Maybe Integer
• operatingIncomeLoss :: Maybe Integer
• nonOperatingIncomeLoss :: Maybe Integer
• incomeLossFromAffiliates :: Maybe Integer
• otherNonOperatingIncomeLoss :: Maybe Integer
• pretaxIncomeLossAdj :: Maybe Integer
• abnormalGainsLosses :: Maybe Integer
• debtValuationAdjustment :: Maybe Integer
• creditValuationAdjustment :: Maybe Integer
• mergerAndAcquisitionExpense :: Maybe Integer
• disposalOfAssets :: Maybe Integer
• earlyExtinguishmentOfDebt :: Maybe Integer
• assetWriteDown :: Maybe Integer
• impairmentOfGoodwillAndIntangibles :: Maybe Integer
• saleOfBusiness :: Maybe Integer
• legalSettlement :: Maybe Integer
• restructuringCharges :: Maybe Integer
• otherAbnormalItems :: Maybe Integer
• pretaxIncomeLoss :: Maybe Integer
• incomeTaxExpenseBenefitNet :: Maybe Integer
• currentIncomeTax :: Maybe Integer
• deferredIncomeTax :: Maybe Integer
• taxAllowanceCredit :: Maybe Integer
• incomeLossFromAffiliatesNetOfTaxes :: Maybe Integer
• incomeLossFromContinuingOperations :: Maybe Integer
• netExtraordinaryGainsLosses :: Maybe Integer
• discontinuedOperations :: Maybe Integer
• accountingChargesAndOther :: Maybe Integer
• incomeLossInclMinorityInterest :: Maybe Integer
• minorityInterest :: Maybe Integer
• netIncome :: Maybe Integer
• preferredDividends :: Maybe Integer
• otherAdjustments :: Maybe Integer
• netIncomeCommon :: Maybe Integer

Instances

Show BankProfitAndLossRow

Defined in SimFin.Types.ProfitAndLoss

Methods

showsPrec :: Int -> BankProfitAndLossRow -> ShowS

show :: BankProfitAndLossRow -> String

showList :: [BankProfitAndLossRow] -> ShowS

FromJSON IndustryProfitsAndLosses

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser IndustryProfitsAndLosses

parseJSONList :: Value -> Parser [IndustryProfitsAndLosses]

FromJSON BankProfitAndLossRow

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser BankProfitAndLossRow

parseJSONList :: Value -> Parser [BankProfitAndLossRow]

data InsuranceProfitAndLossRow

Cash flow statement for insurance companies.

Constructors

InsuranceProfitAndLossRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• revenue :: Maybe Integer
• netPremiumsEarned :: Maybe Integer
• investmentIncomeLoss :: Maybe Integer
• incomeFromRealEstate :: Maybe Integer
• otherOperatingIncome :: Maybe Integer
• policyChargesAndFees :: Maybe Integer
• totalRealizedInvestmentGains :: Maybe Integer
• totalOTTIRealized :: Maybe Integer
• otherRealizedInvestmentGains :: Maybe Integer
• otherIncome :: Maybe Integer
• totalClaimsAndLosses :: Maybe Integer
• claimsAndLosses :: Maybe Integer
• longTermCharges :: Maybe Integer
• otherClaimsAndLosses :: Maybe Integer
• underwritingExpenseAndAcquisitionCost :: Maybe Integer
• otherOperatingExpenses :: Maybe Integer
• operatingIncomeLoss :: Maybe Integer
• nonOperatingIncomeLoss :: Maybe Integer
• incomeLossFromAffiliates :: Maybe Integer
• interestExpenseNet :: Maybe Integer
• otherNonOperatingIncomeLoss :: Maybe Integer
• pretaxIncomeLossAdj :: Maybe Integer
• abnormalGainsLosses :: Maybe Integer
• mergerAndAcquisitionExpense :: Maybe Integer
• abnormalDerivatives :: Maybe Integer
• disposalOfAssets :: Maybe Integer
• earlyExtinguishmentOfDebt :: Maybe Integer
• assetWriteDown :: Maybe Integer
• impairmentOfGoodwillAndIntangibles :: Maybe Integer
• saleOfBusiness :: Maybe Integer
• legalSettlement :: Maybe Integer
• restructuringCharges :: Maybe Integer
• netInvestmentLosses :: Maybe Integer
• foreignExchange :: Maybe Integer
• otherAbnormalItems :: Maybe Integer
• pretaxIncomeLoss :: Maybe Integer
• incomeTaxExpenseBenefitNet :: Maybe Integer
• currentIncomeTax :: Maybe Integer
• deferredIncomeTax :: Maybe Integer
• taxAllowanceCredit :: Maybe Integer
• incomeLossFromAffiliatesNetOfTaxes :: Maybe Integer
• incomeLossFromContinuingOperations :: Maybe Integer
• netExtraordinaryGainsLosses :: Maybe Integer
• discontinuedOperations :: Maybe Integer
• accountingChargesAndOther :: Maybe Integer
• incomeLossInclMinorityInterest :: Maybe Integer
• minorityInterest :: Maybe Integer
• netIncome :: Maybe Integer
• preferredDividends :: Maybe Integer
• otherAdjustments :: Maybe Integer
• netIncomeCommon :: Maybe Integer

Instances

Show InsuranceProfitAndLossRow

Defined in SimFin.Types.ProfitAndLoss

Methods

showsPrec :: Int -> InsuranceProfitAndLossRow -> ShowS

show :: InsuranceProfitAndLossRow -> String

showList :: [InsuranceProfitAndLossRow] -> ShowS

FromJSON IndustryProfitsAndLosses

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser IndustryProfitsAndLosses

parseJSONList :: Value -> Parser [IndustryProfitsAndLosses]

FromJSON InsuranceProfitAndLossRow

Defined in SimFin.Types.ProfitAndLoss

Methods

parseJSON :: Value -> Parser InsuranceProfitAndLossRow

parseJSONList :: Value -> Parser [InsuranceProfitAndLossRow]

data GeneralCashFlowRow

Cash flow statement for general companies.

Constructors

GeneralCashFlowRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• netIncomeStartingLine :: Maybe Integer
• netIncome :: Maybe Integer
• netIncomeFromDiscontinuedOperations :: Maybe Integer
• otherAdjustmensts :: Maybe Integer
• depreciationAndAmortizatison :: Maybe Integer
• nonCashItems :: Maybe Integer
• stockBasedCompensatison :: Maybe Integer
• deferredIncomeTaxes :: Maybe Integer
• otherNonCashAdjustments :: Maybe Integer
• changeInWorkingCapital :: Maybe Integer
• changeInAccountsReceivable :: Maybe Integer
• changeInInventories :: Maybe Integer
• changeInAccountsPayable :: Maybe Integer
• changeInOther :: Maybe Integer
• netCashFromDiscontinuedOperationsOperating :: Maybe Integer
• netCashFromOpesratingActivities :: Maybe Integer
• changeInFixedAssetsAndIntsangibles :: Maybe Integer
• dispositionOfFixedAssetssAndIntangibles :: Maybe Integer
• dispositionOfFixedAsssets :: Maybe Integer
• dispositionOfIntangibleAssets :: Maybe Integer
• acquisitionOfFixedAssetsAndIntangibles :: Maybe Integer
• purchaseOfFixedAssets :: Maybe Integer
• acquisitionOfIntangibleAssets :: Maybe Integer
• otherChangeInFixedAssetsAndIntangibles :: Maybe Integer
• netChangeInLongTermInvestment :: Maybe Integer
• decreaseInLongTermInvestment :: Maybe Integer
• increaseInLongTermInvestment :: Maybe Integer
• netCashFromAcquisitionsAndDivestitures :: Maybe Integer
• netCashFromDivestitures :: Maybe Integer
• cashForAcquisitionOfSubsidiaries :: Maybe Integer
• cashForJointVentures :: Maybe Integer
• netCashFromOtherAcquisitions :: Maybe Integer
• otherInvestingActivities :: Maybe Integer
• netCashFromDiscontinuedOperationsInvesting :: Maybe Integer
• netCashFromInvestingActivities :: Maybe Integer
• dividendsPaid :: Maybe Integer
• cashFromRepaymentOfDebt :: Maybe Integer
• cashFromRepaymentOfShortTermDebtNet :: Maybe Integer
• cashFromRepaymentOfLongTermDebtNet :: Maybe Integer
• repaymentsOfLongTermDebt :: Maybe Integer
• cashFromLongTermDebt :: Maybe Integer
• cashFromRepurchaseOfEquity :: Maybe Integer
• increaseInCapitalStock :: Maybe Integer
• decreaseInCapitalStock :: Maybe Integer
• otherFinancingActivities :: Maybe Integer
• netCashFromDiscontinuedOperationsFinancing :: Maybe Integer
• netCashFromFinancingActivities :: Maybe Integer
• netCashBeforeDiscOperationsAndFX :: Maybe Integer
• changeInCashFromDiscOperationsAndOther :: Maybe Integer
• netCashBeforeFX :: Maybe Integer
• effectOfForeignExchangeRates :: Maybe Integer
• netChangeInCash :: Maybe Integer

Instances

Show GeneralCashFlowRow

Defined in SimFin.Types.CashFlow

Methods

showsPrec :: Int -> GeneralCashFlowRow -> ShowS

show :: GeneralCashFlowRow -> String

showList :: [GeneralCashFlowRow] -> ShowS

FromJSON IndustryCashFlows

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser IndustryCashFlows

parseJSONList :: Value -> Parser [IndustryCashFlows]

FromJSON GeneralCashFlowRow

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser GeneralCashFlowRow

parseJSONList :: Value -> Parser [GeneralCashFlowRow]

data BankCashFlowRow

Cash flow statement for banks.

Constructors

BankCashFlowRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• netIncomeStartingLine :: Maybe Integer
• netIncome :: Maybe Integer
• netIncomeFromDiscontinuedOperations :: Maybe Integer
• otherAdjustments :: Maybe Integer
• depreciationAndAmortization :: Maybe Integer
• provisionForLoanLosses :: Maybe Integer
• nonCashItems :: Maybe Integer
• gainOnSaleOfSecuritiesAndLoans :: Maybe Integer
• deferredIncomeTaxes :: Maybe Integer
• stockBasedCompensation :: Maybe Integer
• otherNonCashAdjustments :: Maybe Integer
• changeInWorkingCapital :: Maybe Integer
• tradingAssetsAndLiabilities :: Maybe Integer
• netChangeOfInvestments :: Maybe Integer
• netChangeOfInterbankAssets :: Maybe Integer
• netChangeOfInterbankLiabilities :: Maybe Integer
• netChangeInOperatingLoans :: Maybe Integer
• accruedInterestReceivable :: Maybe Integer
• accruedInterestPayable :: Maybe Integer
• otherOperatingAssetsLiabilities :: Maybe Integer
• netCashFromDiscontinuedOperationsOperating :: Maybe Integer
• netCashFromOperatingActivities :: Maybe Integer
• changeInFixedAssetsAndIntangibles :: Maybe Integer
• dispositionOfFixedAssetsAndIntangibles :: Maybe Integer
• capitalExpenditures :: Maybe Integer
• netChangeInInvestments :: Maybe Integer
• decreaseInInvestments :: Maybe Integer
• decreaseInHTMInvestments :: Maybe Integer
• decreaseInAFSInvestments :: Maybe Integer
• increaseInInvestments :: Maybe Integer
• increaseInHTMInvestments :: Maybe Integer
• increaseInAFSInvestments :: Maybe Integer
• netChangeInOtherInvestments :: Maybe Integer
• netChangeInLoansAndInterbank :: Maybe Integer
• netChangeInCustomerLoans :: Maybe Integer
• netChangeInInterbankAssets :: Maybe Integer
• netChangeInOtherLoans :: Maybe Integer
• netCashFromAcquisitionsAndDivestitures :: Maybe Integer
• netCashFromDivestitures :: Maybe Integer
• cashForAcquisitionOfSubsidiaries :: Maybe Integer
• cashForJointVentures :: Maybe Integer
• netCashFromOtherAcquisitions :: Maybe Integer
• otherInvestingActivities :: Maybe Integer
• netCashFromDiscontinuedOperationsInvesting :: Maybe Integer
• netCashFromInvestingActivities :: Maybe Integer
• dividendsPaid :: Maybe Integer
• cashFromRepaymentOfDebt :: Maybe Integer
• cashFromRepaymentOfShortTermDebtNet :: Maybe Integer
• netChangeInInterbankTransfers :: Maybe Integer
• cashFromRepaymentOfLongTermDebtNet :: Maybe Integer
• repaymentsOfLongTermDebt :: Maybe Integer
• cashFromLongTermDebt :: Maybe Integer
• cashFromRepurchaseOfEquity :: Maybe Integer
• increaseInCapitalStock :: Maybe Integer
• decreaseInCapitalStock :: Maybe Integer
• netChangeInDeposits :: Maybe Integer
• otherFinancingActivities :: Maybe Integer
• netCashFromDiscontinuedOperationsFinancing :: Maybe Integer
• netCashFromFinancingActivities :: Maybe Integer
• netCashBeforeDiscOperationsAndFX :: Maybe Integer
• changeInCashFromDiscOperationsAndOther :: Maybe Integer
• netCashBeforeFX :: Maybe Integer
• effectOfForeignExchangeRates :: Maybe Integer
• netChangeInCash :: Maybe Integer

Instances

Show BankCashFlowRow

Defined in SimFin.Types.CashFlow

Methods

showsPrec :: Int -> BankCashFlowRow -> ShowS

show :: BankCashFlowRow -> String

showList :: [BankCashFlowRow] -> ShowS

FromJSON IndustryCashFlows

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser IndustryCashFlows

parseJSONList :: Value -> Parser [IndustryCashFlows]

FromJSON BankCashFlowRow

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser BankCashFlowRow

parseJSONList :: Value -> Parser [BankCashFlowRow]

data InsuranceCashFlowRow

Cash flow statement for Insurance companies.

Constructors

InsuranceCashFlowRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: String
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• netIncomeStartingLine :: Maybe Integer
• netIncome :: Maybe Integer
• netIncomeFromDiscontinuedOperations :: Maybe Integer
• otherAdjustments :: Maybe Integer
• depreciationAndAmortization :: Maybe Integer
• nonCashItems :: Maybe Integer
• stockBasedCompensation :: Maybe Integer
• deferredIncomeTaxes :: Maybe Integer
• otherNonCashAdjustments :: Maybe Integer
• changeInWorkingCapital :: Maybe Integer
• netCashFromDiscontinuedOperationsOperating :: Maybe Integer
• netCashFromOperatingActivities :: Maybe Integer
• changeInFixedAssetsAndIntangibles :: Maybe Integer
• dispositionOfFixedAssetsAndIntangibles :: Maybe Integer
• acquisitionOfFixedAssetsAndIntangibles :: Maybe Integer
• netChangeInInvestments :: Maybe Integer
• increaseInInvestments :: Maybe Integer
• decreaseInInvestments :: Maybe Integer
• otherInvestingActivities :: Maybe Integer
• netCashFromDiscontinuedOperationsInvesting :: Maybe Integer
• netCashFromInvestingActivities :: Maybe Integer
• dividendsPaid :: Maybe Integer
• cashFromRepaymentOfDebt :: Maybe Integer
• cashFromRepaymentOfShortTermDebtNet :: Maybe Integer
• cashFromRepaymentOfLongTermDebtNet :: Maybe Integer
• repaymentsOfLongTermDebt :: Maybe Integer
• cashFromLongTermDebt :: Maybe Integer
• cashFromRepurchaseOfEquity :: Maybe Integer
• increaseInCapitalStock :: Maybe Integer
• decreaseInCapitalStock :: Maybe Integer
• changeInInsuranceReserves :: Maybe Integer
• otherFinancingActivities :: Maybe Integer
• netCashFromDiscontinuedOperationsFinancing :: Maybe Integer
• netCashFromFinancingActivities :: Maybe Integer
• netCashBeforeDiscOperationsAndFX :: Maybe Integer
• changeInCashFromDiscOperationsAndOther :: Maybe Integer
• netCashBeforeFX :: Maybe Integer
• effectOfForeignExchangeRates :: Maybe Integer
• netChangeInCash :: Maybe Integer

Instances

Show InsuranceCashFlowRow

Defined in SimFin.Types.CashFlow

Methods

showsPrec :: Int -> InsuranceCashFlowRow -> ShowS

show :: InsuranceCashFlowRow -> String

showList :: [InsuranceCashFlowRow] -> ShowS

FromJSON IndustryCashFlows

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser IndustryCashFlows

parseJSONList :: Value -> Parser [IndustryCashFlows]

FromJSON InsuranceCashFlowRow

Defined in SimFin.Types.CashFlow

Methods

parseJSON :: Value -> Parser InsuranceCashFlowRow

parseJSONList :: Value -> Parser [InsuranceCashFlowRow]

data DerivedRow a

Cash flow statement for general companies.

Constructors

DerivedRow

Fields

• simFinId :: Int
• ticker :: Text
• fiscalPeriod :: FiscalPeriod
• fiscalYear :: Int
• reportDate :: Day
• publishDate :: Day
• restatedDate :: Day
• source :: Text
• tTM :: Bool
• valueCheck :: Bool
• eBITDA :: Maybe a
• totalDebt :: Maybe a
• freeCashFlow :: Maybe a
• grossProfitMargin :: Maybe a
• operatingMargin :: Maybe a
• netProfitMargin :: Maybe a
• returnOnEquity :: Maybe a
• returnOnAssets :: Maybe a
• freeCashFlowToNetIncome :: Maybe a
• currentRatio :: Maybe a
• liabilitiesToEquityRatio :: Maybe a
• debtRatio :: Maybe a
• earningsPerShareBasic :: Maybe a
• earningsPerShareDiluted :: Maybe a
• salesPerShare :: Maybe a
• equityPerShare :: Maybe a
• freeCashFlowPerShare :: Maybe a
• dividendsPerShare :: Maybe a
• piotroskiFScore :: Maybe Int
• returnOnInvestedCapital :: Maybe a
• cashReturnOnInvestedCapital :: Maybe a
• dividendPayoutRatio :: Maybe a
• netDebtEBITDA :: Maybe a
• netDebtEBIT :: Maybe a

Instances

Functor DerivedRow

Defined in SimFin.Types.Derived

Methods

fmap :: (a -> b) -> DerivedRow a -> DerivedRow b

(<$) :: a -> DerivedRow b -> DerivedRow a

Show a => Show (DerivedRow a)

Defined in SimFin.Types.Derived

Methods

showsPrec :: Int -> DerivedRow a -> ShowS

show :: DerivedRow a -> String

showList :: [DerivedRow a] -> ShowS

(Read a, RealFrac a) => FromJSON (DerivedRow a)

Defined in SimFin.Types.Derived

Methods

parseJSON :: Value -> Parser (DerivedRow a)

parseJSONList :: Value -> Parser [DerivedRow a]

data PricesRow a

Prices of a company over a single day.

Constructors

PricesRow

Fields

• simFinId :: Int
• ticker :: Text
• date :: Maybe Day
• open :: a
• high :: a
• low :: a
• close :: a
• adjClose :: a
• volume :: Integer
• dividend :: Maybe a
• commonSharesOutstanding :: Maybe Integer

Instances

Functor PricesRow

Defined in SimFin.Types.Prices

Methods

fmap :: (a -> b) -> PricesRow a -> PricesRow b

(<$) :: a -> PricesRow b -> PricesRow a

Show a => Show (PricesRow a)

Defined in SimFin.Types.Prices

Methods

showsPrec :: Int -> PricesRow a -> ShowS

show :: PricesRow a -> String

showList :: [PricesRow a] -> ShowS

(Read a, RealFrac a) => FromJSON (PricesRow a)

Defined in SimFin.Types.Prices

Methods

parseJSON :: Value -> Parser (PricesRow a)

parseJSONList :: Value -> Parser [PricesRow a]

type PricesQueryFree = StockRef

Represents all the parameters available to free users.

data StatementQueryFree

This is a subset of the StatementQuery type, which models the parameters available to non-SimFin+ users.

Constructors

StatementQueryFree

Fields

• stockRef :: StockRef
• period :: FiscalPeriod
• year :: Int
• ttm :: Bool

data StockRef

A stock ref is a SimSin ID or a ticker.

Constructors

SimFinId Int

Ticker Text

Instances

Show StockRef

Defined in SimFin.Types.StockRef

Methods

showsPrec :: Int -> StockRef -> ShowS

show :: StockRef -> String

showList :: [StockRef] -> ShowS

IsString StockRef

Defined in SimFin.Types.StockRef

Methods

fromString :: String -> StockRef

data FiscalPeriod

A fiscal period as understood by the SimFin API.

Constructors

Q1

Q2

Q3

Q4

H1

H2

FullYear

FirstNineMonths

SixMonths

Instances

Eq FiscalPeriod

Defined in SimFin.Types.FiscalPeriod

Methods

(==) :: FiscalPeriod -> FiscalPeriod -> Bool

(/=) :: FiscalPeriod -> FiscalPeriod -> Bool

Show FiscalPeriod

Defined in SimFin.Types.FiscalPeriod

Methods

showsPrec :: Int -> FiscalPeriod -> ShowS

show :: FiscalPeriod -> String

showList :: [FiscalPeriod] -> ShowS

FromJSON FiscalPeriod

Defined in SimFin.Types.FiscalPeriod

Methods

parseJSON :: Value -> Parser FiscalPeriod

parseJSONList :: Value -> Parser [FiscalPeriod]

data ApiError

Represents all the types of error the server returns, and that we can encounter on our side.

Constructors

DecodeError ByteString String

Can't turn ByteString into JSON

ParseError Value String

Can't turn JSON into result type

Other Text

Server returned '{"error": "..."}' along with a non-200 status code. This could in theory be parsed into machine-readable format, with variants such as `InvalidApiKey | RateLimited | ...`, but the API doesn't guarantee error message stability.

Instances

Show ApiError

Defined in SimFin.Common

Methods

showsPrec :: Int -> ApiError -> ShowS

show :: ApiError -> String

showList :: [ApiError] -> ShowS

FromJSON ApiError

Defined in SimFin.Common

Methods

parseJSON :: Value -> Parser ApiError

parseJSONList :: Value -> Parser [ApiError]

type ApiResult = Either ApiError

The result of calling fetch* is either an error or a successful result.

createDefaultContext :: (MonadFail m, MonadIO m) => m SimFinContext

Try to make a new http-client manager, and parse your api key from apiKeyEnvVariable.

fetchCompanyList :: (MonadThrow m, MonadIO m) => SimFinContext -> m (Either ApiError [CompanyListingRow])

Fetch a list of company tickers and SimFin ids. This is the only endpoint common to free and paid customers.

fetchCompanyInfo :: (MonadThrow m, MonadIO m) => SimFinContext -> StockRef -> m (ApiResult (Maybe CompanyInfoRow))

Fetch general company information. See the SimFin docs.

fetchBalanceSheet :: (MonadThrow m, MonadIO m) => SimFinContext -> StatementQueryFree -> m (ApiResult (Maybe IndustryBalanceSheet))

Fetch a company's balance sheet statement. As this is the free API version, only one statement is returned. The returned statement's data is dependent on the company type. See the SimFin docs.

fetchProfitAndLoss :: (MonadThrow m, MonadIO m) => SimFinContext -> StatementQueryFree -> m (ApiResult (Maybe IndustryProfitAndLoss))

Fetch a company's profit and loss statement. As this is the free API version, only one statement is returned. The returned statement's data is dependent on the company type. See the SimFin docs.

fetchCashFlow :: (MonadThrow m, MonadIO m) => SimFinContext -> StatementQueryFree -> m (ApiResult (Maybe IndustryCashFlow))

Fetch a company's cash flow statement. As this is the free API version, only one statement is returned. The returned statement's data is dependent on the company type. See the SimFin docs.

fetchDerived :: forall m a. (Read a, RealFrac a, MonadThrow m, MonadIO m) => SimFinContext -> StatementQueryFree -> m (ApiResult (Maybe (DerivedRow a)))

Fetch a company's derived figures. As this is the free API version, only one set of data is returned. See the SimFin docs.

fetchPrices :: (Read a, RealFrac a, MonadThrow m, MonadIO m) => SimFinContext -> PricesQueryFree -> m (ApiResult [PricesRow a])

Fetch a company's historical share prices. See the SimFin docs.