Skip to content

wisdom_capital

Wisdom Capital ticks, from Symphony's XTS platform.

XTS names an instrument by exchange segment number and exchange instrument id - 1:2885 - and stores the bare instrument id, which collides across segments (the same id is an NSE equity and an MCX future), so the segment narrows the search. The numbers are the ones stock_brokers/instruments/historical/wisdom_capital.py downloads candles with, repeated here rather than imported because that module pulls in the API client; indices sit under the cash segments.

What XTS's values mean, as measured against the stored ticks of 2026-09-12 and 2026-09-13:

  • Close is not the previous close: RELIANCE read Close 1270.1 with a last price of 1270.1 in every snapshot, where the previous close was 1257.5. The previous close therefore comes only from an earlier owner's tick the same day, until a live session shows XTS carries it somewhere else.
  • The last trade and exchange times, corrected from XTS's 1980 epoch in the market feed, are true instants: RELIANCE's last mock trade read 21:02:12, the second Flattrade's feed time shows.
  • Quantities on NSE and BSE are units (RELIANCE's mock volume 1150, the same as Flattrade's). MCX quantities are taken to be lots, as at every broker measured, which a live session checks.

Classes:

Name Description
WisdomCapitalTickNormalizer

Normalizes Wisdom Capital ticks.

WisdomCapitalTickNormalizer

WisdomCapitalTickNormalizer()

Bases: TickNormalizer

Normalizes Wisdom Capital ticks.

Build the lookup from each XTS exchange segment number to the canonical segments it can hold.

The table is worked out once here from SEGMENT_NUMBERS, so feed_key only has to look a tick's exchange segment number up rather than recompute its segments on every call.

Example programs

examples/stock_brokers/instruments/ticks/wisdom_capital/WisdomCapitalTickNormalizer/example_1_placing_feed_tokens.py
"""Places Wisdom Capital feed tokens, which name the XTS exchange segment by number or by name, on the canonical segments they can be in.

Wisdom Capital runs on the XTS platform, whose tokens are `SEGMENT:INSTRUMENT_ID`. The segment is a number, such as 1 for NSE cash and 51 for MCX, but some payloads spell it by name, such as `NSECM`, and the normalizer accepts both. A segment number XTS does not use, or a segment with no instrument id after it, prints `None`.

The normalizer only works on the text of each token, so the program needs no Redis, database, network or stand-in of any kind. Each output line shows a token as the feed spells it, then the broker token that `unified.broker_mappings` is searched with, the order symbol when the broker names instruments by symbol, and how many canonical segments the search is limited to, with the first of them. A token the normalizer cannot place prints `None`. `tick_spelling` turns a subscription token spelled by segment name into the numeric spelling ticks carry, keeps a numeric spelling as it is, and refuses a name it does not know.

Run it from the project root:

    python examples/stock_brokers/instruments/ticks/wisdom_capital/WisdomCapitalTickNormalizer/example_1_placing_feed_tokens.py
"""

from stock_brokers.instruments.ticks.wisdom_capital import (
    WisdomCapitalTickNormalizer,
)


class PlacingFeedTokensExample:
    """Asks the Wisdom Capital normalizer where each of a few feed tokens belongs.

    Attributes:
        normalizer (WisdomCapitalTickNormalizer): The normalizer being shown.
        tokens (list): The tokens to place, spelled as the feed spells them.
        subscription_tokens (list): Tokens as the broker's subscription set stores them.
    """

    def __init__(self):
        """Builds the normalizer and the tokens to place.

        Returns:
            None: This method returns nothing.
        """
        self.normalizer = WisdomCapitalTickNormalizer()
        self.tokens = [
            '1:2885',
            'NSECM:2885',
            '2:35003',
            '51:440001',
            '21:12345',
            '99:1',
            'NSECM:',
        ]
        self.subscription_tokens = [
            'NSECM:2885',
            'MCXFO:440001',
            '1:2885',
            'XYZ:1',
        ]

    def describe(self, feed_key):
        """Describes a feed key in one line.

        Args:
            feed_key (FeedKey | None): The key the normalizer returned.

        Returns:
            str: The description.
        """
        if feed_key is None:
            return 'None'
        segment_count = len(feed_key.segments)
        first_segment = feed_key.segments[0]
        return f'broker_token={feed_key.broker_token!r} order_symbol={feed_key.order_symbol!r} segments={segment_count} starting with {first_segment}'

    def run(self):
        """Prints where each token belongs.

        Returns:
            None: This method returns nothing.
        """
        print(f'Broker: {WisdomCapitalTickNormalizer.BROKER_NAME}')
        for token in self.tokens:
            feed_key = self.normalizer.feed_key(token)
            print(f'{token!r} -> {self.describe(feed_key)}')
        print('Subscription tokens as ticks spell them:')
        for token in self.subscription_tokens:
            spelling = self.normalizer.tick_spelling(token)
            print(f'{token!r} -> {spelling!r}')


