Module reference_data_api

Module reference_data_api 

Source

Structs§

GetBondsParams
struct for passing parameters to the method get_bonds
GetBondsParamsBuilder
Builder for GetBondsParams
GetCommoditiesParams
struct for passing parameters to the method get_commodities
GetCommoditiesParamsBuilder
Builder for GetCommoditiesParams
GetCrossListingsParams
struct for passing parameters to the method get_cross_listings
GetCrossListingsParamsBuilder
Builder for GetCrossListingsParams
GetCryptocurrenciesParams
struct for passing parameters to the method get_cryptocurrencies
GetCryptocurrenciesParamsBuilder
Builder for GetCryptocurrenciesParams
GetCryptocurrencyExchangesParams
struct for passing parameters to the method get_cryptocurrency_exchanges
GetCryptocurrencyExchangesParamsBuilder
Builder for GetCryptocurrencyExchangesParams
GetEarliestTimestampParams
struct for passing parameters to the method get_earliest_timestamp
GetEarliestTimestampParamsBuilder
Builder for GetEarliestTimestampParams
GetEtfParams
struct for passing parameters to the method get_etf
GetEtfParamsBuilder
Builder for GetEtfParams
GetEtfsFamilyParams
struct for passing parameters to the method get_etfs_family
GetEtfsFamilyParamsBuilder
Builder for GetEtfsFamilyParams
GetEtfsListParams
struct for passing parameters to the method get_etfs_list
GetEtfsListParamsBuilder
Builder for GetEtfsListParams
GetEtfsTypeParams
struct for passing parameters to the method get_etfs_type
GetEtfsTypeParamsBuilder
Builder for GetEtfsTypeParams
GetExchangeScheduleParams
struct for passing parameters to the method get_exchange_schedule
GetExchangeScheduleParamsBuilder
Builder for GetExchangeScheduleParams
GetExchangesParams
struct for passing parameters to the method get_exchanges
GetExchangesParamsBuilder
Builder for GetExchangesParams
GetForexPairsParams
struct for passing parameters to the method get_forex_pairs
GetForexPairsParamsBuilder
Builder for GetForexPairsParams
GetFundsParams
struct for passing parameters to the method get_funds
GetFundsParamsBuilder
Builder for GetFundsParams
GetMarketStateParams
struct for passing parameters to the method get_market_state
GetMarketStateParamsBuilder
Builder for GetMarketStateParams
GetMutualFundsFamilyParams
struct for passing parameters to the method get_mutual_funds_family
GetMutualFundsFamilyParamsBuilder
Builder for GetMutualFundsFamilyParams
GetMutualFundsListParams
struct for passing parameters to the method get_mutual_funds_list
GetMutualFundsListParamsBuilder
Builder for GetMutualFundsListParams
GetMutualFundsTypeParams
struct for passing parameters to the method get_mutual_funds_type
GetMutualFundsTypeParamsBuilder
Builder for GetMutualFundsTypeParams
GetStocksParams
struct for passing parameters to the method get_stocks
GetStocksParamsBuilder
Builder for GetStocksParams
GetSymbolSearchParams
struct for passing parameters to the method get_symbol_search
GetSymbolSearchParamsBuilder
Builder for GetSymbolSearchParams

Enums§

GetBondsError
struct for typed errors of method get_bonds
GetCommoditiesError
struct for typed errors of method get_commodities
GetCountriesError
struct for typed errors of method get_countries
GetCrossListingsError
struct for typed errors of method get_cross_listings
GetCryptocurrenciesError
struct for typed errors of method get_cryptocurrencies
GetCryptocurrencyExchangesError
struct for typed errors of method get_cryptocurrency_exchanges
GetEarliestTimestampError
struct for typed errors of method get_earliest_timestamp
GetEtfError
struct for typed errors of method get_etf
GetEtfsFamilyError
struct for typed errors of method get_etfs_family
GetEtfsListError
struct for typed errors of method get_etfs_list
GetEtfsTypeError
struct for typed errors of method get_etfs_type
GetExchangeScheduleError
struct for typed errors of method get_exchange_schedule
GetExchangesError
struct for typed errors of method get_exchanges
GetForexPairsError
struct for typed errors of method get_forex_pairs
GetFundsError
struct for typed errors of method get_funds
GetInstrumentTypeError
struct for typed errors of method get_instrument_type
GetIntervalsError
struct for typed errors of method get_intervals
GetMarketStateError
struct for typed errors of method get_market_state
GetMutualFundsFamilyError
struct for typed errors of method get_mutual_funds_family
GetMutualFundsListError
struct for typed errors of method get_mutual_funds_list
GetMutualFundsTypeError
struct for typed errors of method get_mutual_funds_type
GetStocksError
struct for typed errors of method get_stocks
GetSymbolSearchError
struct for typed errors of method get_symbol_search
GetTechnicalIndicatorsError
struct for typed errors of method get_technical_indicators

Functions§

