api.md

Quote

Types:

from brapi.types import (
    BalanceSheetEntry,
    DividendsData,
    FinancialDataEntry,
    QuoteRetrieveResponse,
    QuoteListResponse,
)

Methods:

• client.quote.retrieve(tickers, **params) -> QuoteRetrieveResponse
• client.quote.list(**params) -> QuoteListResponse

Available

Types:

from brapi.types import AvailableListResponse

Methods:

• client.available.list(**params) -> AvailableListResponse

V2

Crypto

Types:

from brapi.types.v2 import CryptoRetrieveResponse, CryptoListAvailableResponse

Methods:

• client.v2.crypto.retrieve(**params) -> CryptoRetrieveResponse
• client.v2.crypto.list_available(**params) -> CryptoListAvailableResponse

Currency

Types:

from brapi.types.v2 import (
    CurrencyRetrieveResponse,
    CurrencyHistoricalResponse,
    CurrencyListAvailableResponse,
)

Methods:

• client.v2.currency.retrieve(**params) -> CurrencyRetrieveResponse
• client.v2.currency.historical(**params) -> CurrencyHistoricalResponse
• client.v2.currency.list_available(**params) -> CurrencyListAvailableResponse

Inflation

Types:

from brapi.types.v2 import InflationRetrieveResponse, InflationListAvailableResponse

Methods:

• client.v2.inflation.retrieve(**params) -> InflationRetrieveResponse
• client.v2.inflation.list_available(**params) -> InflationListAvailableResponse

PrimeRate

Types:

from brapi.types.v2 import PrimeRateRetrieveResponse, PrimeRateListAvailableResponse

Methods:

• client.v2.prime_rate.retrieve(**params) -> PrimeRateRetrieveResponse
• client.v2.prime_rate.list_available(**params) -> PrimeRateListAvailableResponse

Dictionary

Types:

from brapi.types.v2 import DictionaryRetrieveResponse

Methods:

• client.v2.dictionary.retrieve(**params) -> DictionaryRetrieveResponse

Stocks

Types:

from brapi.types.v2 import (
    StockFundamentalsSeries,
    StockBalanceSheetResponse,
    StockCashFlowResponse,
    StockDividendsResponse,
    StockFinancialDataResponse,
    StockHistoricalResponse,
    StockIncomeStatementResponse,
    StockInsiderTransactionsResponse,
    StockProfileResponse,
    StockQuoteResponse,
    StockStatisticsResponse,
    StockValueAddedResponse,
)

Methods:

• client.v2.stocks.balance_sheet(**params) -> StockBalanceSheetResponse
• client.v2.stocks.cash_flow(**params) -> StockCashFlowResponse
• client.v2.stocks.dividends(**params) -> StockDividendsResponse
• client.v2.stocks.financial_data(**params) -> StockFinancialDataResponse
• client.v2.stocks.historical(**params) -> StockHistoricalResponse
• client.v2.stocks.income_statement(**params) -> StockIncomeStatementResponse
• client.v2.stocks.insider_transactions(**params) -> StockInsiderTransactionsResponse
• client.v2.stocks.profile(**params) -> StockProfileResponse
• client.v2.stocks.quote(**params) -> StockQuoteResponse
• client.v2.stocks.statistics(**params) -> StockStatisticsResponse
• client.v2.stocks.value_added(**params) -> StockValueAddedResponse

Tickers

Types:

from brapi.types.v2 import (
    TickerListResponse,
    TickerCoverageResponse,
    TickerRenamesResponse,
    TickerResolveResponse,
)

Methods:

• client.v2.tickers.list(**params) -> TickerListResponse
• client.v2.tickers.coverage(**params) -> TickerCoverageResponse
• client.v2.tickers.renames(**params) -> TickerRenamesResponse
• client.v2.tickers.resolve(**params) -> TickerResolveResponse

Fii

Types:

from brapi.types.v2 import (
    PaginationMeta,
    FiiListResponse,
    FiiAnnualReportsResponse,
    FiiDividendsResponse,
    FiiFinancialsResponse,
    FiiHistoricalResponse,
    FiiReportsResponse,
)

Methods:

• client.v2.fii.list(**params) -> FiiListResponse
• client.v2.fii.annual_reports(**params) -> FiiAnnualReportsResponse
• client.v2.fii.dividends(**params) -> FiiDividendsResponse
• client.v2.fii.financials(**params) -> FiiFinancialsResponse
• client.v2.fii.historical(**params) -> FiiHistoricalResponse
• client.v2.fii.reports(**params) -> FiiReportsResponse

Indicators

Types:

from brapi.types.v2.fii import IndicatorRetrieveResponse, IndicatorHistoryResponse

Methods:

• client.v2.fii.indicators.retrieve(**params) -> IndicatorRetrieveResponse
• client.v2.fii.indicators.history(**params) -> IndicatorHistoryResponse

Portfolio

Types:

from brapi.types.v2.fii import (
    FiiFinancialAsset,
    FiiPortfolioAllocation,
    FiiPortfolioSummary,
    FiiProperty,
    PortfolioRetrieveResponse,
    PortfolioHistoryResponse,
)

Methods:

• client.v2.fii.portfolio.retrieve(**params) -> PortfolioRetrieveResponse
• client.v2.fii.portfolio.history(**params) -> PortfolioHistoryResponse

Properties

Types:

from brapi.types.v2.fii import FiiPropertySummary, PropertyRetrieveResponse, PropertyHistoryResponse

Methods:

• client.v2.fii.properties.retrieve(**params) -> PropertyRetrieveResponse
• client.v2.fii.properties.history(**params) -> PropertyHistoryResponse

