@mywebapi.com/sdk 0.1.0

package/dist/generated/mt4-v2-groups.d.ts

@@ -0,0 +1,166 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { BooleanApiResponse, GetGroupsRequestParams, MT4GroupApiResponse, MT4GroupListApiResponse, MT4GroupMarginListApiResponse, MT4GroupSecListApiResponse, MT4GroupUpdate } from './model';
+export type getGroupsGetResponse200 = {
+    data: MT4GroupListApiResponse;
+    status: 200;
+};
+export type getGroupsGetResponseSuccess = (getGroupsGetResponse200) & {
+    headers: Headers;
+};
+export type getGroupsGetResponse = (getGroupsGetResponseSuccess);
+export declare const getGetGroupsGetUrl: (tradePlatform: string) => string;
+/**
+ * All trading groups configured on the MT4 server from the pump cache.
+ *
+ * Pump-cached read. Curated DTO drops SMTP credentials, template paths,
+ * and nested SecGroups/SecMargins arrays (those get dedicated v2
+ * endpoints in a later wave). Typical group counts are small (dozens),
+ * so no pagination is needed.
+ * @summary List trading groups (cached)
+ */
+export declare const getGroupsGet: (tradePlatform: string, options?: RequestInit) => Promise<getGroupsGetResponse>;
+export type getGroupRecordGetGroupResponse200 = {
+    data: MT4GroupApiResponse;
+    status: 200;
+};
+export type getGroupRecordGetGroupResponseSuccess = (getGroupRecordGetGroupResponse200) & {
+    headers: Headers;
+};
+export type getGroupRecordGetGroupResponse = (getGroupRecordGetGroupResponseSuccess);
+export declare const getGetGroupRecordGetGroupUrl: (tradePlatform: string, group: string) => string;
+/**
+ * Single trading group configuration by name (pump-cached).
+ *
+ * Pump-cached lookup. Returns NotFound envelope if no group with the
+ * given name exists. Group names are case-sensitive — the wrapper does
+ * an exact dictionary lookup.
+ * @summary Get trading group (cached)
+ */
+export declare const getGroupRecordGetGroup: (tradePlatform: string, group: string, options?: RequestInit) => Promise<getGroupRecordGetGroupResponse>;
+export type getGroupsRequestResponse200 = {
+    data: MT4GroupListApiResponse;
+    status: 200;
+};
+export type getGroupsRequestResponseSuccess = (getGroupsRequestResponse200) & {
+    headers: Headers;
+};
+export type getGroupsRequestResponse = (getGroupsRequestResponseSuccess);
+export declare const getGetGroupsRequestUrl: (tradePlatform: string, params?: GetGroupsRequestParams) => string;
+/**
+ * Manager (live) call returning a paged list of all configured groups on the platform. Sort key is the group name (string, ordinal compare) ascending. Cursor is the last returned group name encoded as opaque base64.
+ * @summary List trading groups (live)
+ */
+export declare const getGroupsRequest: (tradePlatform: string, params?: GetGroupsRequestParams, options?: RequestInit) => Promise<getGroupsRequestResponse>;
+export type getGroupSecGroupsGetGroupResponse200 = {
+    data: MT4GroupSecListApiResponse;
+    status: 200;
+};
+export type getGroupSecGroupsGetGroupResponseSuccess = (getGroupSecGroupsGetGroupResponse200) & {
+    headers: Headers;
+};
+export type getGroupSecGroupsGetGroupResponse = (getGroupSecGroupsGetGroupResponseSuccess);
+export declare const getGetGroupSecGroupsGetGroupUrl: (tradePlatform: string, group: string) => string;
+/**
+ * Security-group entries (`SecGroups[32]`) for one trading group.
+ *
+ * Pump-cached read. Returns the full 32-element array; entries whose
+ * `Trade` and `Show` are both 0 are placeholders (the wrapper
+ * reserves the slot for the symbol-group regardless of whether the
+ * group is configured to trade it). Filter on the client side.
+ * @summary Get group security entries
+ */
+export declare const getGroupSecGroupsGetGroup: (tradePlatform: string, group: string, options?: RequestInit) => Promise<getGroupSecGroupsGetGroupResponse>;
+export type getGroupSecMarginsGetGroupResponse200 = {
+    data: MT4GroupMarginListApiResponse;
+    status: 200;
+};
+export type getGroupSecMarginsGetGroupResponseSuccess = (getGroupSecMarginsGetGroupResponse200) & {
+    headers: Headers;
+};
+export type getGroupSecMarginsGetGroupResponse = (getGroupSecMarginsGetGroupResponseSuccess);
+export declare const getGetGroupSecMarginsGetGroupUrl: (tradePlatform: string, group: string) => string;
+/**
+ * Special-securities margin overrides (`SecMargins`) for one group.
+ *
+ * Pump-cached read. Returns the first `SecMarginsTotal` entries of
+ * the wrapper's 128-element `SecMargins` array — the trailing
+ * slots are always uninitialised padding. `SecMarginsTotal` itself
+ * is part of the parent `MT4Group` DTO.
+ * @summary Get group margin overrides
+ */
+export declare const getGroupSecMarginsGetGroup: (tradePlatform: string, group: string, options?: RequestInit) => Promise<getGroupSecMarginsGetGroupResponse>;
+export type postGroupRecordUpdateGroupResponse200 = {
+    data: MT4GroupApiResponse;
+    status: 200;
+};
+export type postGroupRecordUpdateGroupResponseSuccess = (postGroupRecordUpdateGroupResponse200) & {
+    headers: Headers;
+};
+export type postGroupRecordUpdateGroupResponse = (postGroupRecordUpdateGroupResponseSuccess);
+export declare const getPostGroupRecordUpdateGroupUrl: (tradePlatform: string, group: string) => string;
+/**
+ * Update a group configuration — Type 1 mutator with secret-preservation read.
+ *
+ * <br>
+ * Same flow as `UserRecordUpdate`: read the existing
+ * `ConGroup` from the MT4 server, overlay the
+ * `MT4GroupUpdate` DTO over the in-memory record, write the
+ * merged structure back. Preserves SMTP credentials, template paths,
+ * SecuritiesHash, reserved arrays, the nested SecGroups/SecMargins
+ * arrays, and NewsLanguages — none of those are on the input DTO so
+ * they survive untouched.
+ * <br>
+ * Wraps the wrapper's `CfgUpdateGroup` — v2 renames to
+ * `GroupRecordUpdate` for consistency with
+ * `UserRecordUpdate`; the underlying wrapper call is the same as
+ * v1's `POST CfgUpdateGroup` endpoint.
+ * <br>
+ * Idempotency-Key strongly recommended for safe retries.
+ * @summary Update trading group
+ */
+export declare const postGroupRecordUpdateGroup: (tradePlatform: string, group: string, mT4GroupUpdate?: MT4GroupUpdate, options?: RequestInit) => Promise<postGroupRecordUpdateGroupResponse>;
+export type patchGroupRecordGroupMT4Response200 = {
+    data: MT4GroupApiResponse;
+    status: 200;
+};
+export type patchGroupRecordGroupMT4ResponseSuccess = (patchGroupRecordGroupMT4Response200) & {
+    headers: Headers;
+};
+export type patchGroupRecordGroupMT4Response = (patchGroupRecordGroupMT4ResponseSuccess);
+export declare const getPatchGroupRecordGroupMT4Url: (tradePlatform: string, group: string) => string;
+/**
+ * Type 2 mutator — partial update of a trading group. Same semantics as `UserRecordPatch`; see that endpoint for the read-merge- write flow and forwards-compat behavior.
+ * @summary Patch trading group
+ */
+export declare const patchGroupRecordGroupMT4: (tradePlatform: string, group: string, options?: RequestInit) => Promise<patchGroupRecordGroupMT4Response>;
+export type getEnsureGroupNameExistGroupResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type getEnsureGroupNameExistGroupResponseSuccess = (getEnsureGroupNameExistGroupResponse200) & {
+    headers: Headers;
+};
+export type getEnsureGroupNameExistGroupResponse = (getEnsureGroupNameExistGroupResponseSuccess);
+export declare const getGetEnsureGroupNameExistGroupUrl: (tradePlatform: string, group: string) => string;
+/**
+ * Checks whether a trading group exists on the connected MT4 server. Useful as a validation pre-flight before creating users, moving users between groups, or wiring up automated provisioning.
+ *
+ * Manager-live read. The wrapper's `EnsureGroupNameExist` helper
+ * is internal/private, so this v2 endpoint re-implements the check
+ * directly: enumerate the full group catalog via
+ * `GroupsRequest` and look up the key. The same Manager request
+ * is incurred either way; there is no cheaper "exists" call in the
+ * MT4 ManagerAPI surface.
+ *
+ * Returns `true` if the group is configured on the server,
+ * `false` otherwise. Group lookup is case-sensitive (MT4 group
+ * names are case-sensitive in the underlying API).
+ * @summary Check group exists
+ */
+export declare const getEnsureGroupNameExistGroup: (tradePlatform: string, group: string, options?: RequestInit) => Promise<getEnsureGroupNameExistGroupResponse>;