get_bonds
The fixed income endpoint provides a daily updated list of available bonds. It returns an array containing detailed information about each bond, including identifiers, names, and other relevant attributes.
get_commodities
The commodities endpoint provides a daily updated list of available commodity pairs, across precious metals, livestock, softs, grains, etc.
get_countries
The countries endpoint provides a comprehensive list of countries, including their ISO codes, official names, capitals, and currencies. This data is essential for applications requiring accurate country information for tasks such as localization, currency conversion, or geographic analysis.
get_cross_listings
The cross_listings endpoint provides a daily updated list of cross-listed symbols for a specified financial instrument. Cross-listed symbols represent the same security available on multiple exchanges. This endpoint is useful for identifying all the exchanges where a particular security is traded, allowing users to access comprehensive trading information across different markets.
get_cryptocurrencies
The cryptocurrencies endpoint provides a daily updated list of all available cryptos. It returns an array containing detailed information about each cryptocurrency, including its symbol, name, and other relevant identifiers. This endpoint is useful for retrieving a comprehensive catalog of cryptocurrencies for applications that require up-to-date market listings or need to display available crypto assets to users.
get_cryptocurrency_exchanges
The cryptocurrency exchanges endpoint provides a daily updated list of available cryptocurrency exchanges. It returns an array containing details about each exchange, such as exchange names and identifiers.
get_earliest_timestamp
The earliest_timestamp endpoint provides the earliest available date and time for a specified financial instrument at a given data interval. This endpoint is useful for determining the starting point of historical data availability for various assets, such as stocks or currencies, allowing users to understand the time range covered by the data.
get_etf
The ETFs endpoint provides a daily updated list of all available Exchange-Traded Funds. It returns an array containing detailed information about each ETF, including its symbol, name, and other relevant identifiers. This endpoint is useful for retrieving a comprehensive catalog of ETFs for portfolio management, investment tracking, or financial analysis.
get_etfs_family
Retrieve a comprehensive list of exchange-traded fund (ETF) families, providing users with detailed information on various ETF groups available in the market. This endpoint is ideal for users looking to explore different ETF categories, compare offerings, or integrate ETF family data into their financial applications.
get_etfs_list
The ETFs directory endpoint provides a daily updated list of exchange-traded funds, sorted by total assets in descending order. This endpoint is useful for retrieving comprehensive ETF data, including fund names and asset values, to assist users in quickly identifying the ETFs available.
get_etfs_type
The ETFs Types endpoint provides a concise list of ETF categories by market (e.g., Singapore, United States), including types like "Equity Precious Metals" and "Large Blend." It supports targeted investment research and portfolio diversification.
get_exchange_schedule
The exchanges schedule endpoint provides detailed information about various stock exchanges, including their trading hours and operational days. This data is essential for users who need to know when specific exchanges are open for trading, allowing them to plan their activities around the availability of these markets.
get_exchanges
The exchanges endpoint provides a comprehensive list of all available equity exchanges. It returns an array containing detailed information about each exchange, such as exchange code, name, country, and timezone. This data is updated daily.
get_forex_pairs
The forex pairs endpoint provides a comprehensive list of all available foreign exchange currency pairs. It returns an array of forex pairs, which is updated daily.
get_funds
The funds endpoint provides a daily updated list of available investment funds. It returns an array containing detailed information about each fund, including identifiers, names, and other relevant attributes.
get_instrument_type
The instrument type endpoint lists all available financial instrument types, such as stocks, ETFs, and cryptos. This information is essential for users to identify and categorize different financial instruments when accessing or analyzing market data.
get_intervals
The intervals endpoint provides a list of supported time intervals that can be used for querying financial data.
get_market_state
The market state endpoint provides real-time information on the operational status of all available stock exchanges. It returns data on whether each exchange is currently open or closed, along with the time remaining until the next opening or closing. This endpoint is useful for users who need to monitor exchange hours and plan their trading activities accordingly.
get_mutual_funds_family
The mutual funds family endpoint provides a comprehensive list of MF families, which are groups of mutual funds managed by the same investment company. This data is useful for users looking to explore or compare different fund families, understand the range of investment options offered by each, and identify potential investment opportunities within specific fund families.
get_mutual_funds_list
The mutual funds directory endpoint provides a daily updated list of mutual funds, sorted in descending order by their total assets value. This endpoint is useful for retrieving an organized overview of available mutual funds.
get_mutual_funds_type
This endpoint provides detailed information on various types of mutual funds, such as equity, bond, and balanced funds, allowing users to understand the different investment options available.
get_stocks
The stocks endpoint provides a daily updated list of all available stock symbols. It returns an array containing the symbols, which can be used to identify and access specific stock data across various services. This endpoint is essential for users needing to retrieve the latest stock symbol information for further data requests or integration into financial applications.
get_symbol_search
The symbol search endpoint allows users to find financial instruments by name or symbol. It returns a list of matching symbols, ordered by relevance, with the most relevant instrument first. This is useful for quickly locating specific stocks, ETFs, or other financial instruments when only partial information is available.
get_technical_indicators
The technical indicators endpoint provides a comprehensive list of available technical indicators, each represented as an object. This endpoint is useful for developers looking to integrate a variety of technical analysis tools into their applications, allowing for streamlined access to indicator data without needing to manually configure each one.