Add Private Symbol

Creates or updates a private security. Passing id performs an edit; otherwise a new record is created.

Request parameters

Required: market (market), type (type), ticker (ticker), name (name), currency (currency)
Optional: exchange, name_locales/short_name_locales/industry_locales (multilingual name/short name/industry as a JSON string {zh-CN,zh-HK,en}), lot_size (board lot), ipo_price, risk_level (used for BOND/OTHER), ipo_date (YYYY-MM-DD), delisting_date (YYYY-MM-DD), ISIN, CUSIP, bloomberg_code, SEDOL, reuters_code, group_name, bond_info, id (security ID, pass when editing), audit_frontend_resource (caller-provided audit context)
See the field descriptions for the format, value range, and business meaning of each field.

Business notes

The private security library lets a tenant maintain its own securities outside the platform's public library, for reference by quote maintenance, transfer, and other business.

Risk warning

This operation changes live private-security data and may affect downstream business that references the security. Confirm the parameters before calling.

Result

On success, the private security is created or updated. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/gemini-tenant/private-security-add

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

marketstringrequired

Market. Specifies Market. This field is required.

typestringrequired

Type. Specifies Type. This field is required.

Values

STOCK
BOND
OTHER

tickerstringrequired

Ticker. Specifies Ticker. This field is required.

exchangestring

Exchange. Specifies Exchange.

namestringrequired

Name. Specifies Name. This field is required.

name_localesstring

Name locales (JSON-stringified {zh-CN,zh-HK,en}). Specifies Name locales (JSON-stringified {zh-CN,zh-HK,en}).

short_name_localesstring

Short-name locales (JSON string). Specifies Short-name locales (JSON string).

industry_localesstring

Industry locales (JSON string). Specifies Industry locales (JSON string).

currencystringrequired

Currency. Specifies Currency. This field is required.

lot_sizenumber

Lot size. Specifies Lot size.

ipo_pricenumber

IPO price. Specifies IPO price.

risk_levelstring

Risk level (for BOND/OTHER). Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

ipo_datestring

IPO date. Specifies IPO date.

delisting_datestring

Delisting date. Specifies Delisting date.

ISINstring

ISIN. Specifies ISIN.

CUSIPstring

CUSIP. Specifies CUSIP.

bloomberg_codestring

Bloomberg code. Specifies Bloomberg code.

SEDOLstring

SEDOL. Specifies SEDOL.

reuters_codestring

Reuters code. Specifies Reuters code.

bond_infoobject

Bond info. Specifies Bond info.

Child attributes

maturity_datestring

Maturity date. Specifies Maturity date.

maturity_pricenumber

Maturity price. Specifies Maturity price.

coupon_ratenumber

Coupon rate (%). Specifies Coupon rate (%).

issue_pricenumber

Issue price. Specifies Issue price. This field is required.

payment_frequencyinteger

Payment frequency. Specifies Payment frequency.

payment_frequency_unitstring

Payment frequency unit. Specifies Payment frequency unit.

idstring

Security id (for edit). Specifies Security id (for edit).

audit_frontend_resourceobject

Caller-provided audit context. Specifies Caller-provided audit context.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.