if __name__ == '__main__':
    PlacingFeedTokensExample().run()

It prints:

Broker: wisdom_capital
'1:2885' -> broker_token='2885' order_symbol=None segments=10 starting with nse_equities
'NSECM:2885' -> broker_token='2885' order_symbol=None segments=10 starting with nse_equities
'2:35003' -> broker_token='35003' order_symbol=None segments=16 starting with nse_fixed_income_futures
'51:440001' -> broker_token='440001' order_symbol=None segments=16 starting with mcx_fixed_income_futures
'21:12345' -> broker_token='12345' order_symbol=None segments=16 starting with ncdex_fixed_income_futures
'99:1' -> None
'NSECM:' -> None
Subscription tokens as ticks spell them:
'NSECM:2885' -> '1:2885'
'MCXFO:440001' -> '51:440001'
'1:2885' -> '1:2885'
'XYZ:1' -> None
examples/stock_brokers/instruments/ticks/wisdom_capital/WisdomCapitalTickNormalizer/example_2_close_never_trusted.py
"""Normalizes one Wisdom Capital tick for an MCX crude oil future, whose `close` is never trusted.

XTS reports MCX quantities in lots, so the plan multiplies each by the 100-barrel lot. Its `close` is never the previous session's close, so `reported_close` is None both before and after the session ends, and the unified pipeline carries the previous close over from another source instead.

The plan that `normalize` applies is normally compiled by `TickResolver` from the mapping cache. This program builds it by hand with the same rules, asking the normalizer how it reports each quantity field and when its close may be trusted, so it needs no database. The tick is shaped like the ones the broker's market feed publishes, with fixed times, so the output is the same on every run. The program normalizes the tick twice, once as received before the session's close and once as received after it, which only changes whether `reported_close` is kept. Order book levels are printed as (price, quantity, orders).

Run it from the project root:

    python examples/stock_brokers/instruments/ticks/wisdom_capital/WisdomCapitalTickNormalizer/example_2_close_never_trusted.py
"""

import datetime
import zoneinfo

from stock_brokers.instruments.ticks import base
from stock_brokers.instruments.ticks.base import (
    InstrumentPlan,
)
from stock_brokers.instruments.ticks.wisdom_capital import (
    WisdomCapitalTickNormalizer,
)
from stock_brokers.instruments.ticks.utilities import sessions

INDIA = zoneinfo.ZoneInfo('Asia/Kolkata')


