api.md

Quote

Types:

from brapi.types import (
    BalanceSheetEntry,
    CashflowEntry,
    DefaultKeyStatisticsEntry,
    FinancialDataEntry,
    IncomeStatementEntry,
    ValueAddedEntry,
    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, CurrencyListAvailableResponse

Methods:

• client.v2.currency.retrieve(**params) -> CurrencyRetrieveResponse
• 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