General

Get Market Data Access

value QuoteClient::get_quote_permission()

Description

Returns the current account's market data access.

Return

A web::json::value JSON object containing market data access information.

Example

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

using namespace TIGER_API;

ClientConfig config(false, U("your_config_directory_path"));
QuoteClient quote_client(config);

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

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": [
    {"name": "usStockQuote", "expireAt": 1788120000000},
    {"name": "hkStockQuoteLv2", "expireAt": 1788120000000}
  ]
}

Claim Market Data Access

value QuoteClient::grab_quote_permission()

Takes no parameters. Makes this device the active holder of market-data access and may revoke the corresponding stream from another device on the account. Returns web::json::value.

auto result = quote_client.grab_quote_permission();
utility::ucout << result.serialize() << std::endl;

Response provenance: the SDK returns unmodeled web::json::value and the repository has no verified fixture, so no synthetic success payload is shown.

An active market-data entitlement is required. The current constructor implementation invokes this method without reading is_grab_permission.

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "name": "usStockQuote",
    "expireAt": 1788120000000
  }
}

Get Bar-Query Quota

value QuoteClient::get_kline_quota(bool with_details = false)

Description

Returns quota information for candlestick bar (K-line) queries.

Parameters

ParameterTypeRequiredDescription
with_detailsboolNoReturn detailed quota information; default false

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("your_config_directory_path"));
QuoteClient quote_client(config);

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

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": {
    "remain": 500,
    "used": 120
  }
}

Get Add-On Entitlements

value QuoteClient::get_addon_entitlements()

Description

Returns add-on market-data plans and entitlements visible to the account.

Parameters

None.

Return

web::json::value; no fixed SDK response model exists.

Example

auto result = quote_client.get_addon_entitlements();

Response Example

{
  "code": 0,
  "message": "success",
  "timestamp": 1785528000000,
  "data": [
    {"name": "usRealtime", "status": "ACTIVE", "expireAt": 1788120000000}
  ]
}

Response provenance: the SDK repository has no entitlement response model or verified fixture, so no example payload is provided.

Permissions and Limits

Only plans visible to the current developer account are returned.

Return, Permissions, and Limits

All methods return web::json::value. Relevant market and company-data entitlements are required. The server controls fields, date ranges, and pagination limits. See API Rate Limits.

Source: quote_client.h; request construction is in src/quote_client.cpp.


What’s Next

Did this page help you?