Common Quote

get_market_state Get Market State

value QuoteClient::get_market_state(utility::string_t market)

Description

Get the state of a specified market, returning the market name, market status (pre-market, trading, closed, etc.) and the most recent trading time.

Parameters

Parameter	Type	Required	Description
market	utility::string_t	Yes	Market, e.g., U("US"), U("HK"), U("CN")

Return

web::json::value JSON object

Example

#include "tigerapi/quote_client.h"
#include "tigerapi/client_config.h"

using namespace TIGER_API;

ClientConfig config(false, U("/path/to/your/properties/"));
QuoteClient quote_client(config);

value result = quote_client.get_market_state(U("US"));
ucout << result.serialize() << std::endl;

get_symbols Get Symbol List

value QuoteClient::get_symbols(Market market = Market::ALL, bool include_otc = false)

Description

Get the list of all symbol codes for a specified market

Parameters

Parameter	Type	Required	Description
market	Market	No	Market enum, Market::US / Market::HK / Market::ALL, default Market::ALL
include_otc	bool	No	Whether to include OTC symbols, default false

Return

web::json::value JSON array containing symbol codes

Example

ClientConfig config(false, U("/path/to/your/properties/"));
QuoteClient quote_client(config);

value result = quote_client.get_symbols(Market::US);
ucout << result.serialize() << std::endl;

get_all_symbol_names Get Symbol Name List

value QuoteClient::get_all_symbol_names(Market market = Market::ALL, bool include_otc = false)

Description

Get all symbol codes and names for a specified market

Parameters

Parameter	Type	Required	Description
market	Market	No	Market enum, Market::US / Market::HK / Market::ALL, default Market::ALL
include_otc	bool	No	Whether to include OTC symbols, default false

Return

web::json::value JSON array

Example

ClientConfig config(false, U("/path/to/your/properties/"));
QuoteClient quote_client(config);

value result = quote_client.get_all_symbol_names(Market::HK);
ucout << result.serialize() << std::endl;

get_trading_calendar Get Trading Calendar

value QuoteClient::get_trading_calendar(Market market, utility::string_t begin_date, utility::string_t end_date)

Description

Get the trading calendar for a specified market

Parameters

Parameter	Type	Required	Description
market	Market or utility::string_t	Yes	Market, e.g., Market::US or U("US")
begin_date	utility::string_t	Yes	Start date, format "yyyy-MM-dd", e.g., U("2024-01-01")
end_date	utility::string_t	Yes	End date, format "yyyy-MM-dd", e.g., U("2024-12-31")

Return

web::json::value JSON object

Example

ClientConfig config(false, U("/path/to/your/properties/"));
QuoteClient quote_client(config);

value result = quote_client.get_trading_calendar(Market::US, U("2024-01-01"), U("2024-06-30"));
ucout << result.serialize() << std::endl;

get_quote_permission Get Quote Permission

value QuoteClient::get_quote_permission()

Description

Get the quote permissions for the current account

Return

web::json::value JSON object containing quote permission information

Example

ClientConfig config(false, U("/path/to/your/properties/"));
QuoteClient quote_client(config);

value result = quote_client.get_quote_permission();
ucout << result.serialize() << std::endl;

get_kline_quota Get K-line Quota

value QuoteClient::get_kline_quota(bool with_details = false)

Description

Get K-line query quota information

Parameters

Parameter	Type	Required	Description
with_details	bool	No	Whether to return detailed information, default false

Return

web::json::value JSON object

Example

ClientConfig config(false, U("/path/to/your/properties/"));
QuoteClient quote_client(config);

value result = quote_client.get_kline_quota(true);
ucout << result.serialize() << std::endl;