class CrudeOilTickExample:
    """Normalizes one Wisdom Capital tick through a hand-built plan and prints the result.

    Attributes:
        normalizer (WisdomCapitalTickNormalizer): The normalizer being shown.
        received_at (float): When the tick was received, in epoch seconds.
        tick (dict): The tick as the market feed published it.
        plan (InstrumentPlan): The plan for the tick's instrument.
    """

    def __init__(self):
        """Builds the normalizer, the tick and its plan.

        Returns:
            None: This method returns nothing.
        """
        self.normalizer = WisdomCapitalTickNormalizer()
        received = datetime.datetime(2026, 9, 15, 22, 46, tzinfo=INDIA)
        self.received_at = received.timestamp()
        self.tick = {
            'instrument_token': '51:440001',
            'last_price': 9731.0,
            'last_quantity': 2,
            'average_price': 9718.45,
            'volume': 67958,
            'buy_quantity': 4210,
            'sell_quantity': 3987,
            'ohlc': {
                'open': 9702.0,
                'high': 9745.0,
                'low': 9688.0,
                'close': 9731.0,
            },
            'oi': 18095,
            'oi_day_high': 18410,
            'oi_day_low': 17602,
            'last_trade_time': self.received_at - 2.0,
            'exchange_timestamp': self.received_at - 1.0,
            'received_at': self.received_at,
            'depth': {
                'buy': [
                    {
                        'price': 9730.0,
                        'quantity': 3,
                        'orders': 2,
                    },
                    {
                        'price': 9729.0,
                        'quantity': 11,
                        'orders': 4,
                    },
                ],
                'sell': [
                    {
                        'price': 9731.0,
                        'quantity': 5,
                        'orders': 2,
                    },
                    {
                        'price': 9732.0,
                        'quantity': 8,
                        'orders': 3,
                    },
                ],
            },
        }
        self.plan = self.build_plan()

    def build_plan(self):
        """Compiles the plan for the tick's instrument the way the resolver would.

        Returns:
            InstrumentPlan: The plan.
        """
        exchange = 'mcx'
        segment = 'mcx_commodity_futures'
        lot_size = 100
        broker_lot_size = 1
        multipliers = {}
        for field in base.QUANTITY_FIELDS:
            basis = self.normalizer.quantity_basis(exchange, field)
            if basis == base.BASIS_LOTS:
                multipliers[field] = lot_size
            elif basis == base.BASIS_BROKER_LOTS:
                multipliers[field] = lot_size // broker_lot_size
            else:
                multipliers[field] = 1
        identity = {
            'exchange': 'mcx',
            'segment': 'mcx_commodity_futures',
            'shape': 'future',
            'symbol': 'CRUDEOIL26OCTFUT',
            'underlying_symbol': 'CRUDEOIL',
            'expiry_date': '2026-10-19',
            'strike_price': None,
            'option_type': None,
        }
        instrument_id = '11111111-1111-5111-8111-000000000101'
        broker_token = '440001'
        return InstrumentPlan(
            instrument_id=instrument_id,
            broker=WisdomCapitalTickNormalizer.BROKER_NAME,
            broker_token=broker_token,
            exchange=exchange,
            segment=segment,
            shape=identity['shape'],
            session=sessions.session_for(segment),
            lot_size=lot_size,
            multipliers=multipliers,
            price_decimals=2,
            negative_prices=True,
            close_policy=self.normalizer.close_policy(exchange),
            has_open_interest=identity['shape'] != 'security',
            trusts_last_trade_time=WisdomCapitalTickNormalizer.TRUSTS_LAST_TRADE_TIME,
            trusts_exchange_time=WisdomCapitalTickNormalizer.TRUSTS_EXCHANGE_TIME,
            identity_json=base.identity_json(
                instrument_id,
                WisdomCapitalTickNormalizer.BROKER_NAME,
                broker_token,
                identity,
                lot_size,
            ),
        )

    def run(self):
        """Prints the feed key, the plan's rules and the normalized values.

        Returns:
            None: This method returns nothing.
        """
        token = self.tick['instrument_token']
        feed_key = self.normalizer.feed_key(token)
        print(f'Token {token!r}: broker_token={feed_key.broker_token!r} order_symbol={feed_key.order_symbol!r}')
        volume_basis = self.normalizer.quantity_basis(self.plan.exchange, 'volume')
        print(f'Volume on {self.plan.exchange} is reported in {volume_basis}, multiplier {self.plan.multipliers["volume"]}')
        print(f'Close policy on {self.plan.exchange}: {self.normalizer.close_policy(self.plan.exchange)}')
        before_close = self.normalizer.normalize(self.tick, self.plan, True)
        print('Normalized, received before the close:')
        for name, value in before_close.items():
            print(f'  {name}: {value}')
        after_close = self.normalizer.normalize(self.tick, self.plan, False)
        print(f'reported_close when received after the close: {after_close["reported_close"]}')


if __name__ == '__main__':
    CrudeOilTickExample().run()