package/dist/generated/mt4-v2-history.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { GetTradesUserHistoryLoginParams, MT4TradeListApiResponse } from './model';
+export type getTradesUserHistoryLoginResponse200 = {
+    data: MT4TradeListApiResponse;
+    status: 200;
+};
+export type getTradesUserHistoryLoginResponseSuccess = (getTradesUserHistoryLoginResponse200) & {
+    headers: Headers;
+};
+export type getTradesUserHistoryLoginResponse = (getTradesUserHistoryLoginResponseSuccess);
+export declare const getGetTradesUserHistoryLoginUrl: (tradePlatform: string, login: number, params?: GetTradesUserHistoryLoginParams) => string;
+/**
+ * Closed trades history for a single account in a time range.
+ *
+ * Manager (live) call — round-trips to MT4 server. Default time range
+ * is "everything" (epoch → MaxValue) when query params are omitted.
+ * Returns an empty list if the account has no closed trades in the
+ * window. Trades are mapped to the curated `MT4Trade` DTO; same
+ * shape as live `TradesGetByMarket` / `TradesGetBySymbol`.
+ * @summary Get account trade history
+ */
+export declare const getTradesUserHistoryLogin: (tradePlatform: string, login: number, params?: GetTradesUserHistoryLoginParams, options?: RequestInit) => Promise<getTradesUserHistoryLoginResponse>;

