Управление идентификаторами — «Справочники»

Версия 1.0.0

Авторские права © 2025 ПАО Московская Биржа

Содержание

Управление идентификаторами — «Справочники»

Введение

История изменений

Описание кодов ответов

1. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/logins

actionTypes

orderTypes

icdbAgentTypes

clearingAgentTypes

restrOnTradeModes

restrictionUseAll

connectionTypeBillings

terminalTypes

connectionTypes

orderConnectionTypes

vptsConnectionTypes

interfaceLanguage

authorities

tradeModes

markets

instrumentRestrictions

instrumentTypes

fortsConnectionTypes

ukUtForms

loginLevels

streams

tsAstsPlazas

directConnection

2. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/groups/{marketId}

3. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/orders

4. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/orders/prefill/{marketId}

5. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/status

6. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/ip

7. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/orders/client/codes/{marketId}

8. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/orders/trd/accids/{marketId}

9. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/certificates

10. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/instruments

11. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/clearing/broker/attributes

12. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/chapter

13. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/vpts

Введение

Этот документ представляет собой подробное руководство для получения справочных данных при работе с идентификаторами на бирже. Руководство содержит описание методов API, которые позволяют получать справочные данные, например группы пользователей, статусы заявок, списки ТКС клиентов, IP-адреса и другое. Эти методы упрощают процесс заполнения заявлений на идентификаторы.

История изменений

Версия

 Описание

Дата обновления

1.0

Документ создан

07.02.2025

Описание кодов ответов

Описание кодов ответов HTTP

Статус код Тип Сообщение Описание
2xx - Успешные
200 ОК Успешно

Операция выполнена успешно.

Например, GET: Запрошенный ресурс был найден и передан в теле ответа.

Указывает на успешное выполнение запроса. Это означает, что сервер получил и обработал запрос корректно, и клиент может ожидать получения запрошенных данных или выполнения действия
201 CREATED Запрос успешно выполнен, и в результате был создан ресурс

При создании ресурса в ответе может быть включен заголовок Location, который указывает URL нового ресурса. Это позволяет клиенту сразу узнать, где он может получить доступ к созданному ресурсу.

В теле ответа содержится информация о созданном ресурсе, например, его уникальный идентификатор
204 NO CONTENT Нет содержимого для ответа на запрос Сервер успешно обработал запрос, но в ответе были переданы только заголовки без тела сообщения. Клиент не должен обновлять содержимое документа, но может применить к нему полученные метаданные
4xx - Клиентские ошибки
400 BAD REQUEST Некорректный запрос. Убедитесь, что адрес указан верно и попробуйте еще раз Не были переданы обязательные входные параметры, или во входных параметрах были переданы невалидные данные
401 UNAUTHORIZED Ошибка авторизации. Для доступа к запрашиваемому ресурсу требуется аутентификация Если не переданы или недействительны данные для аутентификации, а также при неуспешной валидации токена
5xx - Серверные ошибки
500 INTERNAL SERVER ERROR Внутренняя ошибка сервера. Подождите несколько минут и попробуйте снова Ошибка на стороне сервера. Сервер обнаружил неожиданное условие, которое не может обработать
502 BAD GATEWAY Плохой шлюз Сервер, действующий как шлюз или прокси-сервер, столкнулся с проблемой при попытке установить связь с вышестоящим сервером. Это ошибка на стороне сервера, и клиент обычно не может устранить ее напрямую

Выходные параметры при ошибке

Параметр Тип данных JSON Обязательность Описание параметра
statuscode integer Да Код состояния HTTP
exception string Да Сообщение об ошибке
response string Да Описание ошибки

Пример запроса с ошибкой

{
   "statuscode": "integer",
   "exception ": "string",
   "response": "string"
}

1. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/logins

Получение списка справочников, необходимых для работы с заявлениями на идентификаторы.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры:

Параметр Тип данных Обязательность Может быть null Наименование Комментарий  Пример значения
data object Нет
actionTypes array Нет Да Справочник действий пользователя с IP