Funds

Types:

from brapi.types.v2 import (
    FundHolding,
    FundPaginationMeta,
    FundListResponse,
    FundDividendsResponse,
    FundIndicatorsResponse,
    FundPortfolioResponse,
    FundProfileResponse,
)

Methods:

• client.v2.funds.list(**params) -> FundListResponse
• client.v2.funds.dividends(**params) -> FundDividendsResponse
• client.v2.funds.indicators(**params) -> FundIndicatorsResponse
• client.v2.funds.portfolio(**params) -> FundPortfolioResponse
• client.v2.funds.profile(**params) -> FundProfileResponse

Nav

Types:

from brapi.types.v2.funds import NavHistoryResponse

Methods:

• client.v2.funds.nav.history(**params) -> NavHistoryResponse

Fiagro

Types:

from brapi.types.v2.funds import FiagroPortfolioResponse, FiagroReportsResponse

Methods:

• client.v2.funds.fiagro.portfolio(**params) -> FiagroPortfolioResponse
• client.v2.funds.fiagro.reports(**params) -> FiagroReportsResponse

Fidc

Types:

from brapi.types.v2.funds import FidcPortfolioResponse, FidcReportsResponse

Methods:

• client.v2.funds.fidc.portfolio(**params) -> FidcPortfolioResponse
• client.v2.funds.fidc.reports(**params) -> FidcReportsResponse

Fip

Types:

from brapi.types.v2.funds import FipReportsResponse

Methods:

• client.v2.funds.fip.reports(**params) -> FipReportsResponse

Options

Types:

from brapi.types.v2 import (
    OptionSeries,
    OptionChainResponse,
    OptionExpirationsResponse,
    OptionHistoricalResponse,
    OptionStrikesResponse,
)

Methods:

• client.v2.options.chain(**params) -> OptionChainResponse
• client.v2.options.expirations(**params) -> OptionExpirationsResponse
• client.v2.options.historical(**params) -> OptionHistoricalResponse
• client.v2.options.strikes(**params) -> OptionStrikesResponse

Positions

Types:

from brapi.types.v2.options import PositionRetrieveResponse, PositionHistoryResponse

Methods:

• client.v2.options.positions.retrieve(**params) -> PositionRetrieveResponse
• client.v2.options.positions.history(**params) -> PositionHistoryResponse

Analytics

Types:

from brapi.types.v2.options import AnalyticsRetrieveResponse, AnalyticsHistoryResponse

Methods:

• client.v2.options.analytics.retrieve(**params) -> AnalyticsRetrieveResponse
• client.v2.options.analytics.history(**params) -> AnalyticsHistoryResponse

Futures

Types:

from brapi.types.v2 import (
    FutureQuote,
    FutureSpecs,
    FutureListResponse,
    FutureHistoricalResponse,
    FutureQuoteResponse,
    FutureSpecsResponse,
    FutureTermStructureResponse,
)

Methods:

• client.v2.futures.list(**params) -> FutureListResponse
• client.v2.futures.historical(**params) -> FutureHistoricalResponse
• client.v2.futures.quote(**params) -> FutureQuoteResponse
• client.v2.futures.specs(**params) -> FutureSpecsResponse
• client.v2.futures.term_structure(**params) -> FutureTermStructureResponse

Options

Types:

from brapi.types.v2.futures import (
    FutureOptionSpecs,
    OptionChainResponse,
    OptionExpirationsResponse,
    OptionHistoricalResponse,
    OptionStrikesResponse,
)

Methods:

• client.v2.futures.options.chain(**params) -> OptionChainResponse
• client.v2.futures.options.expirations(**params) -> OptionExpirationsResponse
• client.v2.futures.options.historical(**params) -> OptionHistoricalResponse
• client.v2.futures.options.strikes(**params) -> OptionStrikesResponse

Positions

Types:

from brapi.types.v2.futures.options import PositionRetrieveResponse, PositionHistoryResponse

Methods:

• client.v2.futures.options.positions.retrieve(**params) -> PositionRetrieveResponse
• client.v2.futures.options.positions.history(**params) -> PositionHistoryResponse

Analytics

Types:

from brapi.types.v2.futures.options import AnalyticsRetrieveResponse, AnalyticsHistoryResponse

Methods:

• client.v2.futures.options.analytics.retrieve(**params) -> AnalyticsRetrieveResponse
• client.v2.futures.options.analytics.history(**params) -> AnalyticsHistoryResponse

Macro

Types:

from brapi.types.v2 import (
    MacroSeriesAliasWarning,
    MacroSeriesError,
    MacroSeriesObservation,
    MacroSeriesPublic,
    MacroRetrieveResponse,
    MacroLatestResponse,
    MacroListAvailableResponse,
)

Methods:

• client.v2.macro.retrieve(**params) -> MacroRetrieveResponse
• client.v2.macro.latest(**params) -> MacroLatestResponse
• client.v2.macro.list_available(**params) -> MacroListAvailableResponse

Treasury

Types:

from brapi.types.v2 import TreasuryListItem, TreasuryListResponse

Methods:

• client.v2.treasury.list(**params) -> TreasuryListResponse

Indicators

Types:

from brapi.types.v2.treasury import IndicatorRetrieveResponse, IndicatorHistoryResponse

Methods:

• client.v2.treasury.indicators.retrieve(**params) -> IndicatorRetrieveResponse
• client.v2.treasury.indicators.history(**params) -> IndicatorHistoryResponse

User

Types:

from brapi.types.v2 import UserUsageResponse

Methods:

• client.v2.user.usage(**params) -> UserUsageResponse