File size: 50,792 Bytes
203c118 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 |
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional, Union
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated
class ROUTER_equity_compare(Container):
"""/equity/compare
company_facts
peers
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@exception_handler
@validate
def company_facts(
self,
symbol: Annotated[
Union[str, None, list[Optional[str]]],
OpenBBField(
description="Symbol to get data for. Multiple comma separated items allowed for provider(s): sec."
),
] = None,
fact: Annotated[
str,
OpenBBField(
description="The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.\nChoices for sec: 'AccountsPayableCurrent', 'AccountsReceivableNet', 'AccountsReceivableNetCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent', 'AccruedIncomeTaxesCurrent', 'AccruedIncomeTaxesNoncurrent', 'AccruedInsuranceCurrent', 'AccruedLiabilitiesCurrent', 'AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment', 'AccumulatedOtherComprehensiveIncomeLossNetOfTax', 'AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets', 'AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue', 'AdvertisingExpense', 'AllocatedShareBasedCompensationExpense', 'AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount', 'AssetImpairmentCharges', 'Assets', 'AssetsCurrent', 'AssetsNoncurrent', 'BuildingsAndImprovementsGross', 'CapitalLeaseObligationsCurrent', 'CapitalLeaseObligationsNoncurrent', 'Cash', 'CashAndCashEquivalentsAtCarryingValue', 'CashCashEquivalentsAndShortTermInvestments', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect', 'CommercialPaper', 'CommitmentsAndContingencies', 'CommonStockDividendsPerShareCashPaid', 'CommonStockDividendsPerShareDeclared', 'CommonStocksIncludingAdditionalPaidInCapital', 'ComprehensiveIncomeNetOfTax', 'ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest', 'ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest', 'ConstructionInProgressGross', 'ContractWithCustomerAssetNet', 'ContractWithCustomerLiability', 'ContractWithCustomerLiabilityCurrent', 'ContractWithCustomerLiabilityNoncurrent', 'CostOfGoodsAndServicesSold', 'CostOfRevenue', 'CurrentFederalTaxExpenseBenefit', 'CurrentForeignTaxExpenseBenefit', 'CurrentIncomeTaxExpenseBenefit', 'CurrentStateAndLocalTaxExpenseBenefit', 'DebtInstrumentFaceAmount', 'DebtInstrumentFairValue', 'DebtLongtermAndShorttermCombinedAmount', 'DeferredFederalIncomeTaxExpenseBenefit', 'DeferredForeignIncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit', 'DeferredIncomeTaxLiabilities', 'DeferredIncomeTaxLiabilitiesNet', 'DeferredIncomeTaxesAndTaxCredits', 'DeferredRevenue', 'DeferredTaxAssetsGross', 'DeferredTaxAssetsLiabilitiesNet', 'DeferredTaxAssetsNet', 'DeferredTaxLiabilities', 'DefinedContributionPlanCostRecognized', 'Depreciation', 'DepreciationAmortizationAndAccretionNet', 'DepreciationAmortizationAndOther', 'DepreciationAndAmortization', 'DepreciationDepletionAndAmortization', 'DerivativeCollateralObligationToReturnCash', 'DerivativeCollateralRightToReclaimCash', 'DerivativeFairValueOfDerivativeNet', 'DerivativeLiabilityCollateralRightToReclaimCashOffset', 'DerivativeNotionalAmount', 'DistributedEarnings', 'Dividends', 'DividendsCash', 'DividendsPayableAmountPerShare', 'DividendsPayableCurrent', 'EarningsPerShareBasic', 'EarningsPerShareDiluted', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'EmployeeRelatedLiabilitiesCurrent', 'EmployeeRelatedLiabilitiesCurrentAndNoncurrent', 'EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense', 'FinanceLeaseInterestExpense', 'FinanceLeaseInterestPaymentOnLiability', 'FinanceLeaseLiability', 'FinanceLeaseLiabilityCurrent', 'FinanceLeaseLiabilityNoncurrent', 'FinanceLeaseLiabilityPaymentsDue', 'FinanceLeaseLiabilityPaymentsDueAfterYearFive', 'FinanceLeaseLiabilityPaymentsDueNextTwelveMonths', 'FinanceLeaseLiabilityPaymentsDueYearFive', 'FinanceLeaseLiabilityPaymentsDueYearFour', 'FinanceLeaseLiabilityPaymentsDueYearThree', 'FinanceLeaseLiabilityPaymentsDueYearTwo', 'FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear', 'FinanceLeaseLiabilityUndiscountedExcessAmount', 'FinanceLeasePrincipalPayments', 'FinanceLeaseRightOfUseAsset', 'FinancingReceivableAllowanceForCreditLosses', 'FiniteLivedIntangibleAssetsNet', 'FixturesAndEquipmentGross', 'GainLossOnInvestments', 'GainLossOnInvestmentsAndDerivativeInstruments', 'GainLossOnSaleOfBusiness', 'GainsLossesOnExtinguishmentOfDebt', 'GeneralAndAdministrativeExpense', 'Goodwill', 'GrossProfit', 'ImpairmentOfIntangibleAssetsExcludingGoodwill', 'ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill', 'IncomeLossFromContinuingOperations', 'IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', 'IncomeLossFromContinuingOperationsPerBasicShare', 'IncomeLossFromContinuingOperationsPerDilutedShare', 'IncomeTaxExpenseBenefit', 'IncomeTaxesPaid', 'IncomeTaxesPaidNet', 'IncreaseDecreaseInAccountsAndOtherReceivables', 'IncreaseDecreaseInAccountsPayable', 'IncreaseDecreaseInAccountsReceivable', 'IncreaseDecreaseInAccruedIncomeTaxesPayable', 'IncreaseDecreaseInAccruedLiabilities', 'IncreaseDecreaseInAccruedTaxesPayable', 'IncreaseDecreaseInContractWithCustomerLiability', 'IncreaseDecreaseInDeferredIncomeTaxes', 'IncreaseDecreaseInInventories', 'IncreaseDecreaseInOtherCurrentAssets', 'IncreaseDecreaseInOtherCurrentLiabilities', 'IncreaseDecreaseInOtherNoncurrentAssets', 'IncreaseDecreaseInOtherNoncurrentLiabilities', 'IncreaseDecreaseInPensionPlanObligations', 'IncrementalCommonSharesAttributableToShareBasedPaymentArrangements', 'InterestAndDebtExpense', 'InterestExpenseDebt', 'InterestIncomeExpenseNet', 'InterestPaid', 'InterestPaidNet', 'InventoryNet', 'InvestmentIncomeInterest', 'Land', 'LeaseAndRentalExpense', 'LesseeOperatingLeaseLiabilityPaymentsDue', 'LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFour', 'LesseeOperatingLeaseLiabilityPaymentsDueYearThree', 'LesseeOperatingLeaseLiabilityPaymentsDueYearTwo', 'LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear', 'LettersOfCreditOutstandingAmount', 'Liabilities', 'LiabilitiesAndStockholdersEquity', 'LiabilitiesCurrent', 'LineOfCredit', 'LineOfCreditFacilityMaximumBorrowingCapacity', 'LongTermDebt', 'LongTermDebtCurrent', 'LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo', 'LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear', 'LongTermDebtNoncurrent', 'LongTermInvestments', 'LossContingencyEstimateOfPossibleLoss', 'MachineryAndEquipmentGross', 'MarketableSecuritiesCurrent', 'MarketableSecuritiesNoncurrent', 'MinorityInterest', 'NetCashProvidedByUsedInFinancingActivities', 'NetCashProvidedByUsedInInvestingActivities', 'NetCashProvidedByUsedInOperatingActivities', 'NetIncomeLoss', 'NetIncomeLossAttributableToNoncontrollingInterest', 'NetIncomeLossAttributableToNonredeemableNoncontrollingInterest', 'NetIncomeLossAttributableToRedeemableNoncontrollingInterest', 'NoncurrentAssets', 'NoncurrentAssets', 'NoninterestIncome', 'NonoperatingIncomeExpense', 'NotesReceivableNet', 'OperatingExpenses', 'OperatingIncomeLoss', 'OperatingLeaseCost', 'OperatingLeaseLiability', 'OperatingLeaseLiabilityCurrent', 'OperatingLeaseLiabilityNoncurrent', 'OperatingLeaseRightOfUseAsset', 'OtherAccruedLiabilitiesCurrent', 'OtherAssetsCurrent', 'OtherAssetsNoncurrent', 'OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax', 'OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossNetOfTax', 'OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent', 'OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax', 'OtherIncome', 'OtherLiabilitiesCurrent', 'OtherLiabilitiesNoncurrent', 'OtherLongTermDebt', 'OtherNoncashIncomeExpense', 'PaymentsForCapitalImprovements', 'PaymentsForProceedsFromBusinessesAndInterestInAffiliates', 'PaymentsForProceedsFromOtherInvestingActivities', 'PaymentsForRent', 'PaymentsForRepurchaseOfCommonStock', 'PaymentsOfDebtExtinguishmentCosts', 'PaymentsOfDividends', 'PaymentsOfDividendsMinorityInterest', 'PaymentsToAcquireInvestments', 'PaymentsToAcquirePropertyPlantAndEquipment', 'PreferredStockSharesOutstanding', 'PreferredStockValue', 'PrepaidExpenseAndOtherAssetsCurrent', 'PrepaidExpenseCurrent', 'ProceedsFromDebtMaturingInMoreThanThreeMonths', 'ProceedsFromDebtNetOfIssuanceCosts', 'ProceedsFromDivestitureOfBusinesses', 'ProceedsFromInvestments', 'ProceedsFromIssuanceOfCommonStock', 'ProceedsFromIssuanceOfDebt', 'ProceedsFromIssuanceOfLongTermDebt', 'ProceedsFromIssuanceOfUnsecuredDebt', 'ProceedsFromIssuanceOrSaleOfEquity', 'ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities', 'ProceedsFromPaymentsForOtherFinancingActivities', 'ProceedsFromPaymentsToMinorityShareholders', 'ProceedsFromRepaymentsOfShortTermDebt', 'ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess', 'ProceedsFromSaleOfPropertyPlantAndEquipment', 'ProceedsFromStockOptionsExercised', 'ProfitLoss', 'PropertyPlantAndEquipmentGross', 'PropertyPlantAndEquipmentNet', 'ReceivablesNetCurrent', 'RedeemableNoncontrollingInterestEquityCarryingAmount', 'RepaymentsOfDebtMaturingInMoreThanThreeMonths', 'RepaymentsOfLongTermDebt', 'ResearchAndDevelopmentExpense', 'RestrictedCash', 'RestrictedCashAndCashEquivalents', 'RestrictedStockExpense', 'RestructuringCharges', 'RetainedEarningsAccumulatedDeficit', 'RevenueFromContractWithCustomerExcludingAssessedTax', 'Revenues', 'SecuredLongTermDebt', 'SellingAndMarketingExpense', 'SellingGeneralAndAdministrativeExpense', 'ShareBasedCompensation', 'ShortTermBorrowings', 'ShortTermInvestments', 'StockIssuedDuringPeriodValueNewIssues', 'StockOptionPlanExpense', 'StockRedeemedOrCalledDuringPeriodValue', 'StockRepurchasedAndRetiredDuringPeriodValue', 'StockRepurchasedDuringPeriodValue', 'StockholdersEquity', 'StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest', 'StockholdersEquityOther', 'TaxesPayableCurrent', 'TradingSecuritiesDebt', 'TreasuryStockAcquiredAverageCostPerShare', 'TreasuryStockSharesAcquired', 'UnrealizedGainLossOnInvestments', 'UnrecognizedTaxBenefits', 'UnsecuredDebt', 'VariableLeaseCost', 'WeightedAverageNumberDilutedSharesOutstandingAdjustment', 'WeightedAverageNumberOfDilutedSharesOutstanding', 'WeightedAverageNumberOfSharesOutstandingBasic'"
),
] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Compare reported company facts and fundamental data points.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
symbol : Union[str, None, list[Optional[str]]]
Symbol to get data for. Multiple comma separated items allowed for provider(s): sec.
fact : str
The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.
Choices for sec: 'AccountsPayableCurrent', 'AccountsReceivableNet', 'AccountsReceivableNetCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent', 'AccruedIncomeTaxesCurrent', 'AccruedIncomeTaxesNoncurrent', 'AccruedInsuranceCurrent', 'AccruedLiabilitiesCurrent', 'AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment', 'AccumulatedOtherComprehensiveIncomeLossNetOfTax', 'AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets', 'AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue', 'AdvertisingExpense', 'AllocatedShareBasedCompensationExpense', 'AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount', 'AssetImpairmentCharges', 'Assets', 'AssetsCurrent', 'AssetsNoncurrent', 'BuildingsAndImprovementsGross', 'CapitalLeaseObligationsCurrent', 'CapitalLeaseObligationsNoncurrent', 'Cash', 'CashAndCashEquivalentsAtCarryingValue', 'CashCashEquivalentsAndShortTermInvestments', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect', 'CommercialPaper', 'CommitmentsAndContingencies', 'CommonStockDividendsPerShareCashPaid', 'CommonStockDividendsPerShareDeclared', 'CommonStocksIncludingAdditionalPaidInCapital', 'ComprehensiveIncomeNetOfTax', 'ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest', 'ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest', 'ConstructionInProgressGross', 'ContractWithCustomerAssetNet', 'ContractWithCustomerLiability', 'ContractWithCustomerLiabilityCurrent', 'ContractWithCustomerLiabilityNoncurrent', 'CostOfGoodsAndServicesSold', 'CostOfRevenue', 'CurrentFederalTaxExpenseBenefit', 'CurrentForeignTaxExpenseBenefit', 'CurrentIncomeTaxExpenseBenefit', 'CurrentStateAndLocalTaxExpenseBenefit', 'DebtInstrumentFaceAmount', 'DebtInstrumentFairValue', 'DebtLongtermAndShorttermCombinedAmount', 'DeferredFederalIncomeTaxExpenseBenefit', 'DeferredForeignIncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit', 'DeferredIncomeTaxLiabilities', 'DeferredIncomeTaxLiabilitiesNet', 'DeferredIncomeTaxesAndTaxCredits', 'DeferredRevenue', 'DeferredTaxAssetsGross', 'DeferredTaxAssetsLiabilitiesNet', 'DeferredTaxAssetsNet', 'DeferredTaxLiabilities', 'DefinedContributionPlanCostRecognized', 'Depreciation', 'DepreciationAmortizationAndAccretionNet', 'DepreciationAmortizationAndOther', 'DepreciationAndAmortization', 'DepreciationDepletionAndAmortization', 'DerivativeCollateralObligationToReturnCash', 'DerivativeCollateralRightToReclaimCash', 'DerivativeFairValueOfDerivativeNet', 'DerivativeLiabilityCollateralRightToReclaimCashOffset', 'DerivativeNotionalAmount', 'DistributedEarnings', 'Dividends', 'DividendsCash', 'DividendsPayableAmountPerShare', 'DividendsPayableCurrent', 'EarningsPerShareBasic', 'EarningsPerShareDiluted', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'EmployeeRelatedLiabilitiesCurrent', 'EmployeeRelatedLiabilitiesCurrentAndNoncurrent', 'EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense', 'FinanceLeaseInterestExpense', 'FinanceLeaseInterestPaymentOnLiability', 'FinanceLeaseLiability', 'FinanceLeaseLiabilityCurrent', 'FinanceLeaseLiabilityNoncurrent', 'FinanceLeaseLiabilityPaymentsDue', 'FinanceLeaseLiabilityPaymentsDueAfterYearFive', 'FinanceLeaseLiabilityPaymentsDueNextTwelveMonths', 'FinanceLeaseLiabilityPaymentsDueYearFive', 'FinanceLeaseLiabilityPaymentsDueYearFour', 'FinanceLeaseLiabilityPaymentsDueYearThree', 'FinanceLeaseLiabilityPaymentsDueYearTwo', 'FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear', 'FinanceLeaseLiabilityUndiscountedExcessAmount', 'FinanceLeasePrincipalPayments', 'FinanceLeaseRightOfUseAsset', 'FinancingReceivableAllowanceForCreditLosses', 'FiniteLivedIntangibleAssetsNet', 'FixturesAndEquipmentGross', 'GainLossOnInvestments', 'GainLossOnInvestmentsAndDerivativeInstruments', 'GainLossOnSaleOfBusiness', 'GainsLossesOnExtinguishmentOfDebt', 'GeneralAndAdministrativeExpense', 'Goodwill', 'GrossProfit', 'ImpairmentOfIntangibleAssetsExcludingGoodwill', 'ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill', 'IncomeLossFromContinuingOperations', 'IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', 'IncomeLossFromContinuingOperationsPerBasicShare', 'IncomeLossFromContinuingOperationsPerDilutedShare', 'IncomeTaxExpenseBenefit', 'IncomeTaxesPaid', 'IncomeTaxesPaidNet', 'IncreaseDecreaseInAccountsAndOtherReceivables', 'IncreaseDecreaseInAccountsPayable', 'IncreaseDecreaseInAccountsReceivable', 'IncreaseDecreaseInAccruedIncomeTaxesPayable', 'IncreaseDecreaseInAccruedLiabilities', 'IncreaseDecreaseInAccruedTaxesPayable', 'IncreaseDecreaseInContractWithCustomerLiability', 'IncreaseDecreaseInDeferredIncomeTaxes', 'IncreaseDecreaseInInventories', 'IncreaseDecreaseInOtherCurrentAssets', 'IncreaseDecreaseInOtherCurrentLiabilities', 'IncreaseDecreaseInOtherNoncurrentAssets', 'IncreaseDecreaseInOtherNoncurrentLiabilities', 'IncreaseDecreaseInPensionPlanObligations', 'IncrementalCommonSharesAttributableToShareBasedPaymentArrangements', 'InterestAndDebtExpense', 'InterestExpenseDebt', 'InterestIncomeExpenseNet', 'InterestPaid', 'InterestPaidNet', 'InventoryNet', 'InvestmentIncomeInterest', 'Land', 'LeaseAndRentalExpense', 'LesseeOperatingLeaseLiabilityPaymentsDue', 'LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFour', 'LesseeOperatingLeaseLiabilityPaymentsDueYearThree', 'LesseeOperatingLeaseLiabilityPaymentsDueYearTwo', 'LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear', 'LettersOfCreditOutstandingAmount', 'Liabilities', 'LiabilitiesAndStockholdersEquity', 'LiabilitiesCurrent', 'LineOfCredit', 'LineOfCreditFacilityMaximumBorrowingCapacity', 'LongTermDebt', 'LongTermDebtCurrent', 'LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo', 'LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear', 'LongTermDebtNoncurrent', 'LongTermInvestments', 'LossContingencyEstimateOfPossibleLoss', 'MachineryAndEquipmentGross', 'MarketableSecuritiesCurrent', 'MarketableSecuritiesNoncurrent', 'MinorityInterest', 'NetCashProvidedByUsedInFinancingActivities', 'NetCashProvidedByUsedInInvestingActivities', 'NetCashProvidedByUsedInOperatingActivities', 'NetIncomeLoss', 'NetIncomeLossAttributableToNoncontrollingInterest', 'NetIncomeLossAttributableToNonredeemableNoncontrollingInterest', 'NetIncomeLossAttributableToRedeemableNoncontrollingInterest', 'NoncurrentAssets', 'NoncurrentAssets', 'NoninterestIncome', 'NonoperatingIncomeExpense', 'NotesReceivableNet', 'OperatingExpenses', 'OperatingIncomeLoss', 'OperatingLeaseCost', 'OperatingLeaseLiability', 'OperatingLeaseLiabilityCurrent', 'OperatingLeaseLiabilityNoncurrent', 'OperatingLeaseRightOfUseAsset', 'OtherAccruedLiabilitiesCurrent', 'OtherAssetsCurrent', 'OtherAssetsNoncurrent', 'OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax', 'OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossNetOfTax', 'OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent', 'OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax', 'OtherIncome', 'OtherLiabilitiesCurrent', 'OtherLiabilitiesNoncurrent', 'OtherLongTermDebt', 'OtherNoncashIncomeExpense', 'PaymentsForCapitalImprovements', 'PaymentsForProceedsFromBusinessesAndInterestInAffiliates', 'PaymentsForProceedsFromOtherInvestingActivities', 'PaymentsForRent', 'PaymentsForRepurchaseOfCommonStock', 'PaymentsOfDebtExtinguishmentCosts', 'PaymentsOfDividends', 'PaymentsOfDividendsMinorityInterest', 'PaymentsToAcquireInvestments', 'PaymentsToAcquirePropertyPlantAndEquipment', 'PreferredStockSharesOutstanding', 'PreferredStockValue', 'PrepaidExpenseAndOtherAssetsCurrent', 'PrepaidExpenseCurrent', 'ProceedsFromDebtMaturingInMoreThanThreeMonths', 'ProceedsFromDebtNetOfIssuanceCosts', 'ProceedsFromDivestitureOfBusinesses', 'ProceedsFromInvestments', 'ProceedsFromIssuanceOfCommonStock', 'ProceedsFromIssuanceOfDebt', 'ProceedsFromIssuanceOfLongTermDebt', 'ProceedsFromIssuanceOfUnsecuredDebt', 'ProceedsFromIssuanceOrSaleOfEquity', 'ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities', 'ProceedsFromPaymentsForOtherFinancingActivities', 'ProceedsFromPaymentsToMinorityShareholders', 'ProceedsFromRepaymentsOfShortTermDebt', 'ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess', 'ProceedsFromSaleOfPropertyPlantAndEquipment', 'ProceedsFromStockOptionsExercised', 'ProfitLoss', 'PropertyPlantAndEquipmentGross', 'PropertyPlantAndEquipmentNet', 'ReceivablesNetCurrent', 'RedeemableNoncontrollingInterestEquityCarryingAmount', 'RepaymentsOfDebtMaturingInMoreThanThreeMonths', 'RepaymentsOfLongTermDebt', 'ResearchAndDevelopmentExpense', 'RestrictedCash', 'RestrictedCashAndCashEquivalents', 'RestrictedStockExpense', 'RestructuringCharges', 'RetainedEarningsAccumulatedDeficit', 'RevenueFromContractWithCustomerExcludingAssessedTax', 'Revenues', 'SecuredLongTermDebt', 'SellingAndMarketingExpense', 'SellingGeneralAndAdministrativeExpense', 'ShareBasedCompensation', 'ShortTermBorrowings', 'ShortTermInvestments', 'StockIssuedDuringPeriodValueNewIssues', 'StockOptionPlanExpense', 'StockRedeemedOrCalledDuringPeriodValue', 'StockRepurchasedAndRetiredDuringPeriodValue', 'StockRepurchasedDuringPeriodValue', 'StockholdersEquity', 'StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest', 'StockholdersEquityOther', 'TaxesPayableCurrent', 'TradingSecuritiesDebt', 'TreasuryStockAcquiredAverageCostPerShare', 'TreasuryStockSharesAcquired', 'UnrealizedGainLossOnInvestments', 'UnrecognizedTaxBenefits', 'UnsecuredDebt', 'VariableLeaseCost', 'WeightedAverageNumberDilutedSharesOutstandingAdjustment', 'WeightedAverageNumberOfDilutedSharesOutstanding', 'WeightedAverageNumberOfSharesOutstandingBasic'
year : Optional[int]
The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec)
fiscal_period : Optional[Literal['fy', 'q1', 'q2', 'q3', 'q4']]
The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec)
instantaneous : bool
Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.
The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec)
use_cache : bool
Whether to use cache for the request. Defaults to True. (provider: sec)
Returns
-------
OBBject
results : list[CompareCompanyFacts]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
CompareCompanyFacts
-------------------
symbol : Optional[str]
Symbol representing the entity requested in the data.
name : Optional[str]
Name of the entity.
value : float
The reported value of the fact or concept.
reported_date : Optional[date]
The date when the report was filed.
period_beginning : Optional[date]
The start date of the reporting period.
period_ending : Optional[date]
The end date of the reporting period.
fiscal_year : Optional[int]
The fiscal year.
fiscal_period : Optional[str]
The fiscal period of the fiscal year.
cik : Optional[Union[int, str]]
Central Index Key (CIK) for the requested entity. (provider: sec)
location : Optional[str]
Geographic location of the reporting entity. (provider: sec)
form : Optional[str]
The SEC form associated with the fact or concept. (provider: sec)
frame : Optional[str]
The frame ID associated with the fact or concept, if applicable. (provider: sec)
accession : Optional[str]
SEC filing accession number associated with the reported fact or concept. (provider: sec)
fact : Optional[str]
The display name of the fact or concept. (provider: sec)
unit : Optional[str]
The unit of measurement for the fact or concept. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.equity.compare.company_facts(provider='sec')
>>> obb.equity.compare.company_facts(provider='sec', fact='PaymentsForRepurchaseOfCommonStock', year=2023)
>>> obb.equity.compare.company_facts(provider='sec', symbol='NVDA,AAPL,AMZN,MSFT,GOOG,SMCI', fact='RevenueFromContractWithCustomerExcludingAssessedTax', year=2024)
""" # noqa: E501
return self._run(
"/equity/compare/company_facts",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.compare.company_facts",
("sec",),
)
},
standard_params={
"symbol": symbol,
"fact": fact,
},
extra_params=kwargs,
info={
"symbol": {
"sec": {"multiple_items_allowed": True, "choices": None}
},
"fact": {
"sec": {
"multiple_items_allowed": False,
"choices": [
"AccountsPayableCurrent",
"AccountsReceivableNet",
"AccountsReceivableNetCurrent",
"AccrualForTaxesOtherThanIncomeTaxesCurrent",
"AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent",
"AccruedIncomeTaxesCurrent",
"AccruedIncomeTaxesNoncurrent",
"AccruedInsuranceCurrent",
"AccruedLiabilitiesCurrent",
"AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment",
"AccumulatedOtherComprehensiveIncomeLossNetOfTax",
"AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets",
"AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue",
"AdvertisingExpense",
"AllocatedShareBasedCompensationExpense",
"AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount",
"AssetImpairmentCharges",
"Assets",
"AssetsCurrent",
"AssetsNoncurrent",
"BuildingsAndImprovementsGross",
"CapitalLeaseObligationsCurrent",
"CapitalLeaseObligationsNoncurrent",
"Cash",
"CashAndCashEquivalentsAtCarryingValue",
"CashCashEquivalentsAndShortTermInvestments",
"CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents",
"CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations",
"CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect",
"CommercialPaper",
"CommitmentsAndContingencies",
"CommonStockDividendsPerShareCashPaid",
"CommonStockDividendsPerShareDeclared",
"CommonStocksIncludingAdditionalPaidInCapital",
"ComprehensiveIncomeNetOfTax",
"ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest",
"ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest",
"ConstructionInProgressGross",
"ContractWithCustomerAssetNet",
"ContractWithCustomerLiability",
"ContractWithCustomerLiabilityCurrent",
"ContractWithCustomerLiabilityNoncurrent",
"CostOfGoodsAndServicesSold",
"CostOfRevenue",
"CurrentFederalTaxExpenseBenefit",
"CurrentForeignTaxExpenseBenefit",
"CurrentIncomeTaxExpenseBenefit",
"CurrentStateAndLocalTaxExpenseBenefit",
"DebtInstrumentFaceAmount",
"DebtInstrumentFairValue",
"DebtLongtermAndShorttermCombinedAmount",
"DeferredFederalIncomeTaxExpenseBenefit",
"DeferredForeignIncomeTaxExpenseBenefit",
"DeferredIncomeTaxExpenseBenefit",
"DeferredIncomeTaxLiabilities",
"DeferredIncomeTaxLiabilitiesNet",
"DeferredIncomeTaxesAndTaxCredits",
"DeferredRevenue",
"DeferredTaxAssetsGross",
"DeferredTaxAssetsLiabilitiesNet",
"DeferredTaxAssetsNet",
"DeferredTaxLiabilities",
"DefinedContributionPlanCostRecognized",
"Depreciation",
"DepreciationAmortizationAndAccretionNet",
"DepreciationAmortizationAndOther",
"DepreciationAndAmortization",
"DepreciationDepletionAndAmortization",
"DerivativeCollateralObligationToReturnCash",
"DerivativeCollateralRightToReclaimCash",
"DerivativeFairValueOfDerivativeNet",
"DerivativeLiabilityCollateralRightToReclaimCashOffset",
"DerivativeNotionalAmount",
"DistributedEarnings",
"Dividends",
"DividendsCash",
"DividendsPayableAmountPerShare",
"DividendsPayableCurrent",
"EarningsPerShareBasic",
"EarningsPerShareDiluted",
"EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents",
"EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations",
"EmployeeRelatedLiabilitiesCurrent",
"EmployeeRelatedLiabilitiesCurrentAndNoncurrent",
"EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense",
"FinanceLeaseInterestExpense",
"FinanceLeaseInterestPaymentOnLiability",
"FinanceLeaseLiability",
"FinanceLeaseLiabilityCurrent",
"FinanceLeaseLiabilityNoncurrent",
"FinanceLeaseLiabilityPaymentsDue",
"FinanceLeaseLiabilityPaymentsDueAfterYearFive",
"FinanceLeaseLiabilityPaymentsDueNextTwelveMonths",
"FinanceLeaseLiabilityPaymentsDueYearFive",
"FinanceLeaseLiabilityPaymentsDueYearFour",
"FinanceLeaseLiabilityPaymentsDueYearThree",
"FinanceLeaseLiabilityPaymentsDueYearTwo",
"FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear",
"FinanceLeaseLiabilityUndiscountedExcessAmount",
"FinanceLeasePrincipalPayments",
"FinanceLeaseRightOfUseAsset",
"FinancingReceivableAllowanceForCreditLosses",
"FiniteLivedIntangibleAssetsNet",
"FixturesAndEquipmentGross",
"GainLossOnInvestments",
"GainLossOnInvestmentsAndDerivativeInstruments",
"GainLossOnSaleOfBusiness",
"GainsLossesOnExtinguishmentOfDebt",
"GeneralAndAdministrativeExpense",
"Goodwill",
"GrossProfit",
"ImpairmentOfIntangibleAssetsExcludingGoodwill",
"ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill",
"IncomeLossFromContinuingOperations",
"IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity",
"IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest",
"IncomeLossFromContinuingOperationsPerBasicShare",
"IncomeLossFromContinuingOperationsPerDilutedShare",
"IncomeTaxExpenseBenefit",
"IncomeTaxesPaid",
"IncomeTaxesPaidNet",
"IncreaseDecreaseInAccountsAndOtherReceivables",
"IncreaseDecreaseInAccountsPayable",
"IncreaseDecreaseInAccountsReceivable",
"IncreaseDecreaseInAccruedIncomeTaxesPayable",
"IncreaseDecreaseInAccruedLiabilities",
"IncreaseDecreaseInAccruedTaxesPayable",
"IncreaseDecreaseInContractWithCustomerLiability",
"IncreaseDecreaseInDeferredIncomeTaxes",
"IncreaseDecreaseInInventories",
"IncreaseDecreaseInOtherCurrentAssets",
"IncreaseDecreaseInOtherCurrentLiabilities",
"IncreaseDecreaseInOtherNoncurrentAssets",
"IncreaseDecreaseInOtherNoncurrentLiabilities",
"IncreaseDecreaseInPensionPlanObligations",
"IncrementalCommonSharesAttributableToShareBasedPaymentArrangements",
"InterestAndDebtExpense",
"InterestExpenseDebt",
"InterestIncomeExpenseNet",
"InterestPaid",
"InterestPaidNet",
"InventoryNet",
"InvestmentIncomeInterest",
"Land",
"LeaseAndRentalExpense",
"LesseeOperatingLeaseLiabilityPaymentsDue",
"LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive",
"LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths",
"LesseeOperatingLeaseLiabilityPaymentsDueYearFive",
"LesseeOperatingLeaseLiabilityPaymentsDueYearFour",
"LesseeOperatingLeaseLiabilityPaymentsDueYearThree",
"LesseeOperatingLeaseLiabilityPaymentsDueYearTwo",
"LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear",
"LettersOfCreditOutstandingAmount",
"Liabilities",
"LiabilitiesAndStockholdersEquity",
"LiabilitiesCurrent",
"LineOfCredit",
"LineOfCreditFacilityMaximumBorrowingCapacity",
"LongTermDebt",
"LongTermDebtCurrent",
"LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive",
"LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths",
"LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive",
"LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour",
"LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree",
"LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo",
"LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear",
"LongTermDebtNoncurrent",
"LongTermInvestments",
"LossContingencyEstimateOfPossibleLoss",
"MachineryAndEquipmentGross",
"MarketableSecuritiesCurrent",
"MarketableSecuritiesNoncurrent",
"MinorityInterest",
"NetCashProvidedByUsedInFinancingActivities",
"NetCashProvidedByUsedInInvestingActivities",
"NetCashProvidedByUsedInOperatingActivities",
"NetIncomeLoss",
"NetIncomeLossAttributableToNoncontrollingInterest",
"NetIncomeLossAttributableToNonredeemableNoncontrollingInterest",
"NetIncomeLossAttributableToRedeemableNoncontrollingInterest",
"NoncurrentAssets",
"NoncurrentAssets",
"NoninterestIncome",
"NonoperatingIncomeExpense",
"NotesReceivableNet",
"OperatingExpenses",
"OperatingIncomeLoss",
"OperatingLeaseCost",
"OperatingLeaseLiability",
"OperatingLeaseLiabilityCurrent",
"OperatingLeaseLiabilityNoncurrent",
"OperatingLeaseRightOfUseAsset",
"OtherAccruedLiabilitiesCurrent",
"OtherAssetsCurrent",
"OtherAssetsNoncurrent",
"OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax",
"OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax",
"OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax",
"OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax",
"OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax",
"OtherComprehensiveIncomeLossNetOfTax",
"OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent",
"OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax",
"OtherIncome",
"OtherLiabilitiesCurrent",
"OtherLiabilitiesNoncurrent",
"OtherLongTermDebt",
"OtherNoncashIncomeExpense",
"PaymentsForCapitalImprovements",
"PaymentsForProceedsFromBusinessesAndInterestInAffiliates",
"PaymentsForProceedsFromOtherInvestingActivities",
"PaymentsForRent",
"PaymentsForRepurchaseOfCommonStock",
"PaymentsOfDebtExtinguishmentCosts",
"PaymentsOfDividends",
"PaymentsOfDividendsMinorityInterest",
"PaymentsToAcquireInvestments",
"PaymentsToAcquirePropertyPlantAndEquipment",
"PreferredStockSharesOutstanding",
"PreferredStockValue",
"PrepaidExpenseAndOtherAssetsCurrent",
"PrepaidExpenseCurrent",
"ProceedsFromDebtMaturingInMoreThanThreeMonths",
"ProceedsFromDebtNetOfIssuanceCosts",
"ProceedsFromDivestitureOfBusinesses",
"ProceedsFromInvestments",
"ProceedsFromIssuanceOfCommonStock",
"ProceedsFromIssuanceOfDebt",
"ProceedsFromIssuanceOfLongTermDebt",
"ProceedsFromIssuanceOfUnsecuredDebt",
"ProceedsFromIssuanceOrSaleOfEquity",
"ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities",
"ProceedsFromPaymentsForOtherFinancingActivities",
"ProceedsFromPaymentsToMinorityShareholders",
"ProceedsFromRepaymentsOfShortTermDebt",
"ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess",
"ProceedsFromSaleOfPropertyPlantAndEquipment",
"ProceedsFromStockOptionsExercised",
"ProfitLoss",
"PropertyPlantAndEquipmentGross",
"PropertyPlantAndEquipmentNet",
"ReceivablesNetCurrent",
"RedeemableNoncontrollingInterestEquityCarryingAmount",
"RepaymentsOfDebtMaturingInMoreThanThreeMonths",
"RepaymentsOfLongTermDebt",
"ResearchAndDevelopmentExpense",
"RestrictedCash",
"RestrictedCashAndCashEquivalents",
"RestrictedStockExpense",
"RestructuringCharges",
"RetainedEarningsAccumulatedDeficit",
"RevenueFromContractWithCustomerExcludingAssessedTax",
"Revenues",
"SecuredLongTermDebt",
"SellingAndMarketingExpense",
"SellingGeneralAndAdministrativeExpense",
"ShareBasedCompensation",
"ShortTermBorrowings",
"ShortTermInvestments",
"StockIssuedDuringPeriodValueNewIssues",
"StockOptionPlanExpense",
"StockRedeemedOrCalledDuringPeriodValue",
"StockRepurchasedAndRetiredDuringPeriodValue",
"StockRepurchasedDuringPeriodValue",
"StockholdersEquity",
"StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest",
"StockholdersEquityOther",
"TaxesPayableCurrent",
"TradingSecuritiesDebt",
"TreasuryStockAcquiredAverageCostPerShare",
"TreasuryStockSharesAcquired",
"UnrealizedGainLossOnInvestments",
"UnrecognizedTaxBenefits",
"UnsecuredDebt",
"VariableLeaseCost",
"WeightedAverageNumberDilutedSharesOutstandingAdjustment",
"WeightedAverageNumberOfDilutedSharesOutstanding",
"WeightedAverageNumberOfSharesOutstandingBasic",
],
}
},
"fiscal_period": {
"sec": {
"multiple_items_allowed": False,
"choices": ["fy", "q1", "q2", "q3", "q4"],
}
},
},
)
)
@exception_handler
@validate
def peers(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
provider: Annotated[
Optional[Literal["fmp"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp."
),
] = None,
**kwargs
) -> OBBject:
"""Get the closest peers for a given company.
Peers consist of companies trading on the same exchange, operating within the same sector
and with comparable market capitalizations.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp.
symbol : str
Symbol to get data for.
Returns
-------
OBBject
results : EquityPeers
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
EquityPeers
-----------
peers_list : list[str]
A list of equity peers based on sector, exchange and market cap.
Examples
--------
>>> from openbb import obb
>>> obb.equity.compare.peers(symbol='AAPL', provider='fmp')
""" # noqa: E501
return self._run(
"/equity/compare/peers",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.compare.peers",
("fmp",),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
)
)
|