{

  "actionTypes": [

     {

       "value": "Добавить", 

       "code": "ADD"

}

    ]
}
value string Нет Да Значение элемента Структура справочника "value": "Заявка на изменение полномочий идентификатора (ФР, РД, РК)"
code string Нет Да Код элемента справочника Структура справочника "code": "ORDER_CHANGE_SM_LOGIN"
orderTypes array Нет Да Справочник типов заявок на идентификаторы {
    "orderTypes": [
        {
            "value": "Заявка на присвоение идентификатора (ФР, РД, РК)",
            "code": "ORDER_ASSIGNING_SM_LOGIN"
        }
    ]
}
icdbAgentTypes array Нет Да Справочник полномочий пользователя в ЕКБД  {
    "icdbAgentTypes": [
        {
            "value": "MOEX Dealing",
            "code": "MOEX_DEALING_2"
        }
    ]
}
clearingAgentTypes array Нет Да Справочник полномочий Клирингового идентификатора на ФР {
    "clearingAgentTypes": [
        {
            "market": 1,
            "isPureClearing": null,
            "value": "Клиринговый менеджер",
            "code": "CLEARING_MANAGER_1"
        }
    ]
}
restrictionRoles array Нет Да Справочник ролей идентификатора в зависимости от ограничений
restrOnTradeModes array Нет Да Справочник ограничений по режимам торгов {
    "restrOnTradeModes": [
        {
            "astsMarketsListForEtoSm": [
                "FOND",
                "FNDT",
                "RPS",
                "RPST",
                "REPT"
            ]
        }
    ]
}
restrictionUseAll array Нет Да Справочник действий с ТКС {
    "restrictionUseAll": [
        {
            "value": "Использовать со всеми ТКС",
            "code": "USE_ALL"
        }
    ]
}
connectionTypeBillings array Нет Да Справочник значений "Тип терминала для биллинга" {
    "connectionTypeBillings": [
        {
            "value": "Personal ASTS Bridge",
            "code": "PERSONAL_ASTS_BRIDGE"
        }
    ]
}
terminalTypes array Нет Да Справочник значений "Тип терминала" {
    "terminalTypes": [
        {
            "value": "Терминал",
            "code": "TERMINAL"
        },
        {
            "value": "MOEX Trade SE",
            "code": "MOEX_TRADE_SE"
        }
    ]
}
connectionTypes array Нет Да Справочник типов подключения {
    "connectionTypes": [
        {
            "value": "MICEX Trade Currency",
            "code": "MICEX_TRADE_CURRENCY"
        }
    ]
}
orderConnectionTypes array Нет Да Справочник типов подключения (Order)  {
    "orderConnectionTypes": [
        {
            "value": "MOEX Trade SE",
            "code": "MOEX_TRADE_SE"
        }
    ]
}
vptsConnectionTypes array Нет Да Справочник типов подключения ВПТС  {
    "vptsConnectionTypes": [
        {
            "market": 1,
            "postfix": "ND",
            "actualOnSm": false,
            "actualOnMm": false,
            "actualOnCm": false,
            "actualOnCreditM": false,
            "actualOnUniversalM": false,
            "value": "ND",
            "code": "ND_1"
        }
    ]
}
vptsNonPublic array Нет Да Справочник непубличных ВПТС
interfaceLanguage array Нет Да Справочник языков {
    "interfaceLanguage": [
        {
            "value": "Русский язык",
            "code": "RUS"
        }
    ]
}
markets array Нет Да Справочник рынков {
    "markets": [
        {
            "value": "Фондовый рынок",
            "code": "MRKT_STOCK_MARKET"
        },
        {
            "value": "Валютный рынок",
            "code": "MRKT_CURRENCY_MARKET"
        }
    ]
}
authorities array Нет Да Справочник полномочий к торгам {
    "authorities": [
        {
            "value": "В качестве наблюдателей",
            "code": "OBSERVER"
        },
        {
            "value": "Аннулировать статус поставщика",
            "code": "REVOKE_PRODUCER_STATUS"
        }
    ]
}
tradeModes array Нет Да Справочник торговых режимов  {
    "tradeModes": [
        {
            "value": "Сделки спот и сделки своп (Системный режим CETS)",
            "code": "CETSN"
        },
        {
            "value": "Сделки с поставочными своп контрактами со стандартными периодами исполнения обязательств по второй части своп контракта (Системный режим CETS)",
            "code": "CETSY"
        }
    ]
}
InstrumentRestriction array Нет Да Справочник ограничений по использованию торговых инструментов {
    "instrumentRestrictions": [
        {
            "value": "Предоставить из выбранного списка",
            "code": "SOME"
        },
        {
            "value": "Предоставить без ограничений (Предоставить по всем инструментам группы)",
            "code": "ALL"
        }
    ]
}
InstrumentTypes array Нет Да Справочник типов и долгосрочности инструментов {
    "instrumentTypes": [
        {
            "value": "СПОТ",
            "code": "SPOT"
        },
        {
            "value": "СВОП",
            "code": "SWAP"
        }
    ]
}
directConnection array Нет Да Справочник подключений {
  "directConnection":[ 
    { "value": "Прямое подключение терминала через Интернет", "code": "DIRECT_CONNECT_OPTIONS" }, 
    { "value": "Прямое подключение через Выделенный канал,Colocation,шлюз Personal ASTSBridge", 
     "code": "DIRECT_CONNECT_OPTIONS_COLOCATION"
    }
    ]
}
fortsConnectionTypes array Нет Да Справочник типов подключения идентификатора на срочном рынке {
    "fortsConnectionTypes": [
        {
            "mcdbId": 150,
            "value": "Fix Gate",
            "code": "LOGIN_FIX_PII"
        }
    ]
}
ukUtForm array Нет Да Справочник формы УК-УТ {
    "ukUtForms": [
        {
            "value": "УТ",
            "code": "UT"
        },
        {
            "value": "УК",
            "code": "UK"
        }
    ]
}
loginLevel array Нет Да Справочник уровней идентификатора {
    "loginLevels": [
        {
            "tcsValue": 0,
            "actualOnFm": true,
            "value": "Главный",
            "code": "BASIC"
        }
    ]
}
streams array Нет Да Справочник потоков для FIX Drop-Copy {
    "streams": [
        {
            "value": "Сделки",
            "code": "TRANSACTIONS"
        }
    ]
}
tsAstsPlaza array Нет Да Справочник потоков ASTS {
    "tsAstsPlazas": [
        {
            "value": "Фондовый",
            "code": "STOCK"
        }
    ]
}

actionTypes

value code
Добавить ADD
Заменить CHANGE
Удалить DELETE
Удалить способ подключения DELETE_CONNECT_METHOD
Изменить факторы CHANGE_2FA

orderTypes

