Skip to content

Symbol Sets TCP API

SymbolSet is a reusable collection of platform symbols. It defines which symbols a brand may expose; trading-group settings remain a second, narrower layer of permissions.

Effective access is calculated as:

brand SymbolSets union ∩ trading-group settings

One symbol may belong to several sets and one brand may receive several sets. A new brand with no assigned sets has no available symbols. Existing brands are assigned the protected Legacy All Symbols set once during migration.

Disabling or deleting a set immediately removes its symbols from new catalogue, MarketWatch and order-opening operations. Existing positions can still be closed. Runtime checks use compiled in-memory sets and do not query SQLite.

Methods

Method Purpose
MngGetSymbolSetsByFilter List sets
MngAddSymbolSet Create a set
MngUpdateSymbolSet Update or disable a set
MngDeleteSymbolSet Soft-delete a set
MngGetSymbolSetMembers Read members
MngSetSymbolSetMembers Replace members
MngGetBrandSymbolSets Read brand assignments
MngSetBrandSymbolSets Replace brand assignments
MngGetBrandAvailableSymbols Read effective brand catalogue

All mutation methods are restricted to SuperAdmin. Brand-scoped staff can read assignments and effective symbols only for their own brand; SuperAdmin supplies the target brand explicitly.