package/dist/generated/mt4-v2-mail.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { StringApiResponse } from './model';
+export type getMailLastResponse200 = {
+    data: StringApiResponse;
+    status: 200;
+};
+export type getMailLastResponseSuccess = (getMailLastResponse200) & {
+    headers: Headers;
+};
+export type getMailLastResponse = (getMailLastResponseSuccess);
+export declare const getGetMailLastUrl: (tradePlatform: string) => string;
+/**
+ * Path of the most recent mail received in the pump cache.
+ *
+ * Pump-cached read — returns the path/identifier of the last mail.
+ * Empty string when no mail has been received yet on the connection.
+ * @summary Get last mail path
+ */
+export declare const getMailLast: (tradePlatform: string, options?: RequestInit) => Promise<getMailLastResponse>;

package/dist/generated/mt4-v2-margins.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { MT4MarginLevelApiResponse, MT4MarginLevelListApiResponse } from './model';
+export type getMarginsGetResponse200 = {
+    data: MT4MarginLevelListApiResponse;
+    status: 200;
+};
+export type getMarginsGetResponseSuccess = (getMarginsGetResponse200) & {
+    headers: Headers;
+};
+export type getMarginsGetResponse = (getMarginsGetResponseSuccess);
+export declare const getGetMarginsGetUrl: (tradePlatform: string) => string;
+/**
+ * Margin levels for all accounts from the pump cache.
+ *
+ * Pump-cached snapshot of margin/equity/free margin per login. Use this
+ * for bulk monitoring of account health (margin calls / stop-out
+ * proximity). For a single account, prefer the existing
+ * MarginLevelGet/MarginLevelRequest endpoints.
+ * @summary List account margins (cached)
+ */
+export declare const getMarginsGet: (tradePlatform: string, options?: RequestInit) => Promise<getMarginsGetResponse>;
+export type getMarginLevelGetLoginResponse200 = {
+    data: MT4MarginLevelApiResponse;
+    status: 200;
+};
+export type getMarginLevelGetLoginResponseSuccess = (getMarginLevelGetLoginResponse200) & {
+    headers: Headers;
+};
+export type getMarginLevelGetLoginResponse = (getMarginLevelGetLoginResponseSuccess);
+export declare const getGetMarginLevelGetLoginUrl: (tradePlatform: string, login: number) => string;
+/**
+ * Margin level for a single account from the pump cache.
+ *
+ * Pump variant — two-step lookup: `UserRecordGet` to resolve the
+ * account's group, then `MarginLevelGet(login, group)`. Returns
+ * NotFound envelope if the account is unknown or has no open trades.
+ * For a live round-trip use MarginLevelRequest.
+ * @summary Get account margin (cached)
+ */
+export declare const getMarginLevelGetLogin: (tradePlatform: string, login: number, options?: RequestInit) => Promise<getMarginLevelGetLoginResponse>;
+export type getMarginLevelRequestLoginResponse200 = {
+    data: MT4MarginLevelApiResponse;
+    status: 200;
+};
+export type getMarginLevelRequestLoginResponseSuccess = (getMarginLevelRequestLoginResponse200) & {
+    headers: Headers;
+};
+export type getMarginLevelRequestLoginResponse = (getMarginLevelRequestLoginResponseSuccess);
+export declare const getGetMarginLevelRequestLoginUrl: (tradePlatform: string, login: number) => string;
+/**
+ * Margin level for a single account — live round-trip to MT4 server.
+ *
+ * Manager variant — bypasses the pump cache and asks the MT4 server
+ * directly. Slower than `MarginLevelGet` but always fresh. Cost-
+ * equivalent to other live Manager calls (billed per request, unlike
+ * pump reads).
+ * @summary Get account margin (live)
+ */
+export declare const getMarginLevelRequestLogin: (tradePlatform: string, login: number, options?: RequestInit) => Promise<getMarginLevelRequestLoginResponse>;