value code
Заявка на присвоение идентификатора (ФР, РД, РК) ORDER_ASSIGNING_SM_LOGIN
Заявка на изменение полномочий идентификатора (ФР, РД, РК) ORDER_CHANGE_SM_LOGIN
Заявка на аннулирование идентификатора (ФР, РД, РК) ORDER_CANCEL_SM_LOGIN
Заявка на присвоение ИСД идентификатора (ФР) ORDER_ASSIGNING_SM_LOGIN_ISD
Заявка на изменение ИСД идентификатора (ФР) ORDER_CHANGE_SM_LOGIN_ISD
Заявка на присвоение идентификатора (ВР) ORDER_ASSIGNING_FX_LOGIN
Заявка на изменение идентификатора (ВР) ORDER_CHANGE_FX_LOGIN
Заявка на аннулирование идентификатора (ВР) ORDER_CANCEL_FX_LOGIN
Заявка на присвоение ИСД (ВР) ORDER_ASSIGNING_FX_LOGIN_ISD
Заявка на изменение ИСД (ВР) ORDER_CHANGE_FX_LOGIN_ISD
Сбросить пароль для идентификаторов ORDER_PASSWORD_RESET_ONLINE
Заявка на присвоение идентификатора (СР) ORDER_ASSIGNING_FO_LOGIN
Заявка на изменение идентификатора (СР) ORDER_CHANGE_FO_LOGIN
Заявка на аннулирование идентификатора (СР) ORDER_CANCEL_FO_LOGIN
Заявка на присвоение ИСД (СР) ORDER_ASSIGNING_FO_LOGIN_ISD
Заявка на изменение ИСД (СР) ORDER_CHANGE_FO_LOGIN_ISD
Заявка на присвоение идентификатора (ДР) ORDER_ASSIGNING_MO_LOGIN
Заявка на изменение идентификатора (ДР) ORDER_CHANGE_MO_LOGIN
Заявка на аннулирование идентификатора (ДР) ORDER_CANCEL_MO_LOGIN

icdbAgentTypes

value code
MOEX Dealing MOEX_DEALING_2
Торговый идентификатор TRADING_30
Просмотровый идентификатор - Анализ VIEWING_ANALYSIS_30
Просмотровый идентификатор - Наблюдение VIEWING_OBSERVE_30
Просмотровый идентификатор - Наблюдение VIEWING_OBSERVE_1
Торговый идентификатор TRADING_21
Просмотровый идентификатор VIEWING_21
Торговый идентификатор TRADING_1
Просмотровый идентификатор - Анализ VIEWING_ANALYSIS_1
Просмотровый идентификатор VIEWING_19
Торговый идентификатор - Трейдер TRADING_TRADER_1
Торговый идентификатор TRADING_2
Просмотровый идентификатор VIEWING_2
Идентификатор РЕЙТЕР REUTERS_2
Идентификатор Блумберг BLOOMBERG_2
Торговый идентификатор TRADING_19
Клиринговый CLEARING_2
Торговый TRADING_28
Просмотровый VIEWING_28
OTC OTC_3
Транзакционный TRANSACTIONAL_17
Просмотровый VIEWING_17
Трейдер TRADER_27
Наблюдатель OBSERVER_27
Торговый идентификатор TRADING_29
Просмотровый идентификатор - Анализ VIEWING_ANALYSIS_29
Просмотровый идентификатор - Наблюдение VIEWING_OBSERVE_29
Основной MAIN_3
Транзакционный TRANSACTIONAL_3
Просмотровый VIEWING_3
Торговый идентификатор TRADING_23
Просмотровый идентификатор VIEWING_23
Идентификатор доступа ACCESS_26
Торговый ВПТС TRADING_VPTS
Просмотровый ВПТС - Аналитик VIEWING_VPTS_ANALYTIC
Просмотровый ВПТС - Наблюдатель VIEWING_VPTS_OBSERVER
Просмотровый идентификатор ВПТС VIEWING_VPTS
Drop Copy DROP_COPY

clearingAgentTypes

Market isPureClearing value code
1 null Клиринговый менеджер CLEARING_MANAGER_1
1 null Оператор OPERATOR_1
1 null Переводы TRANSFER_1
1 null Оператор и Переводы OPERATOR_AND_TRANSFER_1
2 null Клиринговый менеджер CLEARING_MANAGER_2
2 null Оператор OPERATOR_2
2 null Оператор и Переводы OPERATOR_AND_TRANSFER_2
29 null Клиринговый менеджер CLEARING_MANAGER_29
29 null Оператор OPERATOR_29
29 null Переводы TRANSFER_29
29 null Оператор и Переводы OPERATOR_AND_TRANSFER_29
23 null Клиринговый менеджер CLEARING_MANAGER_23
23 null Оператор OPERATOR_23
23 null Переводы TRANSFER_23
23 null Оператор и Переводы OPERATOR_AND_TRANSFER_23
30 null Клиринговый менеджер CLEARING_MANAGER_30
30 null Оператор OPERATOR_30
30 null Переводы TRANSFER_30
30 null Оператор и Переводы OPERATOR_AND_TRANSFER_30
2 true Reuters клиринговый REUTERS_CLEARING_2
2 true Bloomberg клиринговый BLOOMBERG_CLEARING_2

restrOnTradeModes

