Skip to content
Market Data

Get My Quote Package List

Retrieve the quote packages (quote levels/entitlements) the Client has and has not activated in a specified market, including package descriptions, status messages, navigation and purchase entries, and purchasable SKUs, used for the "My Market Data" page and quote package purchases.

GEThttps://api.lbkrs.com/v2/quote/level/my_level_center

Parameters

marketstringqueryRequired

Market code, for example US, HK, CN, or SG; use the companion endpoint /v1/quote/level/my_level_market to retrieve the markets currently available for query; when omitted, both activated_lists and unactivated_lists return empty lists

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get my quote package list” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
activated_listsarray<object>

List of activated quote packages

Child attributes
namestring

Package name

descriptionstring

Package description

iconstring

Icon URL

marketstring

Market code the package belongs to

tagsarray<string>

Labels

expired_msgstring

Status message, for example "Free during the promotional period" (activated) or "No entitlement" (not activated)

linkstring

Detail or purchase navigation link; an empty string means no navigation; a value containing the {web_app_host} placeholder is a full navigation link template; a value starting with # is a short identifier (not a real URL) for a static description page inside Broker App, for example #HK_App|HKAA|Mainland|LV2

package_keystring

Unique package identifier

button_typeinteger

Button type: 0 no button (already activated or no action required), 1 show the Renew button, 2 show the Activate button

012

quote_productobject

Purchasable quote package product information; null when there is no purchase entry (for example, already activated, or activation requires contacting customer service)

Child attributes
skusarray<object>

List of purchasable SKUs

Child attributes
product_idstring

Product id

currencystring

Currency unit

pricenumber

Original price

real_pricenumber

Actual amount payable

inventorystring

Inventory count; "0" means sold out (disabled)

labelsarray<string>

Corner badge labels

is_discountboolean

Whether a discount applies, which determines whether the original price in price is shown with a strikethrough

card_durationinteger

Card duration: 0 weekly card, 1 monthly card, 2 quarterly card, 3 annual card, 4 continuous weekly card, 5 continuous monthly card, 6 continuous quarterly card, 7 continuous annual card (4-7 renew automatically)

01234567

per_month_pricenumber

Converted average monthly price

professional_categoryinteger

Professional investor restriction for purchasing US market data: 0 no restriction (non-US scenarios), 1 non-professional investors only (unpass), 2 professional investors only (pass); Broker App runs the professional investor assessment check before purchase only when market=US

012

apple_product_idstring

iOS/macOS in-app purchase (IAP) product id

end_timestring

Expiration timestamp (seconds); "0" means no expiration (permanently valid)

unactivated_listsarray<object>

List of quote packages that have not been activated

Child attributes
namestring

Package name

descriptionstring

Package description

iconstring

Icon URL

marketstring

Market code the package belongs to

tagsarray<string>

Labels

expired_msgstring

Status message, for example "Free during the promotional period" (activated) or "No entitlement" (not activated)

linkstring

Detail or purchase navigation link; an empty string means no navigation; a value containing the {web_app_host} placeholder is a full navigation link template; a value starting with # is a short identifier (not a real URL) for a static description page inside Broker App, for example #HK_App|HKAA|Mainland|LV2

package_keystring

Unique package identifier

button_typeinteger

Button type: 0 no button (already activated or no action required), 1 show the Renew button, 2 show the Activate button

012

quote_productobject

Purchasable quote package product information; null when there is no purchase entry (for example, already activated, or activation requires contacting customer service)

Child attributes
skusarray<object>

List of purchasable SKUs

Child attributes
product_idstring

Product id

currencystring

Currency unit

pricenumber

Original price

real_pricenumber

Actual amount payable

inventorystring

Inventory count; "0" means sold out (disabled)

labelsarray<string>

Corner badge labels

is_discountboolean

Whether a discount applies, which determines whether the original price in price is shown with a strikethrough

card_durationinteger

Card duration: 0 weekly card, 1 monthly card, 2 quarterly card, 3 annual card, 4 continuous weekly card, 5 continuous monthly card, 6 continuous quarterly card, 7 continuous annual card (4-7 renew automatically)

01234567

per_month_pricenumber

Converted average monthly price

professional_categoryinteger

Professional investor restriction for purchasing US market data: 0 no restriction (non-US scenarios), 1 non-professional investors only (unpass), 2 professional investors only (pass); Broker App runs the professional investor assessment check before purchase only when market=US

012

apple_product_idstring

iOS/macOS in-app purchase (IAP) product id

end_timestring

Expiration timestamp (seconds); "0" means no expiration (permanently valid)

Whale Docs