package/dist/generated/mt4-v2-news.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { BooleanApiResponse, Int32ApiResponse, MT4NewsTopicApiResponse, MT4NewsTopicListApiResponse, StringApiResponse } from './model';
+export type getNewsTotalResponse200 = {
+    data: Int32ApiResponse;
+    status: 200;
+};
+export type getNewsTotalResponseSuccess = (getNewsTotalResponse200) & {
+    headers: Headers;
+};
+export type getNewsTotalResponse = (getNewsTotalResponseSuccess);
+export declare const getGetNewsTotalUrl: (tradePlatform: string) => string;
+/**
+ * Total number of news items currently held in the pumping cache.
+ *
+ * Pump-cached read — instant local lookup, no round-trip to MT4 server.
+ * Useful as a cheap polling probe before fetching news bodies.
+ * @summary Get news count
+ */
+export declare const getNewsTotal: (tradePlatform: string, options?: RequestInit) => Promise<getNewsTotalResponse>;
+export type getNewsBodyGetKeyResponse200 = {
+    data: StringApiResponse;
+    status: 200;
+};
+export type getNewsBodyGetKeyResponseSuccess = (getNewsBodyGetKeyResponse200) & {
+    headers: Headers;
+};
+export type getNewsBodyGetKeyResponse = (getNewsBodyGetKeyResponseSuccess);
+export declare const getGetNewsBodyGetKeyUrl: (tradePlatform: string, key: number) => string;
+/**
+ * Body text of a cached news item by its key.
+ *
+ * Pump-cached read — pair with `NewsTotal` and `NewsGet` (later)
+ * to enumerate cached news. The key is the news item id known to MT4.
+ * @summary Get news body (cached)
+ */
+export declare const getNewsBodyGetKey: (tradePlatform: string, key: number, options?: RequestInit) => Promise<getNewsBodyGetKeyResponse>;
+export type getNewsGetResponse200 = {
+    data: MT4NewsTopicListApiResponse;
+    status: 200;
+};
+export type getNewsGetResponseSuccess = (getNewsGetResponse200) & {
+    headers: Headers;
+};
+export type getNewsGetResponse = (getNewsGetResponseSuccess);
+export declare const getGetNewsGetUrl: (tradePlatform: string) => string;
+/**
+ * All cached news topic headers (no body — fetch separately).
+ *
+ * Pump-cached read — returns the full news topic table held by the
+ * pumping connection. Each entry is a header (Key, Time, Topic,
+ * Category, Keywords, Priority, LangId). Body text is fetched via
+ * `NewsBodyGet(key)` after asking the pump to populate it via
+ * `NewsBodyRequest(key)`.
+ * @summary List news headers
+ */
+export declare const getNewsGet: (tradePlatform: string, options?: RequestInit) => Promise<getNewsGetResponse>;
+export type getNewsTopicGetPosResponse200 = {
+    data: MT4NewsTopicApiResponse;
+    status: 200;
+};
+export type getNewsTopicGetPosResponseSuccess = (getNewsTopicGetPosResponse200) & {
+    headers: Headers;
+};
+export type getNewsTopicGetPosResponse = (getNewsTopicGetPosResponseSuccess);
+export declare const getGetNewsTopicGetPosUrl: (tradePlatform: string, pos: number) => string;
+/**
+ * Single cached news topic header by zero-based index.
+ *
+ * Pump-cached read — useful for paginating news without re-marshalling
+ * the whole array. Pair with `NewsTotal` to bound the index.
+ * Returns a wrapper-failure envelope when pos is
+ * out of range.
+ * @summary Get news header by index
+ */
+export declare const getNewsTopicGetPos: (tradePlatform: string, pos: number, options?: RequestInit) => Promise<getNewsTopicGetPosResponse>;
+export type postNewsBodyRequestKeyResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postNewsBodyRequestKeyResponseSuccess = (postNewsBodyRequestKeyResponse200) & {
+    headers: Headers;
+};
+export type postNewsBodyRequestKeyResponse = (postNewsBodyRequestKeyResponseSuccess);
+export declare const getPostNewsBodyRequestKeyUrl: (tradePlatform: string, key: number) => string;
+/**
+ * Ask the pump to fetch the body for the given news key (fire-and-forget).
+ *
+ * POST because this is a side-effect on the pump (it queues a fetch).
+ * The wrapper method returns `void` — there is no synchronous
+ * success/failure to surface. A subsequent `NewsBodyGet(key)` will
+ * see the body once the pump has retrieved it. The payload is a sentinel
+ * `true` meaning "request dispatched".
+ * @summary Request news body fetch
+ */
+export declare const postNewsBodyRequestKey: (tradePlatform: string, key: number, options?: RequestInit) => Promise<postNewsBodyRequestKeyResponse>;