astsMarketsListForEtoSm astsMarketsSkipForEtoSm value code
FOND, FNDT, RPS, RPST, REPT GCDP, DEPZ, TECH, CRED все режимы (без ограничений) HROTM_NONE
FOND GCDP, DEPZ, TECH, CRED только режим основных торгов HROTM_FOND
FNDT GCDP, DEPZ, TECH, CRED только режим основных торгов Т+ HROTM_FNDT
REPT GCDP, DEPZ, TECH, CRED только режим РЕПО с ЦК HROTM_REPT
FOND, FNDT GCDP, DEPZ, TECH, CRED только режим основных торгов, режим основных торгов Т+ HROTM_FOND_FNDT
FOND, FNDT, REPT GCDP, DEPZ, TECH, CRED только режим основных торгов, режим основных торгов Т+, режим РЕПО с ЦК HROTM_FOND_FNDT_REPT

restrictionUseAll

value code
Использовать со всеми ТКС USE_ALL
Использовать только со следующими ТКС USE_SELECTED
Добавить к используемым следующие ТКС ADD_SELECTED
Удалить следующие ТКС из перечня используемых DELETE_SELECTED

connectionTypeBillings

value code
Personal ASTS Bridge PERSONAL_ASTS_BRIDGE
Hosted ASTS Bridge (CLT) HOSTED_ASTS_BRIDGE_CLT
Hosted ASTS Bridge (POP) HOSTED_ASTS_BRIDGE_POP
Hosted ASTS Bridge (Интернет) HOSTED_ASTS_BRIDGE_INTERNET
MFIX Transactional MFIX_TRANSACTIONAL
FIX GATE SPECTRA FIX_GATE_SPECTRA
FIX Dropcopy SPECTRA FIX_DROPCOPY_SPECTRA
TWIME SPECTRA TWIME_SPECTRA
SPECTRA шлюз двунаправленный SPECTRA_GATEWAY_BIDIR
SPECTRA шлюз однонаправленный транзакционный SPECTRA_GATEWAY_UNIDIR
SPECTRA шлюз однонаправленный просмотровый SPECTRA_GATEWAY_UNIDIR_VIEWING
MOEX Trade SE MOEX_TRADE_SE
MOEX Trade SE + Hosted ASTS Bridge (CLT/Pop) MOEX_TRADE_SE_ASTS
MOEX Trade Currency MOEX_TRADE_CURRENCY
MOEX Trade Currency + Hosted ASTS Bridge (CLT/Pop) MOEX_TRADE_CURRENCY_ASTS
MOEX Trade TI MOEX_TRADE_TI
MOEX Trade TI + Hosted ASTS Bridge (CLT/Pop) MOEX_TRADE_TI_ASTS
Универсальное рабочее место СМА UNIVERSAL_WORK_SPACE_SMA
MOEX Trade SE + CMA MOEX_TRADE_SE_CMA
MOEX Trade Currency + CMA MOEX_TRADE_CURRENCY_CMA
MOEX Trade TI + CMA MOEX_TRADE_TI_CMA
SPECTRA терминал SPECTRA_TERMINAL
Блумберг BLOOMBERG
РЕЙТЕР REUTERS
NAVIGATOR Терминал NAVIGATOR_TERMINAL
MFIX FIFO TRADE MFIX_FIFO_TRADE
Терминал TERMINAL
Шлюз GATEWAY
NAVIGATOR FIX NAVIGATOR_FIX
NAVIGATOR Шлюз NAVIGATOR_GATEWAY
FIFO TWIME ASTS FIFO_TWIME_ASTS
EMPTY_PLACEHOLDER_IN_1C EMPTY_PLACEHOLDER_IN_1C
FIX OTC SPECTRA FIX_OTC_SPECTRA
TWIME ASTS TWIME_ASTS
WEB2L основной WEB2L_MAIN
WEB2L резервный WEB2L_BACKUP
DF Server DF_SERVER

terminalTypes

value code
Терминал TERMINAL
MOEX Trade SE MOEX_TRADE_SE
MICEX SE Analytic MICEX_SE_ANALYTIC
Универсальное рабочее место CMA UNIVERSAL_WORK_SPACE_CMA
MOEX Trade SE + CMA MOEX_TRADE_SE_CMA
MOEX Trade Currency + CMA MOEX_TRADE_CURRENCY_CMA
MOEX Trade Currency MOEX_TRADE_CURRENCY
MICEX Currency Analytic MICEX_CURRENCY_ANALYTIC
MOEX Trade TI MOEX_TRADE_TI
MOEX Trade TI + CMA MOEX_TRADE_TI_CMA
MOEX Trade Agro MOEX_TRADE_AGRO

connectionTypes

value code
MICEX Trade Currency MICEX_TRADE_CURRENCY
АРМ (разработка СМА) ARM
ВПТС VPTS

orderConnectionTypes

value code
MOEX Trade SE MOEX_TRADE_SE
ВПТС VPTS
MOEX Trade Currency MOEX_TRADE_CURRENCY
MOEX Spectra Terminal MOEX_SPECTRA_TERMINAL
PLAZAII шлюз PLAZAII_GATE
Fix Gate FIX_GATE
TWIME TWIME
MOEX Trade TI MOEX_TRADE_TI

vptsConnectionTypes

