Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/backtest-kit/uzse-backtest-app/llms.txt

Use this file to discover all available pages before exploring further.

TradeModel is the Mongoose model that stores every raw trade record fetched from the UZSE exchange API. Each document represents a single executed transaction and is persisted in the trade-results collection of the backtest database. The schema is designed for idempotent imports: a SHA1 hash field carries a fingerprint of the trade’s key attributes, and a unique index on that field prevents duplicate records from being written no matter how many times the same data is collected.

​
Collection Details

PropertyValue
Collectiontrade-results
Databasebacktest
TimestampscreateDate, updatedDate (auto-managed by Mongoose)

​
TypeScript Interface

The ITradeDto interface describes the shape of a trade document as it is inserted and queried. Comments are preserved from the original source and reflect the Russian-language UZSE API field descriptions. 
interface ITradeDto {
  /** Дата и время сделки, напр. "17 апреля 2026, 16:02" */
  time: Date;
  /** ISIN код ценной бумаги, напр. "UZ7011340005" */
  symbol: string;
  /** Наименование эмитента, напр. "<Hamkorbank> ATB" */
  issuer: string;
  /** Тип ценной бумаги, напр. "Простые акции", "Привилегированные акции" */
  securityType: string;
  /** Рынок (сектор торгов), напр. "STK" (акции), "BON" (облигации) */
  market: string;
  /** Торговая площадка (сессия), напр. "G1", "G2" */
  platform: string;
  /** Цена одной ценной бумаги в сделке */
  tradePrice: number;
  /** Количество ценных бумаг в сделке */
  quantity: number;
  /** Объём сделки в UZS (tradePrice * quantity) */
  volume: number;
  /** SHA1 от symbol|time|tradePrice|quantity|volume|pageIndex|rowIndex|query_begin|query_end|query_search_key */
  hash: string;
}
ITradeRow extends ITradeDto with the document’s id string and the Mongoose timestamp fields createDate and updatedDate.

​
Field Reference

​
time
Date
required
Transaction datetime parsed from the UZSE API response, e.g. "17 апреля 2026, 16:02". Stored as a native BSON Date in UTC. Carries a single-field index to support range queries over time windows.
​
symbol
string
required
ISIN code of the security, e.g. "UZ7011340005". Indexed individually and as part of the compound { symbol, time } index. Note that symbol in trade-results holds the ISIN, while the candle-items collection stores the shorter display ticker.
​
issuer
string
required
Human-readable name of the security issuer as returned by the UZSE API, e.g. "<Hamkorbank> ATB".
​
securityType
string
required
Category of the security. Common values include "Простые акции" (ordinary shares) and "Привилегированные акции" (preferred shares).
​
market
string
required
Trading sector code. "STK" denotes the equities market; "BON" denotes the bond market.
​
platform
string
required
Trading session identifier, e.g. "G1" or "G2", as assigned by the UZSE.
​
tradePrice
number
required
Price per unit of the security at the time of the trade, denominated in Uzbekistani som (UZS).
​
quantity
number
required
Number of individual securities (units) exchanged in this trade.
​
volume
number
required
Total monetary value of the trade in UZS, equal to tradePrice × quantity.
​
hash
string
required
SHA1 deduplication key. Carries a unique index — any attempt to insert a document with an existing hash is rejected with a MongoDB duplicate-key error (code 11000). See the Hash Formula section below.

​
Indexes

IndexTypePurpose
timeSingleFast range queries on trade datetime
symbolSingleFilter trades by ISIN
{ symbol, time }CompoundEfficient per-symbol time-range queries
hashUniquePrevents duplicate imports (idempotency guard)

​
SHA1 Hash Formula

The hash field is computed at import time from the following pipe-delimited concatenation of trade attributes and pagination context: 
SHA1(symbol | time.toISOString() | tradePrice | quantity | volume | pageIndex | rowIndex | urlKey)
Including pageIndex, rowIndex, and urlKey ensures that two trades with identical prices, quantities, and timestamps appearing at different positions in the API response still produce distinct hashes, which correctly prevents false-positive deduplication.
urlKey encodes the query parameters used to fetch the page — specifically begin|end|search_key extracted from the page URL — making the hash stable across re-runs with the same request parameters.

​
Import

import { TradeModel, ITradeDto, TradeDocument, ITradeRow } from "../schema/Trade.schema";

​
Example Document

{
  "time": "2026-04-17T11:02:00.000Z",
  "symbol": "UZ7011340005",
  "issuer": "<Hamkorbank> ATB",
  "securityType": "Простые акции",
  "market": "STK",
  "platform": "G1",
  "tradePrice": 4250,
  "quantity": 100,
  "volume": 425000,
  "hash": "a1b2c3d4e5f6...",
  "createDate": "2026-04-18T08:00:00.000Z",
  "updatedDate": "2026-04-18T08:00:00.000Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us