package/dist/generated/mt4-v2-online.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { GetOnlineGetParams, GetOnlineRequestParams, MT4OnlineListApiResponse } from './model';
+export type getOnlineGetResponse200 = {
+    data: MT4OnlineListApiResponse;
+    status: 200;
+};
+export type getOnlineGetResponseSuccess = (getOnlineGetResponse200) & {
+    headers: Headers;
+};
+export type getOnlineGetResponse = (getOnlineGetResponseSuccess);
+export declare const getGetOnlineGetUrl: (tradePlatform: string, params?: GetOnlineGetParams) => string;
+/**
+ * Pump-cached snapshot of currently online users, paginated by login.
+ *
+ * Pump-cached read — instant local lookup, no MT4 round-trip. Sort
+ * order is the login ascending. `?limit=` caps the page size;
+ * without it the full set returns in one page. When the pump cache
+ * is not yet warmed (fresh connection) the response is a NoConnect
+ * error with a retry hint, not an empty list — empty list means
+ * "warmed but currently no online sessions".
+ * @summary List online users (cached)
+ */
+export declare const getOnlineGet: (tradePlatform: string, params?: GetOnlineGetParams, options?: RequestInit) => Promise<getOnlineGetResponse>;
+export type getOnlineRequestResponse200 = {
+    data: MT4OnlineListApiResponse;
+    status: 200;
+};
+export type getOnlineRequestResponseSuccess = (getOnlineRequestResponse200) & {
+    headers: Headers;
+};
+export type getOnlineRequestResponse = (getOnlineRequestResponseSuccess);
+export declare const getGetOnlineRequestUrl: (tradePlatform: string, params?: GetOnlineRequestParams) => string;
+/**
+ * Live snapshot of every currently-online session, fetched from the MT4 server (Manager round-trip — not pump cache).
+ *
+ * Manager (live) counterpart to `OnlineGet`. Useful when the pump
+ * cache hasn't warmed yet, when staleness is unacceptable, or as a
+ * reconciliation pass against the pump snapshot. Heavier than
+ * `OnlineGet`: every call hits the MT4 server. Paged the same way
+ * for caller symmetry — cursor is the trailing login (ascending).
+ * @summary List online sessions (live)
+ */
+export declare const getOnlineRequest: (tradePlatform: string, params?: GetOnlineRequestParams, options?: RequestInit) => Promise<getOnlineRequestResponse>;