market postfix actualOnSm actualOnMm actualOnCm actualOnCreditM actualOnUniversalM value code
1 ND False False False False False ND ND_1
1 FIX False False False False False FIX FIX_1
1 TEAP False False False False False TEAP TEAP_1
1 А False False False False False А A_1
1 B False False False False False B B_1
1 И False False False False False И I_1
1 DF False False False False False DF DF_1
1 TE False False False False False TE TE_1
2 TEAP False False False False False TEAP TEAP_2
2 TE False False False False False TE TE_2
2 FIX False False False False False FIX FIX_2
2 DF False False False False False DF DF_2
2 И False False False False False И I_2
2 B False False False False False B B_2
19 ND False False False False False ND ND_19
19 TEAP False False False False False TEAP TEAP_19
19 А False False False False False А A_19
19 B False False False False False B B_19
19 И False False False False False И I_19
19 DF False False False False False DF DF_19
19 TE False False False False False TE TE_19
1 WEB2L ИТО False False False False False WEB2L ИТО WEB2L_ITO_1
1 Bridge ИТО False False False False False Bridge ИТО BRIDGE_ITO_1
2 WEB2L ИТО False False False False False WEB2L ИТО WEB2L_ITO_2
2 Bridge ИТО False False False False False Bridge ИТО BRIDGE_ITO_2
19 WEB2L ИТО False False False False False WEB2L ИТО WEB2L_ITO_19
19 Bridge ИТО False False False False False Bridge ИТО BRIDGE_ITO_19
null Personal ASTS Bridge True True True True True Personal ASTS Bridge PERSONAL_ASTS_BRIDGE
null DFServer True True True True True DFServer DFSERVER
null MFIX Transactional True False True True True MFIX Transactional MFIX_TRANSACTIONAL
null Hosted ASTSBridge (CLT) True True True True True Hosted ASTSBridge (CLT) HOSTED_ASTS_BRIDGE_CLT
null Hosted ASTSBridge (POP) True False True True True Hosted ASTSBridge (POP) HOSTED_ASTS_BRIDGE_POP
null Hosted ASTSBridge (Интернет) True True True True True Hosted ASTSBridge (Интернет) HOSTED_ASTS_BRIDGE_INTERNET
null WEB2L основной True True True True True WEB2L основной WEB2L_MAIN
null WEB2L резереный True True True True True WEB2L резереный WEB2L_RESERVE
null Шлюз False False False False False Шлюз GATEWAY
null MFIX FIFO TRADE True False True True True MFIX FIFO TRADE MFIX_FIFO_TRADE
null FIFO TWIME ASTS True False True True True FIFO TWIME ASTS FIFO_TWIME_ASTS
null TWIME ASTS True False True True True TWIME ASTS TWIME_ASTS

interfaceLanguage

value code
Русский язык RUS
Английский язык ENG

authorities

value code
В качестве наблюдателей OBSERVER
Аннулировать статус поставщика REVOKE_PRODUCER_STATUS
Поставщик PRODUCER
В качестве наблюдателей и в качестве поставщиков и потребителей OBSERVER_PRODUCER_CONSUMER
В качестве наблюдателей и на заключение внебиржевых сделок OBSERVER_PRODUCER
В качестве наблюдателей и в качестве потребителей OBSERVER_CONSUMER
Закрыть режим CLOSE_MODE

tradeModes

value code
Сделки спот и сделки своп (Системный режим CETS) CETSN
Сделки с поставочными своп контрактами со стандартными периодами исполнения обязательств по второй части своп контракта (Системный режим CETS) CETSY
Сделки по инструменту USDRUB_DIS при проведении дискретного аукциона (при разрешенном USDRUB_TOM) CETSS
Сделки фикс (Системный режим FIXS) FIXS
Средневзвешенные сделки (Системный режим WAPS) WAPS
Сделки спот (Системный режим SDBP) SDBP
Сделки спот и сделки своп (Внесистемный режим CNGD и LICU) CNGDN
Сделки с поставочными своп контрактами со стандартными периодами исполнения обязательств по второй части своп контракта и поставочными фьючерсными контрактами с возможностью выбора даты исполнения обязательств (Внесистемный режим CNGD) CNGDY
Сделки фикс (Внесистемный режим FIXN) FIXN
Средневзвешенные сделки (Внесистемный режим WAPN) WAPN
Возможность заключения сделок своп в режиме торгов «Аукцион с Банком России» на валютном рынке и рынке драгоценных металлов AUCB
Внебиржевые сделки с иностранной валютой / драгоценными металлами, в которых одним из конечных контрагентов является Провайдер ликвидности (OTCT) OTCT
Возможность заключения Внебиржевых сделок спот и сделок своп с иностранной валютой (аукцион RFS) RFSM
Возможность предоставления на клиринг с центральным контрагентом Внебиржевых сделок спот и сделок своп с иностранной валютой (CPCL) CPCL

markets