It prints:

Token '51:440001': broker_token='440001' order_symbol=None
Volume on mcx is reported in lots, multiplier 100
Close policy on mcx: never
Normalized, received before the close:
  last_price: 9731.0
  last_quantity: 200
  average_price: 9718.45
  volume: 6795800
  buy_quantity: 421000
  sell_quantity: 398700
  open: 9702.0
  high: 9745.0
  low: 9688.0
  reported_close: None
  oi: 1809500
  oi_day_high: 1841000
  oi_day_low: 1760200
  last_trade_time: 1789492558.0
  exchange_time: 1789492559.0
  bids: [(9730.0, 300, 2), (9729.0, 1100, 4)]
  asks: [(9731.0, 500, 2), (9732.0, 800, 3)]
reported_close when received after the close: None

Methods:

Name Description
feed_key

The broker token and segments for an XTS SEGMENT:INSTRUMENT_ID.

tick_spelling

An XTS subscription token as ticks carry it: the segment by number.

quantity_basis

Whether the broker reports a quantity field in lots or units on an exchange.

close_policy

When the broker's close is the previous session's close on an exchange.

normalize

Apply a plan to one tick.

Source code in stock_brokers/instruments/ticks/wisdom_capital.py
def __init__(self):
    """
    Build the lookup from each XTS exchange segment number to the canonical segments it can hold.

    The table is worked out once here from `SEGMENT_NUMBERS`, so `feed_key` only has to look a tick's exchange segment number up rather than recompute its segments on every call.
    """
    self._segments = {number: family_segments(exchanges, family)
                      for number, (exchanges, family) in self.SEGMENT_NUMBERS.items()}

feed_key

feed_key(instrument_token)

The broker token and segments for an XTS SEGMENT:INSTRUMENT_ID.

Parameters:

Name Type Description Default
instrument_token str

The tick's instrument_token, such as "1:2885" or "NSECM:2885".

required

Returns:

Type Description
FeedKey | None

The key, or None for a malformed token or an unknown segment.

Example usage

From example_1_placing_feed_tokens.py
feed_key = self.normalizer.feed_key(token)
From example_2_close_never_trusted.py
feed_key = self.normalizer.feed_key(token)
Source code in stock_brokers/instruments/ticks/wisdom_capital.py
def feed_key(self, instrument_token):
    """
    The broker token and segments for an XTS `SEGMENT:INSTRUMENT_ID`.

    Args:
        instrument_token (str): The tick's `instrument_token`, such as "1:2885" or "NSECM:2885".

    Returns:
        FeedKey | None: The key, or None for a malformed token or an unknown segment.
    """
    segment, _, instrument_id = str(instrument_token).partition(":")
    segment = segment.strip().upper()
    number = self.SEGMENT_NAMES.get(segment)
    if number is None:
        try:
            number = int(segment)
        except ValueError:
            return None
    segments = self._segments.get(number)
    if segments is None or not instrument_id.strip():
        return None
    return FeedKey(instrument_id.strip(), segments)

tick_spelling

tick_spelling(subscription_token)

An XTS subscription token as ticks carry it: the segment by number.

Parameters:

Name Type Description Default
subscription_token str

A member of subscriptions_wisdom_capital, such as "1:2885".

required

Returns:

Type Description
str | None

The tick's spelling, or None for an unknown segment.

Example usage

From example_1_placing_feed_tokens.py
spelling = self.normalizer.tick_spelling(token)
Source code in stock_brokers/instruments/ticks/wisdom_capital.py
def tick_spelling(self, subscription_token):
    """
    An XTS subscription token as ticks carry it: the segment by number.

    Args:
        subscription_token (str): A member of `subscriptions_wisdom_capital`, such as "1:2885".

    Returns:
        str | None: The tick's spelling, or None for an unknown segment.
    """
    segment, _, instrument_id = str(subscription_token).partition(":")
    number = self.SEGMENT_NAMES.get(segment.strip().upper())
    if number is None:
        return subscription_token if segment.strip().isdigit() and instrument_id.strip() else None
    return f"{number}:{instrument_id.strip()}"

quantity_basis