package/dist/generated/mt4-v2-plugins.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { JsonNodeApiResponse } from './model';
+export type postExternalCommandJSONResponse200 = {
+    data: JsonNodeApiResponse;
+    status: 200;
+};
+export type postExternalCommandJSONResponseSuccess = (postExternalCommandJSONResponse200) & {
+    headers: Headers;
+};
+export type postExternalCommandJSONResponse = (postExternalCommandJSONResponseSuccess);
+export declare const getPostExternalCommandJSONUrl: (tradePlatform: string) => string;
+/**
+ * Plugin custom-command channel with JSON payload in both directions.
+ *
+ * Manager (live) call wrapping `ExternalCommandJSON`. The MT4
+ * server forwards the body to whichever installed plugin claims the
+ * command first; the first plugin returning `RET_OK` wins and its
+ * response becomes the v2 payload. The request body is sent verbatim
+ * (no field renaming, no schema enforcement) so the plugin author
+ * owns the over-the-wire contract on both ends.
+ *
+ * The wrapper trio (`ExternalCommand<TIn,TOut>` for binary
+ * marshal, `ExternalCommandCustom<T>` for caller-supplied
+ * serializer) is intentionally not exposed in v2 — those variants
+ * require compile-time struct layouts shared between client and
+ * plugin, which a REST surface cannot guarantee. Plugin developers
+ * who need binary transport should keep using the wrapper directly
+ * from the WebAPI process or build a dedicated binary endpoint.
+ *
+ * Idempotency-Key is strongly recommended — plugins may have side
+ * effects, and the channel itself gives no read-modify-write
+ * semantics.
+ * @summary Send plugin command (JSON)
+ */
+export declare const postExternalCommandJSON: (tradePlatform: string, options?: RequestInit) => Promise<postExternalCommandJSONResponse>;

package/dist/generated/mt4-v2-prices.d.ts