value code
Фондовый рынок MRKT_STOCK_MARKET
Валютный рынок MRKT_CURRENCY_MARKET
Срочный рынок МБ MRKT_FORTS_MARKET
Срочный рынок ММВБ MRKT_CURRENCY_DERIVATIVE_MARKET
Срочный рынок ФБ ММВБ MRKT_STOCK_DERIVATIVE_MARKET
Срочный рынок НТБ MRKT_NCE_COMMODITY_DERIVATIVE_MARKET
Рынок государственных бумаг и РЕПО MRKT_MONEY_GOVERNMENT_MARKET
Рынок кредитов Банка России без обеспечения MRKT_MONEY_CBR_UNSEC_LOAN_MARKET
Рынок депозитов Банка России MRKT_MONEY_CBR_DEPOSIT_MARKET
Рынок ломбардных кредитов Банка России MRKT_MONEY_CBR_CREDIT_MARKET
Рынок прямого внебиржевого РЕПО Банка России MRKT_MONEY_CBR_OFFEX_REPO_MARKET
Рынок депозитов Внешэкономбанка MRKT_MONEY_VEB_DEPOSIT_MARKET
Рынок государственных сберегательных облигаций MRKT_MONEY_SAVING_BONDS_MARKET
Депозиты Федерального казначейства MRKT_MONEY_FT_DEPOSIT_MARKET
Пенсионный фонд MRKT_MONEY_PF_DEPOSIT_MARKET
Первичный рынок MRKT_PRIMARY_MARKET
Рынок СПФИ MRKT_OTC_SPFI_MARKET
Товарный рынок НТБ MRKT_NCE_COMMODITY_MARKET
М-Депозиты MRKT_M_DEPOSIT_MARKET
MOEX Board MRKT_MOEX_BOARD_MARKET
Товарный рынок Урожай MRKT_CROP_MARKET
Денежный рынок MRKT_MONEY_MARKET
Рынок депозитов MRKT_DEPOSIT_MARKET
Элеватор/Склад MRKT_ELEVATOR_WAREHOUSE_MARKET
РЕПО с Федеральным Казначейством MRKT_MONEY_FT_REPO_MARKET
Рынок ОТС MRKT_OTC_PLATFORM_MARKET
Корпоративный маркетплейс MRKT_CMP_PLATFORM_MARKET
Рынок Спот-торги НТБ MRKT_NCE_SPOT_MARKET
Рынок кредитов MRKT_CREDIT_MARKET
ФР, РД, РК MRKT_STOCK_DEPOSIT_CREDIT_MARKET

instrumentRestrictions

value code
Предоставить из выбранного списка SOME
Предоставить без ограничений ALL
Не предоставлять UNAVAILABLE

instrumentTypes

value code
СПОТ SPOT
СВОП SWAP
Forward FORWARD
Длинный СВОП LONGSWAP

fortsConnectionTypes

mcdbId value code
150 Fix Gate LOGIN_FIX_PII
151 PLAZA II Шлюз LOGIN_GATEWAY_PII
152 Moex Spectra Terminal LOGIN_TERMINAL_PII
153 TWIME LOGIN_TWIME_PII

ukUtForms

value code
УТ UT
УК UK
УТ+УК UK_UT

loginLevels

tcsValue actualOnFm value code
0 true Главный BASIC
1 true Брокерский BROKERAGE
2 true Клиентский CLIENT
3 true Drop Copy DROP_COPY

streams

value code
Сделки TRANSACTIONS
Сделки + заявки TRANSACTIONS_AND_ORDERS

tsAstsPlazas

value code
Фондовый STOCK
Валютный CURRENCY
Фондовый и Валютный STOCK_CURRENCY

directConnection

value code
Прямое подключение терминала через Интернет DIRECT_CONNECT_OPTIONS
Прямое подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge DIRECT_CONNECT_OPTIONS_COLOCATION
Подключение терминала через Hosted ASTSBridge (Выделенный канал) CONNECT_ASTS_BRIDGE_OPTIONS
VPN-доступ DIRECT_VPN
Подключение терминала через Hosted ASTSBridge (POP) CONNECT_ASTS_BRIDGE_OPTIONS_POP

2. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/groups/{marketId}

Получение справочника групп, зарегистрированных на указанном рынке, для использования атрибутов из справочника Биржи при заполнении заявления.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
marketId path integer Да Идентификатор рынка

Может принимать следующие значения:

30 — ФР, РД, РК;

1 — Фондовый рынок;

2 — Валютный рынок;

3 — Срочный рынок;

22 — Денежный рынок
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры:

Параметр Тип данных Обязательность Может быть null Наименование Комментарий Пример значения
data array
name string Нет Да Наименование группы "name": "QATEST55" 
code string Нет Да Наименование кода "code": "GR0046

3. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/orders

Получение справочника возможных статусов (документов) заявок для определения статуса своей заявки.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Комментарий Пример значения
data object Нет
states array Нет Да Справочник статусов заявок  
value string Нет Да Значение статуса (наименование) заявки

Может принимать следующие значения:

«В Работе»

«Исполнено»

«Отклонено»

«Отказ»

«Заявка поступила»

«Выявлены ошибки»

«Обработка прекращена»

«Ожидает допуска»

«Черновик»

 "value": "В работе"
code string Нет Да Код статуса заявки

Описывает следующие коды статуса заявки:

"InWork"

"Executed"

"Declined"

"Denied"

"Received"

"ErrorsIdentified"

"ProcessingStopped"

"AdmissionAwaiting"

"Draft"

 "code": "InWork"

4. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/orders/prefill/{marketId}

Получение данных для предварительного заполнения значений всех типов заявок.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
marketId path integer Да Идентификатор рынка

Может принимать следующие значения:

30 — ФР, РД, РК;

1 — Фондовый рынок;

2 — Валютный рынок;

3 — Срочный рынок;

22 — Денежный рынок
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data object Нет Получение предварительно заполненных значений для всех типов заявок (ответ)
organizationFullName string Нет Да Полное наименование организации "organizationFullName": "Общество с ограниченной ответственностью \"Первый Финансовый банк\"
firmId string Нет Да Идентификатор "firmId": "AB1234567890"
itsNumberDate string Нет Да Договор ИТС, №, дата "itsNumberDate": "№ 123 от 01.01.2020"
stockParticipationCategory string Нет Да Категория участия на фондовом рынке