quantity_basis(exchange, field)

Whether the broker reports a quantity field in lots or units on an exchange.

Parameters:

Name Type Description Default
exchange str

Canonical exchange.

required
field str

One of QUANTITY_FIELDS.

required

Returns:

Type Description
str

BASIS_UNITS, BASIS_LOTS or BASIS_BROKER_LOTS.

Example usage

From example_1_a_new_broker_subclass.py
basis = self.normalizer.quantity_basis(exchange, field)
From example_2_what_normalize_refuses.py
self.normalizer.quantity_basis(exchange, field)
Source code in stock_brokers/instruments/ticks/base.py
def quantity_basis(self, exchange, field):
    """
    Whether the broker reports a quantity field in lots or units on an exchange.

    Args:
        exchange (str): Canonical exchange.
        field (str): One of QUANTITY_FIELDS.

    Returns:
        str: BASIS_UNITS, BASIS_LOTS or BASIS_BROKER_LOTS.
    """
    if field in self.BROKER_LOT_FIELDS.get(exchange, ()):
        return BASIS_BROKER_LOTS
    if field in self.LOT_FIELDS.get(exchange, ()):
        return BASIS_LOTS
    return BASIS_UNITS

close_policy

close_policy(exchange)

When the broker's close is the previous session's close on an exchange.

Parameters:

Name Type Description Default
exchange str

Canonical exchange.

required

Returns:

Type Description
str

One of the CLOSE_* policies.

Example usage

From example_1_a_new_broker_subclass.py
print(f'{exchange} close policy: {self.normalizer.close_policy(exchange)}')
From example_2_what_normalize_refuses.py
return InstrumentPlan(
    instrument_id='11111111-1111-5111-8111-000000000102',
    broker='imaginary',
    broker_token='2885',
    exchange=exchange,
    segment=segment,
    shape=shape,
    session=sessions.session_for(segment),
    lot_size=lot_size,
    multipliers=multipliers,
    price_decimals=2,
    negative_prices=shape != 'security' and exchange == 'mcx',
    close_policy=self.normalizer.close_policy(exchange),
    has_open_interest=shape != 'security',
    trusts_last_trade_time=True,
    trusts_exchange_time=True,
    identity_json='"instrument_id":"11111111-1111-5111-8111-000000000102"',
)
Source code in stock_brokers/instruments/ticks/base.py
def close_policy(self, exchange):
    """
    When the broker's `close` is the previous session's close on an exchange.

    Args:
        exchange (str): Canonical exchange.

    Returns:
        str: One of the CLOSE_* policies.
    """
    return self.CLOSE_POLICY.get(exchange, CLOSE_NEVER)

normalize

normalize(tick, plan, before_trading_close)

Apply a plan to one tick.

Parameters:

Name Type Description Default
tick dict

A tick as the broker's market feed published it.

required
plan InstrumentPlan

The compiled plan for the tick's token.

required
before_trading_close bool

Whether the tick was received before its session's close, for the close policy.

required

Returns:

Type Description
dict | None

The normalized values, or None when the tick carries no usable last price. Keys are last_price, last_quantity, average_price, volume, buy_quantity, sell_quantity, open, high, low, reported_close, oi, oi_day_high, oi_day_low, last_trade_time, exchange_time, bids and asks, where bids and asks are lists of (price, quantity, orders) best first.

Example usage