@@ -0,0 +1,175 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { BooleanApiResponse, GetChartRequestSymbolParams, GetTicksRequestSymbolParams, Int32ApiResponse, MT4ChartBarListApiResponse, MT4ChartWriteRequest, MT4TickInfoApiResponse, MT4TickInfoListApiResponse, MT4TickRecordListApiResponse, PostChartAddSymbolParams, PostChartDeleteSymbolParams, PostChartUpdateSymbolParams } from './model';
+export type getChartRequestSymbolResponse200 = {
+    data: MT4ChartBarListApiResponse;
+    status: 200;
+};
+export type getChartRequestSymbolResponseSuccess = (getChartRequestSymbolResponse200) & {
+    headers: Headers;
+};
+export type getChartRequestSymbolResponse = (getChartRequestSymbolResponseSuccess);
+export declare const getGetChartRequestSymbolUrl: (tradePlatform: string, symbol: string, params?: GetChartRequestSymbolParams) => string;
+/**
+ * OHLC chart bars for a symbol over a date range.
+ *
+ * Manager (live) call. Resolves the symbol's `ConSymbol` first
+ * (needed by the wrapper to set scale/digits), then asks for bars of
+ * the given `period` in the date window. `mode` defaults to
+ * `RangeInExcludeOutOfRage` — bars whose time falls strictly
+ * inside the window.
+ * @summary Get chart bars
+ */
+export declare const getChartRequestSymbol: (tradePlatform: string, symbol: string, params?: GetChartRequestSymbolParams, options?: RequestInit) => Promise<getChartRequestSymbolResponse>;
+export type postChartAddSymbolResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postChartAddSymbolResponseSuccess = (postChartAddSymbolResponse200) & {
+    headers: Headers;
+};
+export type postChartAddSymbolResponse = (postChartAddSymbolResponseSuccess);
+export declare const getPostChartAddSymbolUrl: (tradePlatform: string, symbol: string, params?: PostChartAddSymbolParams) => string;
+/**
+ * Append OHLC bars to a symbol's chart history — POST destructive.
+ *
+ * Manager (live) call that appends the provided bars to the symbol's
+ * historical chart for the given `period`. The wrapper looks up the
+ * symbol's scale (`Multiply`/`Digits`) internally to encode the
+ * float OHLC values back into native integer prices.
+ *
+ * Idempotency-Key strongly recommended — duplicate writes can corrupt the
+ * historical data series.
+ * @summary Add chart bars
+ */
+export declare const postChartAddSymbol: (tradePlatform: string, symbol: string, mT4ChartWriteRequest?: MT4ChartWriteRequest, params?: PostChartAddSymbolParams, options?: RequestInit) => Promise<postChartAddSymbolResponse>;
+export type postChartUpdateSymbolResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postChartUpdateSymbolResponseSuccess = (postChartUpdateSymbolResponse200) & {
+    headers: Headers;
+};
+export type postChartUpdateSymbolResponse = (postChartUpdateSymbolResponseSuccess);
+export declare const getPostChartUpdateSymbolUrl: (tradePlatform: string, symbol: string, params?: PostChartUpdateSymbolParams) => string;
+/**
+ * Overwrite existing OHLC bars in a symbol's chart history — POST destructive.
+ *
+ * Manager (live) call. Replaces bars at the timestamps provided in
+ * `Rates` for the given `period`. Bars whose timestamps don't
+ * match an existing bar are silently ignored by the MT4 server.
+ *
+ * Idempotency-Key strongly recommended.
+ * @summary Update chart bars
+ */
+export declare const postChartUpdateSymbol: (tradePlatform: string, symbol: string, mT4ChartWriteRequest?: MT4ChartWriteRequest, params?: PostChartUpdateSymbolParams, options?: RequestInit) => Promise<postChartUpdateSymbolResponse>;
+export type postChartDeleteSymbolResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postChartDeleteSymbolResponseSuccess = (postChartDeleteSymbolResponse200) & {
+    headers: Headers;
+};
+export type postChartDeleteSymbolResponse = (postChartDeleteSymbolResponseSuccess);
+export declare const getPostChartDeleteSymbolUrl: (tradePlatform: string, symbol: string, params?: PostChartDeleteSymbolParams) => string;
+/**
+ * Delete OHLC bars from a symbol's chart history — POST destructive.
+ *
+ * Manager (live) call. Removes bars whose `Time` matches the
+ * entries in `Rates` for the given `period`. Only the bar
+ * timestamp is consulted server-side; OHLC values can be zero.
+ *
+ * Idempotency-Key strongly recommended — silently repeating a delete on
+ * already-removed bars is harmless, but accidental double-submit could
+ * nudge audit logs with extra "operation requested" entries.
+ * @summary Delete chart bars
+ */
+export declare const postChartDeleteSymbol: (tradePlatform: string, symbol: string, mT4ChartWriteRequest?: MT4ChartWriteRequest, params?: PostChartDeleteSymbolParams, options?: RequestInit) => Promise<postChartDeleteSymbolResponse>;
+export type postHistoryCorrectSymbolResponse200 = {
+    data: Int32ApiResponse;
+    status: 200;
+};
+export type postHistoryCorrectSymbolResponseSuccess = (postHistoryCorrectSymbolResponse200) & {
+    headers: Headers;
+};
+export type postHistoryCorrectSymbolResponse = (postHistoryCorrectSymbolResponseSuccess);
+export declare const getPostHistoryCorrectSymbolUrl: (tradePlatform: string, symbol: string) => string;
+/**
+ * Recompute and patch internal consistency of a symbol's chart history.
+ *
+ * Manager (live) call. The MT4 server walks the symbol's full bar
+ * history for every period and fixes inconsistencies (gaps, broken
+ * OHLC relationships, mismatched aggregates). Returns the count of
+ * bars that the server corrected — zero is a valid result (history
+ * was already consistent).
+ *
+ * Requires Administrator rights on the manager account. The operation
+ * can take many seconds on long histories; pair with
+ * `Idempotency-Key` for retry safety so a TCP retry doesn't
+ * kick off a second full sweep.
+ * @summary Repair chart history
+ */
+export declare const postHistoryCorrectSymbol: (tradePlatform: string, symbol: string, options?: RequestInit) => Promise<postHistoryCorrectSymbolResponse>;
+export type getTicksRequestSymbolResponse200 = {
+    data: MT4TickRecordListApiResponse;
+    status: 200;
+};
+export type getTicksRequestSymbolResponseSuccess = (getTicksRequestSymbolResponse200) & {
+    headers: Headers;
+};
+export type getTicksRequestSymbolResponse = (getTicksRequestSymbolResponseSuccess);
+export declare const getGetTicksRequestSymbolUrl: (tradePlatform: string, symbol: string, params?: GetTicksRequestSymbolParams) => string;
+/**
+ * Historical ticks for a symbol over a date range.
+ *
+ * Manager (live) call returning a list of `MT4TickRecord` DTOs.
+ * `flags` controls whether raw and/or normalised ticks are
+ * included (defaults to `All`). Heavy endpoint — pair with
+ * `Idempotency-Key` for retry safety.
+ * @summary Get historical ticks
+ */
+export declare const getTicksRequestSymbol: (tradePlatform: string, symbol: string, params?: GetTicksRequestSymbolParams, options?: RequestInit) => Promise<getTicksRequestSymbolResponse>;
+export type getTickInfoLastSymbolResponse200 = {
+    data: MT4TickInfoApiResponse;
+    status: 200;
+};
+export type getTickInfoLastSymbolResponseSuccess = (getTickInfoLastSymbolResponse200) & {
+    headers: Headers;
+};
+export type getTickInfoLastSymbolResponse = (getTickInfoLastSymbolResponseSuccess);
+export declare const getGetTickInfoLastSymbolUrl: (tradePlatform: string, symbol: string) => string;
+/**
+ * Last known bid/ask tick for a single symbol from the pump cache.
+ *
+ * Pump-cached read of the last tick. For sub-second updates prefer the
+ * SignalR tick stream over polling. Returns NotFound envelope when the
+ * pump cache has no tick for the requested symbol (symbol not in the
+ * active subscription set, or the platform has never received a tick
+ * since startup).
+ * @summary Get last tick (cached)
+ */
+export declare const getTickInfoLastSymbol: (tradePlatform: string, symbol: string, options?: RequestInit) => Promise<getTickInfoLastSymbolResponse>;
+export type getTickInfoLastResponse200 = {
+    data: MT4TickInfoListApiResponse;
+    status: 200;
+};
+export type getTickInfoLastResponseSuccess = (getTickInfoLastResponse200) & {
+    headers: Headers;
+};
+export type getTickInfoLastResponse = (getTickInfoLastResponseSuccess);
+export declare const getGetTickInfoLastUrl: (tradePlatform: string) => string;
+/**
+ * Last known bid/ask tick for ALL symbols in the pump cache.
+ *
+ * Snapshot of every symbol the pump has received quotes for. Empty list
+ * when no quotes have been received yet. For sub-second updates use the
+ * SignalR tick stream — this endpoint is intended for one-shot snapshots
+ * (warm-up, monitoring dashboards, idempotent cache scenarios).
+ * @summary Get last ticks, all symbols (cached)
+ */
+export declare const getTickInfoLast: (tradePlatform: string, options?: RequestInit) => Promise<getTickInfoLastResponse>;