Пример ответа

 {
 "data": {
"organizationFullName": "Общество с ограниченной ответственностью
\"Первый Финансовый банк\",
 "firmId": " AB1234567890",
 "itsNumberDate": "№ 123 от 01.01.2020",
 "stockParticipationCategory": null
 }
}

5. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/status

Получение списка возможных статусов идентификатора для определения статуса своего идентификатора.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры:

Параметр Тип данных Обязательность Может быть null Наименование Комментарий  Пример значения
data array Нет
id string Нет Да Статус "id": "ACTIVE"
value string Нет Да Значение "value": "Действующий"

Пример ответа

{
 "data": [
{
 "id": "ACTIVE",
 "value": "Действующий"
},
{
 "id": "REVOKED",
 "value": "Аннулированный"
},
{
 "id": "ACTIVATION_WAITING",
 "value": "Ожидающий активации"
}
]
}

6. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/ip

Получение списка IP-адресов в зависимости от типа подключения для корректного заполнения заявления.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
connectionType query integer Да Тип подключений

Может принимать следующие типы подключений:

LoginCtColocationHostedAstsBridgeDChannel = 0 (Прямое подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge)

LoginCtVpn = 1 (VPN-доступ)

LoginCtHostedAstsBridgeDChannel = 2 (Подключение терминала через Hosted ASTSBridge (Выделенный канал) / Серверное приложение для подключения ВПТС к ПТК Биржи = Hosted ASTSBridge (Выделенный канал))

LoginCtHostedAstsBridgePop = 3 (Подключение терминала через Hosted ASTSBridge (POP))

LoginPersonalAstsBridge = 4 (Серверное приложение для подключения ВПТС к ПТК Биржи = Personal ASTSBridge)

LoginMfixTransactional = 5 (Серверное приложение для подключения ВПТС к ПТК Биржи = MFIX Transactional)

LoginFifoTwimeAsts = 6 (Серверное приложение для подключения ВПТС к ПТК Биржи = FIFO TWIME ASTS)

LoginTwimeAsts = 7 ( Серверное приложение для подключения ВПТС к ПТК Биржи = TWIME ASTS)

Значение code из справочника OrderConnectionTypes в ответе GET /lk/lku/{orgId}/login/management/external/dictionaries/logins
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Комментарий  Пример значения
data array[string] Нет Да Список IP-адресов ["192.0.2.0/24", "198.51.100.61", "203.0.113.36"]

7. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/orders/client/codes/{marketId}

Получение справочника кратких кодов зарегистрированных клиентов для заполнения заявлений на присвоение и изменение идентификаторов спонсируемого доступа.

Входные параметры

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
marketId path integer Да Идентификатор рынка

Может принимать следующие значения:

30 — ФР, РД, РК;

1 — Фондовый рынок;

2 — Валютный рынок;

3 — Срочный рынок;

22 — Денежный рынок
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
page query integer Да Страница
size query integer Да Количество элементов на странице
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 
data body array Да Массив данных
statuses body string Да Статусы

Может принимать значения:

A — активно;

S — приостановлено;

D — удалено
codeName body string Нет Код поиска Может быть null

Пример запроса

{
 "data": {
 "statuses": [
 "A"
 ],
 "codeName": "1"
 }
}

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data array Нет Да Массив данных  
status string Нет Да Статусы "status": "A"
code string Нет Да Код поиска "code": "FB0001"
pageSize integer Нет Размер страницы  
pageIndex integer Нет Индекс страницы  
totalRecords integer Нет Общее количество записей  
totalPages integer Нет Общее количество страниц  

8. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/orders/trd/accids/{marketId}

Получение справочника ТКС (торгово-клиринговых счетов) клиентов для заполнения списка выбранных ТКС в заявлениях на идентификаторы.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
marketId path integer Да Идентификатор рынка

Может принимать следующие значения:

30 — ФР, РД, РК;

1 — Фондовый рынок;

2 — Валютный рынок;

3 — Срочный рынок;

22 — Денежный рынок
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
page query integer Да Страница
size query integer Да Количество элементов на странице
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 
data body array Да Массив данных
statuses body string Да Статусы

Может принимать значения:

A — действующий;

D — аннулированный
codeName body string Нет Код поиска Может быть null

Пример запроса

{
 "data": {
 "statuses": [
 "A"
 ],
 "codeName": ""
 }
}

Выходные параметры

Параметр Тип данных Обязательность Наименование Пример значения
data array Нет Массив данных
statuses string Нет Статусы

{

   "status": "A"

}
trdaccid string Нет Торговый счет

{

  "trdaccid": "D00+000026A8"

}
pageSize integer Размер страницы
pageIndex integer Индекс страницы
totalRecords integer Общее количество записей
totalPages integer Общее количество страниц

9. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/certificates

Получение списка значений действующих СКПЭП для корректного заполнения заявления на идентификаторы.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data array Нет Да Массив данных
id integer Нет Нет Идентификатор "id": 12345
subject string Нет Нет Имя владельца сертификата в виде строки DN LDAP "subject": "INN=111111111111,OGRN=2222222222222,SNILS=33333333333,T=Специалист,CN=Сотрудник 20,OU=Департамент ИТ,O=ПАО "Искусственный интеллект",L=Москва,ST=77 г.Москва,C=RU"

10. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/instruments