From example_2_what_normalize_refuses.py
values = self.normalizer.normalize(tick, share, True)
From example_2_what_normalize_refuses.py
values = self.normalizer.normalize(
    {
        'last_price': -12.5,
        'volume': 400,
        'oi': 900,
        'received_at': self.received_at,
    },
    future,
    True,
)
From example_2_what_normalize_refuses.py
outcome = self.normalizer.normalize(
    {
        'last_price': last_price,
        'received_at': self.received_at,
    },
    share,
    True,
)
Source code in stock_brokers/instruments/ticks/base.py
def normalize(self, tick, plan, before_trading_close):
    """
    Apply a plan to one tick.

    Args:
        tick (dict): A tick as the broker's market feed published it.
        plan (InstrumentPlan): The compiled plan for the tick's token.
        before_trading_close (bool): Whether the tick was received before its session's close, for the close policy.

    Returns:
        dict | None: The normalized values, or None when the tick carries no usable last price. Keys are last_price, last_quantity, average_price, volume, buy_quantity, sell_quantity, open, high, low, reported_close, oi, oi_day_high, oi_day_low, last_trade_time, exchange_time, bids and asks, where bids and asks are lists of (price, quantity, orders) best first.
    """
    decimals = plan.price_decimals
    negative = plan.negative_prices

    last_price = tick.get("last_price")
    if last_price is None or last_price == 0 or (last_price < 0 and not negative):
        return None
    last_price = round(last_price, decimals)

    multipliers = plan.multipliers
    received_at = tick.get("received_at") or 0.0
    ohlc = tick.get("ohlc") or {}

    close = None
    policy = plan.close_policy
    if policy == CLOSE_ALWAYS or (policy == CLOSE_BEFORE_SESSION_END and before_trading_close):
        close = _price(ohlc.get("close"), decimals, negative)

    if plan.has_open_interest:
        oi = _quantity(tick.get("oi"), multipliers["oi"])
        oi_day_high = _quantity(tick.get("oi_day_high") or None, multipliers["oi_day_high"])
        oi_day_low = _quantity(tick.get("oi_day_low") or None, multipliers["oi_day_low"])
    else:
        oi = oi_day_high = oi_day_low = None

    depth = tick.get("depth") or {}
    depth_multiplier = multipliers["depth_quantity"]

    return {
        "last_price": last_price,
        "last_quantity": _quantity(tick.get("last_quantity"), multipliers["last_quantity"]),
        "average_price": _price(tick.get("average_price"), decimals, negative),
        "volume": _quantity(tick.get("volume"), multipliers["volume"]),
        "buy_quantity": _quantity(tick.get("buy_quantity"), multipliers["buy_quantity"]),
        "sell_quantity": _quantity(tick.get("sell_quantity"), multipliers["sell_quantity"]),
        "open": _price(ohlc.get("open"), decimals, negative),
        "high": _price(ohlc.get("high"), decimals, negative),
        "low": _price(ohlc.get("low"), decimals, negative),
        "reported_close": close,
        "oi": oi,
        "oi_day_high": oi_day_high,
        "oi_day_low": oi_day_low,
        "last_trade_time": self._instant(tick.get("last_trade_time"), received_at) if plan.trusts_last_trade_time else None,
        "exchange_time": self._instant(tick.get("exchange_timestamp"), received_at) if plan.trusts_exchange_time else None,
        "bids": _levels(depth.get("buy"), decimals, negative, depth_multiplier),
        "asks": _levels(depth.get("sell"), decimals, negative, depth_multiplier),
    }

_instant

_instant(value, received_at)

A broker timestamp as a true epoch, or None when it is missing or implausible.

Brokers that stamp times on a shifted clock have that corrected in their market feed; what is left to catch here is a clock nobody has corrected yet, which shows as an instant days away from when the tick arrived.

Parameters:

Name Type Description Default
value float | int | None

Epoch seconds as the feed published them.

required
received_at float

When the feed decoded the tick.

required

Returns:

Type Description
float | None

The instant, or None.

Source code in stock_brokers/instruments/ticks/base.py
def _instant(self, value, received_at):
    """
    A broker timestamp as a true epoch, or None when it is missing or implausible.

    Brokers that stamp times on a shifted clock have that corrected in their market feed; what is
    left to catch here is a clock nobody has corrected yet, which shows as an instant days away
    from when the tick arrived.

    Args:
        value (float | int | None): Epoch seconds as the feed published them.
        received_at (float): When the feed decoded the tick.

    Returns:
        float | None: The instant, or None.
    """
    if not value:
        return None
    try:
        instant = float(value)
    except (TypeError, ValueError):
        return None
    if received_at and not (received_at - self.MAXIMUM_TIMESTAMP_AGE_SECONDS
                            <= instant <= received_at + self.MAXIMUM_TIMESTAMP_LEAD_SECONDS):
        return None
    return instant