Получение матрицы инструментов валютного рынка для указания ограничений по конкретным инструментам.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Наименование Комментарий  Пример значения
data object
CETSN array
IsEmpty boolean Нет Признак заполненности

ячейка пустая => true

ячейка должна быть заполнена => false

 "IsEmpty": false
TradeMode string Нет Внутренний код торгового режима
Code string Нет Код торгового инструмента

{ 

   "Code": "CNYRUB_TOD"

}
QuoteCurrency string Нет Сопряжённая валюта

{

  "QuoteCurrency": "RUB"

}
BaseCurrency string Нет Валюта

{

  "BaseCurrency": "CNY"

}
Type string Нет Вид торгового инструмента

{

  "Type": "SPOT"

}
SettlementCode string Нет Расчётный код

{

  "SettlementCode": "T0"

}
SettlementDate string Нет Дата начала валютирования

{

  "SettlementDate": "19.12.2024"

}
FarLegSettlementDate string Нет Дата окончания валютирования

{

  "FarLegSettlementDate": "20.12.2024"

}

Пример ответа

{
 "Data": {
 "CETSN": [
[
{
 "IsEmpty": false,
 "TradeMode": null,
 "Code": "CNYRUB_TOD",
 "QuoteCurrency": "RUB",
 "BaseCurrency": "CNY",
 "Type": "SPOT",
 "SettlementCode": "T0",
 "SettlementDate": "03.09.2024",
 "FarLegSettlementDate": null
 }
}

}

11. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/clearing/broker/attributes

Получение данных под код Расчетной Фирмы Срочного рынка для получения данных об участниках торгов и/или клиринга.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data array Нет Массив объектов
payload object Нет Полезная нагрузка
memberInfo array Нет Нет Информация об организации — участнике торгов 
name string Нет Да Краткое наименование организации "name": "ООО \"Оптим-Инвест Брокерс\"
codeRf string Нет Да Код РФ организации "codeRf": "01"
unicode string Нет Да Юникод организации "unicode": "1234567890"
firmIds string Нет Да Перечень FirmId организации — участника торгов "firmIds": [ "MC1234567890", "MB1234567890", "MG1234567890", "MF1234567890", "ZK1234567890", "DT1234567890" ]
brokersInfo array Нет Да Информация об организациях — клиринговых брокерах
brokerId integer Нет Нет Идентификатор организации — клирингового брокера "brokerId": 7777
codeBf string Нет Да Код БФ организации — клирингового брокера "codeBf": "3"
brokerName string Нет Краткое наименование организации — клирингового брокера "brokerName": "ООО "Лекс Брокер Девелопмент"
codeRf string Нет Да Код РФ организации "codeRf": "A1"
ukIdentificator string Нет Да Идентификатор пользователя "ukIdentificator": "1234567890"
firmIds array Нет Да Перечень FirmId организаций — клиринговых брокеров "firmIds": ["FD0987654321", "ZK0987654321","MC0987654321", "DT0987654321","MB0987654321", "CM0987654321","MG0987654321"]
pageSize integer Размер страницы
pageIndex integer Индекс страницы
totalRecords integer Общее количество записей
totalPages integer Общее количество страниц

12. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/chapter

Получение списка разделов Срочного рынка для указания ограничений полномочий идентификаторов по разделам Срочного рынка.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
code query string Да Код поиска Параметр для фильтрации по идентификатору раздела
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data array Нет Да Массив объектов
clientCode string Нет Да Идентификатор раздела "clientCode": "1234567"

13. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/vpts

Получение списка ВПТС

Параметр Принадлежность Тип данных Обязательность Может быть null Наименование Комментарий
orgId path string Да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
ClientRequestId header - Нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением
Bearer header JWT токен Да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token 
data body object Да
marketCode body string Нет Да Код рынка "marketCode": "MRKT_STOCK_DEPOSIT_CREDIT_MARKET"
connectionType  body string Нет Да Тип подключения "connectionType": "PERSONAL_ASTS_BRIDGE"
access body array[string] Нет Да Тип полномочий  "access": [
    "VIEWING_VPTS_ANALYTIC"
  ]
cancelOnDisconnect body boolean Нет Да

Сancel on disconnect

Проверка на параметр, для Срочного рынка

 "cancelOnDisconnect" : "true"

Пример запроса

{
 "data": {
 "marketCode": "MRKT_CURRENCY_MARKET",
 "connectionType": "FIFO_TWIME_ASTS",
 "access": [
 "VIEWING_VPTS"
 ],
 "cancelOnDisconnect": null
 }
}

Выходные параметры

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data array Нет Да Массив объектов
name string Нет Да Название ВПСТ "name": "Berginum"
devName string Нет Да Название компании разработчика  "devName": "Григорьев Геннадий Генадьевич"
nameAndDeveloper string Нет Да ВПТС + Разработчик "nameAndDeveloper": " Berginum /Григорьев Геннадий Генадьевич"
vptsId string Нет Да Идентификатор ВПТС "VptsId": 'aedcb5c8-8cfa-4e3b-ae8d-8000defab5cd'
paging object
pageSize integer Размер страницы
pageIndex integer Индекс страницы
totalRecords integer Общее количество записей
totalPages integer Общее количество страниц

Пример ответа

{
 "data": [
{
 "name": "Brina",
 "devName": "ООО \"Brinomix\"",
 "nameAndDeveloper": "Brina / ООО \"Brinomix\"",
 "vptsId": "4f213f41-72c9-4c3a-bb97-ac2471d64ea3"
 }
 ]
}