Раздел «Организации»

API Управления идентификаторами.

Версия 1.0.0

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

Содержание

1. Введение

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

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

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

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

4. Метод POST /lk/lku/{orgId}/login/management/external/organizations/agents

5. Метод GET /lk/lku/{orgId}/login/management/external/organizations/agents/{agentId}

6. Метод POST /lk/lku/{orgId}/login/management/external/organizations/agents/export

7. Метод GET /lk/lku/{orgId}/login/management/external/organizations/status/access/markets

8. Метод GET /lk/lku/{orgId}/login/management/external/organizations/orders-linked/{loginId}

9. Метод GET /lk/lku/{orgId}/login/management/external/organizations/agents/{agentId}/export

10. Метод GET /lk/lku/{orgId}/login/management/external/organizations/packages/limits

1. Введение

Документ содержит описание входных и выходных параметров методов API Управления идентификаторами из раздела "Организации"  /lk/lku/{orgId}/login/management/external/organizations.

2. Описание кодов ответов 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"
    }

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

Получение необходимых сведений об организации.

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

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
organizationIdType path integer да Тип идентификатора организации Всегда значение 0
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
  success boolean Результат выполнения запроса "success" : "true"
  payload object Список организаций
    id integer Идентификатор  "id": 4369
    mcdbId integer ИД организации  "mcdbId": 75
    fullName string Наименование на русском языке (полное) "fullName": "Общество с ограниченной ответственностью \"Брокер Коммерция\""
    shortName string Краткое наименование организации "shortName": "ООО \"Брокер Коммерция\""
    fullNameEng string Наименование на иностранном языке (полное) "fullNameEng": "Commerce Broker Limited"
    shortNameEng string Наименование на иностранном языке (сокращенное) "shortNameEng": "Commerce Broker Limited"
    firmFullName string Фирменное наименование на русском языке (полное) "firmFullName": "Общество с ограниченной ответственностью \"Брокер Коммерция\""
    firmShortName string Фирменное наименование на русском языке (сокращенное)  "firmShortName": "ООО \"Брокер Коммерция\""
    firmFullNameEng string Фирменное наименование на иностранном языке (полное) "firmFullNameEng" : "Joint stock company Commerce"
    firmShortNameEng string Фирменное наименование на иностранном языке (сокращенное) "firmShortNameEng" : "OOO Commerce"
    fullNameRod string Полное наименование организации "fullNameRod": "Общества с ограниченной ответственностью \"Брокер Коммерция\""
    meanName string Алфавитное наименование организации  "meanName": "Брокер Коммерция"
    shortNameTc string Краткое наименование (для ТКС) "shortNameTc": "Коммерц"
    fullNameTc string Полное наименование (для ТКС) "fullNameTc": "ООО \"Брокер Коммерция\""
    shortNameEngTc string Краткое английское наименование (для ТКС) "shortNameEngTc": "Commerce Broker Limited"
    fullNameEngTc string Полное английское наименование (для ТКС) "fullNameEngTc": "Commerce Broker Limited"
    email string Эл. почта "email": "123@test.com"
    unicode string Юникод "unicode": "0011111000"
    changedBy string Кем были внесены изменения  "changedBy": "autoimport"
    changedAt string(datetime) Когда изменен "changedAt": "2024-10-31T17:01:50.378Z"
    isDeleted boolean Признак логического удаления "isDeleted": false
    mdmId string Идентификатор организации  "mdmId": "44cad72b-16f5-11b0-e053-0100007f31e5"
    type object
      .id integer Идентификатор "id": 3
      .name string Наименование "name": "Некредитная"
      .mnemonicCode string Мнемокод  "mnemonicCode": "OT_NON_CREDIT"
      .isActual boolean Актуальность "isActual": true
    category object Справочник категорий организаций
      .id integer Идентификатор "id": 7
      .name string Наименование  "name": "Профучастник"
      .mnemonicCode string Мнемокод   "mnemonicCode": "PROF_PART"
      .organizationTypeFilter string Фильтр по типу организации "organizationTypeFilter": "[3][rc]"
      .orderState integer Состояние "orderState": 5
      .isActual boolean Актуальность  "isActual": true
    openAccountType object Справочник типа организации для открытия лицевых счетов
      .id integer Идентификатор  "id": 3
      .name string Наименование "name": "Негосударственная ФО"
      .isActual boolean Актуальность "isActual": true
    addresses array Адреса
      id integer Идентификатор "id": 12345       
      mcdbId integer Тип идентификатора организации "mcdbId": 11101
      organizationId integer Идентификатор организации "organizationId": 1111
      formalized boolean Формализованный ввод "formalized": false
      index string Индекс "index": "123112"
      districtType string Тип района
      district string Район
      cityType string Тип города
      city string Город
      localityType string Тип населенного пункта
      locality string Населенный пункт
      streetType string Тип улицы
      street string Улица "street": "улица Кутузовская"
      house integer Дом "house": "10"
      housingType string Тип дома "housingType": "офис"
      housing string Корпус "housing": "блок С"
      apartment integer Квартира "apartment": "1"
      additional string Доп. информация
      display string Отображение  "display": "119526 РОССИЙСКАЯ ФЕДЕРАЦИЯ, москва город, , улица Кутузовская, дом 101, корп.3, офис 1"
      regionDisplay string Отображение района
      houseTypeDisplay string Отображение типа дома "houseTypeDisplay": "дом"
      apartmentTypeDisplay string Отображение типа квартиры "apartmentTypeDisplay": "Этаж"
      municipalDistrict string Муниципальный район
      changedBy string Кем изменен "changedBy": "autoimport"
      changedAt string(datetime) Когда изменен "changedAt": "2024-05-14T12:16:24.346Z"
      type object
        .id integer Идентификатор  "id": 1
        .name string Наименование  "name": "Адрес юридического лица (юридический адрес)"
        .mnemonicCode string Мнемокод "mnemonicCode": "LEGAL_ADDRESS"
        .isActual boolean Актуальность "isActual": true
      country object Справочник стран
        .id integer Идентификатор  "id": 181
        .name string Наименование "name": "РОССИЯ"
        .fullName string Полное наименование "fullName": "РОССИЙСКАЯ ФЕДЕРАЦИЯ"
        .alpha2Code string Буквенный код (Альфа-2) "alpha2Code": "RU"
        .alpha3Code string Буквенный код (Альфа-3) "alpha3Code": "RUS"
        .isoCode integer Цифровой код страны "isoCode": "643"
        .isActual boolean Актуальность "isActual": true
        .englishName string Наименование на английском "englishName": "Russian Federation"
        .displayOld string Код + наименование "displayOld": "643 - Россия"
      region object Справочник регион
        .id integer Идентификатор  "id": 182
        .name string Наименование "name": "Москва б "
        .code integer Код  "code": "77"
        .displayRegCardName string Отображаемое наименование карточки региона "displayRegCardName": "Москва б (77)"
        .isCityInputBan boolean Признак города федерального значения "isCityInputBan": true
        .egrulRegionType string Наименование типа региона "egrulRegionType": "ГОРОД"
        .egrulRegion string Наименование региона без типа "egrulRegion": "МОСКВА"
        .isActual boolean Актуальность "isActual": true
      houseType object Справочник тип дома
        .id integer Идентификатор "id": 1
        .name string Наименование типа дома "name": "дом"
        .nccType integer Тип дома в справочнике "nccType": 0
        .isActual boolean Актуальность "isActual": "true"
      apartmentType object Справочник типов помещений
        .id integer Идентификатор "id": 4
  
        .name string Наименование типа помещения "name": "Этаж"
        .nccType integer Тип помещения в справочнике "nccType": 3
        .isActual boolean Актуальность "isActual": true
    phones array Телефон
      id integer Идентификатор "id": 7104
      organizationId integer Идентификатор организации "organizationId": 4369
      formalized boolean Формализованный ввод  "formalized": true
      areaCode string Код города  "areaCode": "495"
      number string Номер "number": "2587777"
      internalNumber string Интернациональный номер
      display string Отображение "display": "Россия (7) (777)  7777777"
      changedBy string Кем изменен  "changedBy": "xbpm-integration"
      changedAt string(datetime) Когда изменен "changedAt": "2023-03-26T10:22:56.884Z"
      type object Справочник типа организации
        .code string Код  "code": "tel"
           
        .name string Наименование "name": "Телефон"
      country object Справочник стран для телефонов
        .id integer Идентификатор "id": 180
 
        .telCode integer Международный телефонный код "telCode": 7
        .name string Наименование "name": "Россия"
        .isActual boolean Актуальность "isActual": true
    websites array Сайты организации в сети Интернет
      id integer Идентификатор "id": 1165
      mcdbId integer Тип идентификатора организации "mcdbId": 1111
      organizationId integer Идентификатор организации  "organizationId": 1111
      site string Сайт  "site": "http://www.site.ru/"
      dateBegin date Дата договора ИТС "dateBegin": "2010-04-16T06:53:05Z"
      dateEnd date Дата расторжения договора ИТС "dateEnd": "2012-10-16T12:18:53Z"
      rknMatchesFound boolean Совпадения найдены "rknMatchesFound": false
      rknVerified boolean Подтверждено  "rknVerified": false
      changedBy string Кем изменен "changedBy": "xbpm-integration"
      changedAt datetime Когда изменен  "changedAt": "2023-03-26T10:23:24.496Z"
    organizationApi array Свойства организации по API
      organizationId integer Идентификатор организации  "organizationId": 4369
          
      edoMail string Адрес организации "edoMail": "MC0011100000@ex.micex.ru"
      caClientId string Client_id "caClientId" : "1774a94e-a111-1111-11a1-11ae1b1111111"
      caClientSecret string Client_secret "caClientSecret" : " 1774a94e-a111-1111-11a1-11ae1b11111ab"
      changedBy string Кем изменен "changedBy": "xbpm-integration"
      changedAt string (datetime) Когда изменен "changedAt": "2023-03-26T10:22:56.884Z"
    organizationEval array Свойства организации по Eval
      organizationId integer Идентификатор организации "organizationId": 1111
        
   
      vipClient boolean Вип клиент "vipClient": true
      changedBy string Кем изменен "changedBy": "xbpm-integration"
      changedAt string(datetime) Когда изменен "changedAt": "2023-03-26T10:22:56.884Z"
      laborIntensity object Справочник трудозатратность
        .id integer Идентификатор  "id": 3
         
          
        .name string Наименование "name": "гиперактивный"
        .isActual boolean Актуальность "isActual": true
    organizationMoexId array Свойства организации по Moex Id
        organizationId integer Идентификатор организации  "organizationId": 4369
        crmGuid string ID организации в CRM "crmGuid": "CDB57280-12F1-E111-90A6-00155D630D09"
        changedBy string Кем изменен "changedBy": "xbpm-integration"
        changedAt string(datetime) Когда изменен "changedAt": "2023-03-26T10:22:56.884Z"
      organizationRisk array Свойства организации по Risk
        organizationId integer Идентификатор организации "organizationId": 4369
        riskProfile boolean Расчет риск-профиля "riskProfile": false
        changedBy string Кем изменен "changedBy": "xbpm-integration"
        changedAt string(datetime) Когда изменен "changedAt": "2023-03-26T10:22:56.884Z"
      organizationSanction array Свойства организации по санкциям
        mcdbId integer Тип идентификатора организации "mcdbId": 75
        organizationId integer Идентификатор организации "organizationId": 4369
        blockUsa boolean Организация заблокирована в США "blockUsa": false
        blockGreatBritain boolean Организация заблокирована в Великобритании "blockGreatBritain": false
        blockEu boolean Организация заблокирована в Европейском Союзе "blockEu": false
        sanctionsSwitzerland boolean Организация заблокирована в Швейцарии "sanctionsSwitzerland": false
        sanctionsRf boolean Организация заблокирована в Российской Федерации "sanctionsRf": false
        changedBy string Кем изменен  "changedBy": "xbpm-integration"
        changedAt string(datetime) Когда изменен "changedAt": "2023-03-26T10:23:08.073Z"
      personalManagers array Персональные менеджеры
        id integer Идентификатор "id": 7121       
        mcdbId integer Тип идентификатора организации "mcdbId": 9074
        organizationId integer Идентификатор организации "organizationId": 4369
        isActive boolean Активность    "isActive": true
        changedBy string Кем изменен  "changedBy": "xbpm-integration"
        changedAt string(datetime) Когда изменен "changedAt": "2024-04-18T11:15:16.041Z"
        employee object Cотрудник
          .id integer Идентификатор сотрудника "id": 501
 
          .fio string ФИО "fio": "Иванова Иоанна Ивановна"
          .room string Помещение "room": "5"
          .phone string Телефон "phone": "5"
          .localPhone string Локальный телефон "localPhone": "2471eи"
          .shortName string Инициалы "shortName": "Иванова И.И."
          .email string Эл. почта "email": "Iohanna.Ivanova@moex.com"
          .position string Должность "position": "Менеджер"
          .fired boolean Признак увольнения "fired": false
        personalManagerCategory object Категорий персональных менеджеров
          .id integer Идентификатор сотрудника "id": 3
       
          .name string Наименование "name": "RM-менеджер"
          .mnemonicCode string Мнемокод "mnemonicCode": "PRMNCT_RM_MANAGER"
          .isActual boolean Актуальность "isActual": true

4. Метод POST /lk/lku/{orgId}/login/management/external/organizations/agents

Получение списка идентификаторов организации для просмотра всех идентификаторов на ФР, РД, РК, ВР, СР, ДР на собственном ПО с использованием API Биржи.

Параметр Принадлежность Тип Обязательность Может быть null Наименование Комментарий
page query integer да Страница
size query integer да Количество элементов на странице
collapseIps query boolean нет Признак свернутости IP адресов
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 да нет Массив данных
tsId body string нет да Идентификатор торгового доступа
registerCode body string нет да Код логина. Семизнак, начинается с кода РФ
loginLevel body string нет да Уровень логина Параметр для фильтрации. Значение должно соответствовать значению code из справочника LoginLevel Справочники-loginlevel ответа метода /lk/lku/{orgId}/login/management/external/dictionaries/logins
oldFullName body string нет да Фамилия, Имя, Отчество
activationDateFrom body string(date) нет да Дата начала создания идентификатора Дата в формате "YYYY-MM-DD"
activationDateTo body string(date) нет да Дата окончания создания идентификатора Дата в формате "YYYY-MM-DD"
cancellationDateFrom body string(date) нет да Дата начала аннулирования идентификатора Дата в формате "YYYY-MM-DD"
cancellationDateTo body string(date) нет да Дата окончания аннулирования идентификатора Дата в формате "YYYY-MM-DD"
isValid body array[string] нет да Статус идентификатора

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

  • ACTIVE = 0 (Действующий) 

  • REVOKED = 1 (Аннулированный) 

  • ACTIVATION_WAITING = 2 (Ожидающий активации)
isOnStockMarket body boolean нет да Идентификатор является пользователем ФР (Да/Нет)
isOnDepositMarket body boolean нет да Идентификатор является пользователем РД (Да/Нет)
isOnCreditMarket body boolean нет да Идентификатор является пользователем РК (Да/Нет)
markets body array[int] да нет Массив идентификаторов Рынков

В массиве могут содержаться одно или несколько из следующих значений:

  • 30 — ФР, РД, РК

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

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

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

  • 22 — Денежный рынок
isTrader body boolean нет да Флаг ограничения по полномочиям
isSmaIdentifier body boolean нет да Флаг ограничения по полномочиям (SMA)
filters body array нет да Массив со списком фильтраций
fieldName body string нет да

Параметр для поиска. Могут быть переданы все атрибуты идентификатора

Наименование свойства, по которому будет строиться фильтр
value body string нет да Значение, с которым будет производится сравнение
values body array[string] нет да Список значений, с которым будет производится сравнение
type body string/integer нет нет Оператор для поиска

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

  • NE = 0 (не равно)

  • EQ = 1 (равно)

  • LT = 2 (меньше)

  • LE = 3 (меньше или равно)

  • GT = 4 (больше)

  • GE = 5 (больше или равно)

  • IN = 6 (диапазон)

  • LIKE = 7 (проверка совпадения символьной строки с заданным шаблоном)
joinType body integer нет нет Фильтр Возможные значения: 1 или 0
joinGroup body string нет да Номер группы для оператора JoinType
sort body object нет нет Сортировка запроса
key body string нет да Имя свойства Название свойства, по которому будет осуществляться сортировка
direction body integer/string нет нет Направление сортировки

Возможные значения: 1 или 0

0 = ASC (сортирует от низких значений к высоким)

1 = DESC (сортирует от высоких значений к низким)

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

  {
    "data": {
      "markets": [
        2
      ],
      "isValid": [
        "ACTIVE"
      ],
      "isSmaIdentifier": false,
      "filters": [
        {
          "fieldName": "tradeName",
          "value": "MOEX_DEALING_2",
          "type": "NE"
        },
        {
          "fieldName": "cancellationDate",
          "value": null,
          "type": "EQ"
        },
        {
          "fieldName": "billingConnection",
          "type": "IN",
          "values": [
            "MOEX_TRADE_CURRENCY"
          ]
        },
        {
          "fieldName": "tsId",
          "type": "LIKE",
          "value": "MU0089557683"
        }
      ],
      "sort": {
        "key": "tradeName",
        "direction": "ASC"
      }
    }

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

Параметр Тип данных Обязательность Может быть null Наименование Пример значения
data array нет да Массив объектов
mcdbId integer нет нет ИД  "mcdbId": 46632
firmId string нет да Идентификатор организации, которая является участником торгов (депозитарный код) "firmId": "MB0139600000"
tsId string нет да Идентификатор технического доступа (ИТД)  "tsId": "SA0139602754"
loginId string(uuid) нет да Уникальный код пользователя "loginId": "cea231a0-2d1d-4972-8e59-c2a4b07adb1c"
shortName string нет да Наименование идентификатора "shortName": "Шлюз (SMA КОММБД 1)"
isValid string нет да Статус "isValid": "ACTIVE"
activationDate string(date) нет да Дата создания идентификатора "activationDate": "2020-12-12"
cancellationDate string(date) нет да Дата аннулирования идентификатора "cancellationDate" : "2020-12-20"
market object нет нет Рынки
.id integer нет нет Код рынка "id": 2
.mnemocode string нет да Мнемокод "mnemocode": "MRKT_CURRENCY_MARKET"
.name string нет да Наименование рынка  "name": "Валютный рынок"
.shortName string нет да Краткое наименование рынка  "shortName": "ВР"
tradeName string нет да Тип торговых полномочий  "tradeName": "TRADING_2"
clearingName string нет да Клиринговые полномочия  "clearingName": "OPERATOR_AND_TRANSFER_2"
oldFullName string нет да ФИО (ИТД) "oldFullName" : "Иванов Иван Иванович"
subjectCN string нет да ФИО в криптоимени, связанном с ИТД "subjectCN": "Иванов Иван Иванович"
ctUserFio string нет да ФИО пользователя клирингового терминала, связанного с ИТД "ctUserFio" : "Белов Александр  Александрович"
nameRestrOnTradeMode string нет да Ограничение по режимам торгов "nameRestrOnTradeMode": "HROTM_NONE"
tcaRestrictionUseAll boolean нет да Ограничение по торгово-клиринговым счетам (ТКС)  "tcaRestrictionUseAll": "false"
unionInGroup string нет да Наименование группы
cancelOnDisconnect boolean нет да Cancel On Disconnect "cancelOnDisconnect": true
stRestrRole string нет да Роль идентификатора
stRestrOnGetClient boolean нет да Ограничение по получению информации о клиентах "stRestrOnGetClient": false
stRestrOnGetCommission boolean нет да Ограничение по получению информации о комиссиях "stRestrOnGetCommission": true
stRestrOnGetConsolidPos boolean нет да Ограничение по получению информации о консолидированных позициях "stRestrOnGetConsolidPos": false
stRestrOnGetBillPos boolean нет да Ограничение по получению информации о позициях по счетам  "stRestrOnGetBillPos": "true"
 "stRestrOnGetAdrRequest": true boolean нет да Ограничение по получению информации об адресных заявках для ID, ограниченных по ТКС  "stRestrOnGetAdrRequest": "true"
stRestrOnGetFirmResp boolean нет да Получение информации об обязательствах УТ  "stRestrOnGetFirmResp": "true"
interfaceLanguage string нет да Язык интерфейса "interfaceLanguage": "RUS"
isMasterLogin boolean нет да Является мастер логином "isMasterLogin" : "false"
isdList array[string] нет да Список ИСД для мастер-логина "isdList": [
                "fg97bm_sma_xxyy000",
                "fw97ct_sma_9788855pi",
                "fg97bt_sma_7301hjk",
                "fg97bm_sma_11111",
                "fg97ct_sma_333",
                "fg97ct_sma_4444",
                "fg97bm_sma_12"
            ]
isIsdAdmin boolean нет да Администратор ИСД / Управление ограничениями SMA "isIsdAdmin": "true"
billingConnection string нет да Тип подключения, отправленный в биллинг "billingConnection": "Hosted ASTS Bridge (CLT)"
connectionTerminal string нет да Способ подключения терминала "connectionTerminal": "VPN"
tttVpts string нет да ВПТС "tttVpts": "55a95a4d-a7b1-4052-87ee-2d594f911f54"
vptsNonPublic string нет да ВПТС - мнемокод "vptsNonPublic": "MOLOT_NON_PUBLIC"
ldapName string нет да Криптоимя (СКПЭП) "ldapName": "INN=007711111111,OGRN=2222222222222,SNILS=1111111111,T=Бухгалтер по ценным бумагам,CN=Иванов Иван Иванович,OU=Отдел финансов,O=ООО \"Брокер Коммерция\",L=г.Москва,ST=77 г.Москва,C=RU"
isSmaIdentifier boolean нет да Является Идентификатором спонсируемого доступа  "isSmaIdentifier": true
clientCodes array[string] нет да Код клиента для ИСД  "clientCodes": [
                "Test_clie",
                "t2",
                "Test_clie",
                "t3"
            ]
 masterLogin1 object нет нет Мастер-логин(основной)
 .id string(uuid) нет да Уникальный код идентификатора  "id": "b63bb986-3e54-400f-ae30-0193320fc52a
 .tsId string нет да Идентификатор технического доступа (ИТД) "tsId": "MS0111100011"
 .mcdbId integer нет да Идентификатор логина   "mcdbId": 28342
 masterLogin2 object нет нет Мастер-логин(резервный)
 .id string(uuid) нет да Уникальный код идентификатора "id": "7593c6c5-ce77-446f-828f-1b5e78d28ff7"
 .tsId string нет да Идентификатор технического доступа (ИТД)  "tsId": "MU001110011A"
 .mcdbId integer нет да Идентификатор логина   "mcdbId": 41109
cancelOnDropCopyDisconnect boolean нет да Cancel On Drop-Copy disconnect  "cancelOnDropCopyDisconnect": false
alias string нет да Псевдоним ИСД  "alias": "Testalias"
isOnStockMarket boolean нет да Пользователь фондового рынка "isOnStockMarket": true
isOnDepositMarket boolean нет да Пользователь рынка депозитов "isOnDepositMarket": true
isOnCreditMarket boolean нет да Пользователь рынка кредитов "isOnCreditMarket": true
tcaList array[string] нет да Список ТКС принадлежащих идентификатору "tcaList": [
                "L00+00000000",
                "L00+00000001",
                "L00-00000000",
                "G01+00000101"
            ]
statusKmp string нет да Статус - Подключение к КМП "statusKmp": "Не подключен"
statusCodeKmp boolean нет нет Код статуса - Подключение к КМП "statusCodeKmp": false
idpUserKmp string нет да Пользователь Idp - Подключение к КМП idpUser": "123@mail.ru"
tokenKmp string нет да Вторые факторы аутентификации 'Токен' - Подключение к КМП "tokenKmp": "12321"
certificateKmp string нет да Вторые факторы аутентификации 'Сертификат' - Подключение к КМП "certificateKmp" : "INN=007708207809,OGRN=1027708015576,SNILS=12291004201,T=Главный специалист,CN=ИВАНОВ ИВАН ИВАНОВИЧ,OU=Отдел депозитарных операций,O=ООО \"БК КОММЕРЦ\",L=г.Москва,ST=77 г.Москва,C=RU"
personSurname string нет да Фамилия  "personSurname": "Иванов"
personName string нет да Имя  "personName": "Иван"
personPatronymic string нет да Отчество "personPatronymic": "Иванович"
expirationPassword boolean нет да Экспирация пароля "expirationPassword" : "true"
ctVPN boolean нет да Способ подключения – VPN  "ctVPN": false
vptsConnectionType string нет да Серверное приложение для подключения ВПТС к ПТК биржи "vptsConnectionType": "TWIME_ASTS"
ctInternet boolean нет да Прямое подключение терминала через Интернет  "ctInternet": false
ctColocationDedicatedChannel boolean нет да Прямое подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge "ctColocationDedicatedChannel": "true"
ctDedicatedChannel boolean нет да Подключение терминала через Hosted ASTSBridge (Выделенный канал) "ctDedicatedChannel": true
actualAddrServerApp string нет да Фактический адрес установки серверного приложения "actualAddrServerApp": "Адрес после изменения"
connectionType string нет да Тип подключения "connectionType": "VPTS"
ip array[string] нет да IP адрес машины, на которую установлено серверное приложение "ip": [
                "22.22.22.22"
            ]
ipClient array[string] нет да IP адрес клиентского приложения "ipClient": [
                "55.55.55.55",
                "77.77.77.77"
            ]
oooMBIp array[string] нет да IP адрес VPN  "oooMBIp": [
        "10.10.10.10",
        "10.11.11.11",
        "10.11.11.11"
    ]
ipCLTTechnicalCenter array[string] нет да IP адрес CLT 1/CLT 2 сегмента "ipCLTTechnicalCenter": [
        "91.203.252.18",
        "91.203.252.19",
        "91.203.252.29"
    ]
ipCLTClosedNetwork array[string] нет да IP адрес шлюза CLT1/CLT2 сегмента закрытой корпоративной сети "ipCLTClosedNetwork": [
        "91.203.252.18",
        "91.203.252.19",
        "91.203.252.29"
    ]
terminalType string нет да Тип терминала "terminalType": "MOEX_TRADE_CURRENCY"
ipAddresses array[string] нет да IP - адреса "ipAddresses": [
                "33.33.33.33",
                "44.44.44.44",
                "55.55.55.55",
                "77.77.77.77"
            ]
tradeModes array нет да Пользовательские режимы агента
  allowedOnTradeMode string нет да Код торговых полномочий "allowedOnTradeMode" : "OBSERVER"
  boardGroupCode string нет да Код пользовательского торгового режима  "boardGroupCode": "CETSN"
  deniedOnTradeMode string нет да Код ограничений использования торговых инструментов "deniedOnTradeMode": "SOME"
 instruments array нет да Cписок инструментов в торговом режиме
  code string нет да Код торгового инструмента "code": "UCDRUBTDTM"
  quoteCurrency string нет да Сопряжённая валюта "quoteCurrency": "RUB"
  baseCurrency string нет да Валюта  "baseCurrency": "UCD"
  type string нет да Вид торгового инструмента "type": "SWAP"
  settlementCode string нет да Расчётный код "settlementCode": "T0T1"
  settlementDate string нет да Дата начала валютирования "settlementDate": "14.06.2024"
  farLegSettlementDate string нет да Дата окончания валютирования "farLegSettlementDate": "15.06.2024"
allowLpForRfsCu string нет да Полномочия Внебиржевых сделок на аукционе RFS "allowLpForRfsCu": "REVOKE_PRODUCER_STATUS"
group object нет Группа логина
  .code string нет да Код группы  "code": "000000000157"
  .name string нет да Наименование группы  "name": "ГРУППАNAME333"
boardGroupOtct string нет да Внебиржевые сделки с иностранной валютой / драгоценными металлами, в которых одним из конечных контрагентов является Провайдер ликвидности (OTCT) "boardGroupOtct" : "OTCT"
boardGroupRfs string нет да Внебиржевые сделки спот с иностранной валютой (аукцион RFS) "boardGroupRfs" : "RFSM"
boardGroupCpcl string нет да Внебиржевые сделки с иностранной валютой в режиме «Сделки с ЦК» (CPCL) "boardGroupCpcl" : "CPCL"
fortsConnectionType string нет да Тип подключения логина на срочном рынке "fortsConnectionType" = "MOEX_SPECTRA_TERMINAL"
ctIpFo boolean нет да Способ подключения срочного рынка  "ctIpFo": "true"
ukUtForm string нет да Форма УК-УТ  "ukUtForm": "UT"
fortsMarketInfo object нет Информация по идентификаторам СР (срочного рынка)

Блок с параметрами заполняется только для СР.

Для иных рынков передаются пустые значения.
  .loginLevel string нет да Уровень логина "loginLevel" : "BROKERAGE"
  .perfomanceRate integer нет да Производительность "perfomanceRate" : 2
  .registerCode string нет да Раздел "registerCode": "9702255"
  .brokersLimits boolean нет нет Управление лимитами брокерских фирм  "brokersLimits": false
  .clientsLimits boolean нет нет Управление клиентскими лимитами "clientsLimits": false
  .requestsManagement boolean нет нет Управление заявками "requestsManagement" : "true"
  .clientsRestrict boolean нет нет Управление ограничениями по клиентам "clientsRestrict": false
  .allowDontCheckClientFunds boolean нет нет Не проверять средства клиента "allowDontCheckClientFunds": false
  .clientFeeBrokerBlocker boolean нет нет Управление блокировкой брокерской части клиентского сбора  "clientFeeBrokerBlocker": false
  .allowedDeelsAndOrders string нет да Потоки для FIX Drop-Copy "allowedDeelsAndOrders" : "TRANSACTIONS_AND_ORDERS"
  .receiveAggRequestStreams boolean нет нет Потоки агрегированных заявок "receiveAggRequestStreams" : "true"
  .ordersLog boolean нет нет Полный журнал заявок "ordersLog" : "true"
  .astsPlaza string нет да Потоки ASTS "astsPlaza" : "STOCK_CURRENCY"
  .ipFo array[string] нет да IP адрес  "ipFo": [
                    "10.137.142.212"
                ]
packageName string нет да Название пакетов идентификатора "packageName" : "Пакет премиум"
isOnMDepositMarket boolean нет да М-Депозиты "isOnMDepositMarket" : "true"
isOnMoneyCbrDepositMarket boolean нет да Депозиты Банка России "isOnMoneyCbrDepositMarket" : "false"
isOnMoneyFtDepositMarket boolean нет да Депозиты ФК "isOnMoneyFtDepositMarket" : "false"
isOnMoneyFtRepoMarket boolean нет да РЕПО с ФК "isOnMoneyFtRepoMarket" : "true"
paging object да Информация о количестве записей и страниц с результатами поиска
 .pageSize integer нет Размер страницы
 .pageIndex integer нет Индекс страницы
 .totalRecords integer нет Общее количество записей
 .totalPages integer нет Всего страниц

5. Метод GET /lk/lku/{orgId}/login/management/external/organizations/agents/{agentId}

Получение свойств идентификатора организации по его уникальному идентификатору для просмотра свойств идентификатора организации на ФР, РД, РК, ВР, СР, ДР на собственном ПО с использованием API Биржи.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
agentId path string(uuid) да Уникальный идентификатор Значение agentId из ответа метода /lk/lku/{orgId}/login/management/external/organizations/agents
orgId path string да Идентификатор организации Значение orgId из ответа метода /lk/shared/permissions/scopes
collapseIps query boolean нет Признак свернутости IP адресов
ClientRequestId header - нет Идентификатор клиентского запроса Идентификатор запроса, который используется для логирования на стороне биржи. 
Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением.
Bearer header JWT токен да Токен авторизации Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token

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

Параметр Тип данных Обязательность Может быть null Наименование Комментарий 
data object нет
mcdbId integer нет нет Идентификатор логина "mcdbId": 315561
firmId string нет да Идентификатор организации-участника торгов "firmId": "MC0089500000"
tsId string нет да Идентификатор технического доступа (ИТД) "tsId": "SE008954384A"
loginId string(uuid) нет да Уникальный код пользователя "loginId": "ffe26ecd-f969-40d2-b962-4ed7d9200bf9"
shortName string нет да Наименование идентификатора "shortName": "UserSMA52029_Шлюз_Bridge ИТО81"
isValid string нет да Статус "isValid": "ACTIVE"
activationDate string(date) нет да Дата создания идентификатора "activationDate": "2024-07-09"
cancellationDate string(date) нет да Дата аннулирования идентификатора "cancellationDate" : "2024-07-21"
market object нет нет Рынок
  .id integer нет нет Код рынка  "id": 1   
  .mnemocode string нет да Мнемокод "mnemocode": "MRKT_STOCK_MARKET"
  .name string нет да Наименование рынка "name": "Фондовый рынок"
  .shortName string нет да Краткое наименование рынка "shortName": "ФР"
tradeName string нет да Тип торговых полномочий "tradeName": "TRADING_VPTS"
clearingName string нет да Клиринговые полномочия "clearingName" : "TRANSFER_30"
oldFullName string нет да ФИО (ИТД) "oldFullName" : "Сидоров Петр Васильевич"
subjectCN string нет да ФИО в криптоимени, связанном с ИТД "subjectCN": "Workers 25"
ctUserFio string нет да ФИО пользователя клирингового терминала, связанного с ИТД "ctUserFio" : "Иванов Александр  Александрович"
nameRestrOnTradeMode string нет да Ограничение по режимам торгов "nameRestrOnTradeMode" : "HROTM_FOND"
tcaRestrictionUseAll boolean нет да Ограничение по торгово-клиринговым счетам (ТКС) "tcaRestrictionUseAll" : "true"
unionInGroup string нет да Наименование группы
cancelOnDisconnect boolean нет да Cancel On Disconnect "cancelOnDisconnect" : "true"
stRestrRole string нет да Роль идентификатора
stRestrOnGetClient boolean нет да Ограничение по получению информации о клиентах "stRestrOnGetClient" : "true"
stRestrOnGetCommission boolean нет да Ограничение по получению информации о комиссиях "stRestrOnGetCommission" : "true"
stRestrOnGetConsolidPos boolean нет да Ограничение по получению информации о консолидированных позициях "stRestrOnGetConsolidPos" : "false"
stRestrOnGetBillPos boolean нет да Ограничение по получению информации о позициях по счетам "stRestrOnGetBillPos" : "false"
stRestrOnGetAdrRequest boolean нет да Ограничение по получению информации об адресных заявках для ID, ограниченных по ТКС "stRestrOnGetAdrRequest" : "true"
stRestrOnGetFirmResp boolean нет да Получение информации об обязательствах УТ "stRestrOnGetFirmResp" : "false"
interfaceLanguage string нет да Язык интерфейса "interfaceLanguage": "ENG"
isMasterLogin boolean нет да Является мастер логином "isMasterLogin" : "true"
isdList array [string] нет да Список ИСД для мастер-логина "isdList": [
                "fg97bm_sma_xxyy000",
                "fw97ct_sma_9788855pi",
                "fg97bt_sma_7301hjk",
                "fg97bm_sma_11111",
                "fg97ct_sma_333",
                "fg97ct_sma_4444",
                "fg97bm_sma_12"
            ]
isIsdAdmin boolean нет да Администратор ИСД / Управление ограничениями SMA "isIsdAdmin" : "true"
billingConnection string нет да Тип подключения отправленный в биллинг "billingConnection": "Hosted ASTS Bridge (Интернет)"
connectionTerminal string нет да Способ подключения терминала "connectionTerminal": "VPN"
tttVpts string нет да ВПТС "tttVpts": "55a95a4d-a7b1-4052-87ee-2d594f911f54"
vptsNonPublic string нет да ВПТС - мнемокод "vptsNonPublic": "MOLOT_NON_PUBLIC"
ldapName string нет да Криптоимя (СКПЭП) "ldapName": "INN=007711111111,OGRN=2222222222222,SNILS=1111111111,T=Бухгалтер по ценным бумагам,CN=Иванов Иван Иванович,OU=Отдел финансов,O=ООО \"Брокер Коммерция\",L=г.Москва,ST=77 г.Москва,C=RU"
isSmaIdentifier boolean нет да Является Идентификатором спонсируемого доступа  "isSmaIdentifier": true
clientCode array [string] нет да Код клиента для ИСД  "clientCodes": [
                "Test_clie",
                "t2",
                "Test_clie",
                "t3"
            ]
masterLogin1 object нет нет Master-login (основной)
   .id string(uuid) нет да Уникальный код идентификатора "id": "908b2cfd-38f4-4013-aaaf-88693fb8c130"
   .tsId string нет да Идентификатор технического доступа (ИТД) "tsId": "MU0089541801"
   .mcdbId integer нет да Идентификатор логина "mcdbId": 313853
masterLogin2 object нет нет Master-login (резервный)
   .id string(uuid) нет да Уникальный код идентификатора "id": "7593c6c5-ce77-446f-828f-1b5e78d28ff7"
   .tsId string нет да Идентификатор технического доступа (ИТД) "tsId": "MU008950095B"
   .mcdbId integer нет да Идентификатор логина  "mcdbId": 41109
cancelOnDropCopyDisconnect boolean нет да Cancel On Drop-Copy disconnect "cancelOnDropCopyDisconnect": true
alias string нет да Псевдоним ИСД "alias": "тестник"
isOnStockMarket boolean нет да Пользователь фондового рынка "isOnStockMarket": "true"
isOnDepositMarket boolean нет да Пользователь рынка депозитов "isOnDepositMarket": "false"
isOnCreditMarket boolean нет да Пользователь рынка кредитов  "isOnCreditMarket": "false"
tcaList array [string] нет да Список ТКС принадлежащих идентификатору

"tcaList": [

    "L00+00002372",

    "L00+4190ADDC",

    "L00-4190BAD1"

  ]
statusKmp string нет да Статус - Подключение к КМП

"statusKmp": "Не подключен"

  
statusCodeKmp boolean нет нет Код статуса - Подключение к КМП "statusCodeKmp": "false"
idpUserKmp string нет да Пользователь Idp - Подключение к КМП idpUser": "6yiiiuk@mail.ru"
tokenKmp string нет да Вторые факторы аутентификации 'Токен' - Подключение к КМП "tokenKmp": "12321"
certificateKmp string нет да Вторые факторы аутентификации 'Сертификат' - Подключение к КМП "certificateKmp" :  "INN=007711111111,OGRN=2222222222222,SNILS=1111111111,T=Бухгалтер по ценным бумагам,CN=Иванов Иван Иванович,OU=Отдел финансов,O=ООО \"Брокер Коммерция\",L=г.Москва,ST=77 г.Москва,C=RU"
personSurname string нет да Фамилия  "personSurname": "Иванов"
personName string нет да Имя  "personName": "Иван"
personPatronymic string нет да Отчество "personPatronymic": "Иванович"
expirationPassword boolean нет да Экспирация пароля "expirationPassword": "true"
ctVPN boolean нет да Способ Подключения - VPN "ctVPN": "false"
vptsConnectionType string нет да

Тип подключения ВПТС

Серверное приложение для подключения ВПТС к ПТК биржи

 "vptsConnectionType": "HOSTED_ASTS_BRIDGE_INTERNET"
ctInternet boolean нет да Прямое подключение терминала через Интернет "ctInternet": "false"
ctColocationDedicatedChannel boolean нет да Способ подключения – подключение терминала через Выделенный канал, Colocation, шлюз Personal ASTSBridge "ctColocationDedicatedChannel": "false"
ctDedicatedChannel boolean нет да Подключение терминала через Hosted ASTSBridge (Выделенный канал) "ctDedicatedChannel": "false"
actualAddrServerApp string нет да Фактический адрес установки серверного приложения "actualAddrServerApp": "Адрес после изменения"
connectionType string нет да Тип подключения "connectionType": "VPTS"
ip array [string] нет да IP адрес машины, на которую установлено серверное приложение "ip": [
                "22.22.22.22"
            ]
ipClient array [string] нет да IP адрес клиентского приложения "ipClient": [
                "55.55.55.55",
                "77.77.77.77"
            ]
oooMBIp array [string] нет да IP адрес VPN  "oooMBIp": [
        "10.63.21.10",
        "10.63.21.20",
        "10.61.21.10"
    ]
ipCLTTechnicalCenter array [string] нет да IP адрес CLT 1/CLT 2 сегмента "ipCLTTechnicalCenter": [
        "91.203.252.18",
        "91.203.252.19",
        "91.203.252.29"
    ]
ipCLTClosedNetwork array [string] нет да IP адрес шлюза CLT1/CLT2 сегмента закрытой корпоративной сети "ipCLTClosedNetwork": [
        "91.203.252.18",
        "91.203.252.19",
        "91.203.252.29"
    ]
terminalType string нет да Тип терминала "terminalType": "MOEX_TRADE_CURRENCY"
ipAddresses array [string] нет да IP - адреса "ipAddresses": [
                "33.33.33.33",
                "44.44.44.44",
                "55.55.55.55",
                "77.77.77.77"
            ]
tradeModes array[object] нет да Пользовательские режимы агента
   .allowedOnTradeMode string нет да Код торговых полномочий "allowedOnTradeMode" : "OBSERVER_PRODUCER"
   .boardGroupCode string нет да Код пользовательского торгового режима "boardGroupCode" : "CETSS"
   .deniedOnTradeMode string нет да Код ограничений использования торговых инструментов "deniedOnTradeMode" : "ALL"
instruments array[object] нет да Cписок инструментов в торговом режиме
    .code string нет да Код торгового инструмента "code": "UCDRUBTDTM"
    .quoteCurrency string нет да Сопряжённая валюта "quoteCurrency": "RUB"
    .baseCurrency string нет да Валюта  "baseCurrency": "UCD"
    .type string нет да Вид торгового инструмента "type": "SWAP"
   .settlementCode string нет да Расчётный код "settlementCode": "T0T1"
   .settlementDate string нет да Дата начала валютирования "settlementDate": "14.06.2024"
   .farLegSettlementDate string нет да Дата окончания валютирования "farLegSettlementDate": "15.06.2024"
allowLpForRfsCu string нет да Полномочия Внебиржевых сделок на аукционе RFS "allowLpForRfsCu": "PRODUCER"
group object нет Группа логина
   .code string нет да Код группы  "code": "000000000157"
   .name string нет да Наименование группы  "name": "ГРУППАNAME333"
boardGroupOtct string нет да Внебиржевые сделки с иностранной валютой / драгоценными металлами, в которых одним из конечных контрагентов является Провайдер ликвидности (OTCT) "boardGroupOtct" : " OTCT"
boardGroupRfs string нет да Внебиржевые сделки спот с иностранной валютой (аукцион RFS) "boardGroupRfs" : "RFSM"
boardGroupCpcl string нет да Внебиржевые сделки с иностранной валютой в режиме «Сделки с ЦК» (CPCL) "boardGroupCpcl" : "CPCL"
fortsConnectionType string нет да Тип подключения логина на Срочном рынке "fortsConnectionType" = "MOEX_SPECTRA_TERMINAL"
ctIpFo boolean нет да Способ подключения Срочного рынка  "ctIpFo": "true"
ukUtForm string нет да Форма УК-УТ  "ukUtForm": "UK_UT"
fortsMarketInfo object нет Информация по идентификаторам СР

Блок с параметрами заполняется только для СР.

Для иных рынков передаются пустые значения.
 .loginLevel string нет да Уровень логина "levelLogin":  "BASIC"
 .perfomanceRate integer нет нет Производительность "performance": 1
 .registerCode string нет да Раздел  "registerCode": "u311000"
 .brokersLimits boolean нет нет Управление лимитами брокерских фирм  "brokersLimits": false
 .clientsLimits boolean нет нет Управление клиентскими лимитами "clientsLimits": false
 .requestsManagement boolean нет нет Управление заявками "requestsManagement" : "true"
 .clientsRestrict boolean нет нет Управление ограничениями по клиентам "clientsRestrict": false
 .allowDontCheckClientFunds boolean нет нет Не проверять средства клиента "allowDontCheckClientFunds": false
 .clientFeeBrokerBlocker boolean нет нет Управление блокировкой брокерской части клиентского сбора  "clientFeeBrokerBlocker": false
 .allowedDeelsAndOrders string нет да Потоки для FIX Drop-Copy "allowedDeelsAndOrders" : "TRANSACTIONS"
 .receiveAggRequestStreams boolean нет нет Потоки агрегированных заявок "receiveAggRequestStreams" : "true"
 .ordersLog boolean нет нет Полный журнал заявок "ordersLog" : "false"
 .astsPlaza string нет да Потоки ASTS "astsPlaza" : "STOCK"
 .ipFo array [string] нет да IP адрес "ipFo": [ "10.10.10.0-10.10.10.100", "192.168.10.0-192.168.10.100"]
packageName string нет да Название пакетов идентификатора "packageName" : "Пакет премиум"
isOnMDepositMarket boolean нет да М-Депозиты "isOnMDepositMarket" : "true"
isOnMoneyCbrDepositMarket boolean нет да Депозиты Банка России "isOnMoneyCbrDepositMarket" : "false"
isOnMoneyFtDepositMarket boolean нет да Депозиты ФК "isOnMoneyFtDepositMarket" : "false"
isOnMoneyFtRepoMarket boolean нет да РЕПО с ФК "isOnMoneyFtRepoMarket" : "true"

6. Метод POST /lk/lku/{orgId}/login/management/external/organizations/agents/export

  Экспорт списка идентификаторов организации в формате .xlsx для получения списка идентификаторов в файле.

Параметр Принадлежность Тип Обязательность Может быть null Наименование Комментарий
page query integer да Страница
size query integer да Количество элементов на странице
collapseIps query boolean нет Признак свернутости IP адресов
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 array да нет Массив данных
tsId body string нет да Идентификатор торгового доступа
oldFullName body string нет да Фамилия, Имя, Отчество
activationDateFrom body string(date) нет да Дата начала создания идентификатора Дата в формате "YYYY-MM-DD"
activationDateTo body string(date) нет да Дата окончания создания идентификатора Дата в формате "YYYY-MM-DD"
cancellationDateFrom body string(date) нет да Дата начала аннулирования идентификатора Дата в формате "YYYY-MM-DD"
cancellationDateTo body string(date) нет да Дата окончания аннулирования идентификатора Дата в формате "YYYY-MM-DD"
isValid body array[string]/array[integer] нет да Статус идентификатора

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

  • ACTIVE = 0 (Действующий) 

  • REVOKED = 1 (Аннулированный) 

  • ACTIVATION_WAITING = 2 (Ожидающий активации)
isOnStockMarket body boolean нет да Идентификатор является пользователем ФР (Да/Нет)
isOnDepositMarket body boolean нет да Идентификатор является пользователем РД (Да/Нет)
isOnCreditMarket body boolean нет да Идентификатор является пользователем РК (Да/Нет)
markets body array[int] да нет Массив идентификаторов Рынков

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

  • 30 — ФР, РД, РК

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

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

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

  • 22 — Денежный рынок
isTrader body boolean нет да Флаг ограничения по полномочиям
isSmaIdentifier body boolean нет да Флаг ограничения по полномочиям (SMA)  "isSmaIdentifier": true
filters body array нет да Массив со списком фильтраций
fieldName body string нет да Параметр для поиска. Могут быть переданы все атрибуты идентификатора
value body string нет да Значение, с которым будет производится сравнение
values body array[string] нет да Список значений, с которым будет производится сравнение
type body string/integer нет нет Оператор для поиска

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

  • NE = 0 (не равно)

  • EQ = 1 (равно)

  • LT = 2 (меньше)

  • LE = 3 (меньше или равно)

  • GT = 4 (больше)

  • GE = 5 (больше или равно)

  • IN = 6 (диапазон)

  • LIKE = 7 (проверка совпадения символьной строки с заданным шаблоном)
joinType body integer нет нет Фильтр Возможные значения: 1 или 0
joinGroup body string нет да Номер группы для оператора JoinType
sort body object нет нет Сортировка запроса
 .key body string нет да Имя свойства Название свойства, по которому будет осуществляться сортировка
 .direction body integer/string нет нет Направление сортировки

Возможные значения: 1 или 0

0 = ASC (сортирует от низких значений к высоким)

1 = DESC (сортирует от высоких значений к низким)

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

  {
    "data": {
        "isValid": [
            "ACTIVATION_WAITING"
        ],
        "markets": [
            1,
            23,
            29,
            2,
            3,
            9,
            14,
            19,
            25,
            30,
            22
        ],
        "isOnStockMarket": true,
        "isOnDepositMarket": true,
        "isOnCreditMarket": true,
        "isOnMoneyCbrDepositMarket": true,
        "isOnMoneyFtDepositMarket": true,
        "isOnMDepositMarket": true,
        "isOnMoneyFtRepoMarket": true,
        "activationDateFrom": "2024-12-02",
        "oldFullName": "",
        "tsId": ""
    }

Выходные параметры: в ответе приходит файл.

7. Метод GET /lk/lku/{orgId}/login/management/external/organizations/status/access/markets

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

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
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 нет нет    
stockTradeAdmitDate string(date) нет да Дата допуска организации к торгам на фондовом рынке "stockTradeAdmitDate": "2024-05-29"
creditTradeAdmitDate string(date) нет да Дата допуска организации к торгам на рынке кредитов "creditTradeAdmitDate": "2020-12-14"
depositTradeAdmitDate string(date) нет да Дата допуска организации к торгам на рынке депозитов  "depositTradeAdmitDate": "2024-05-31"
stockAccessMode integer нет да Допуск к торгам на фондовом рынке "stockAccessMode": 2
stockAccessModeName string нет да Наименование статуса допуска к торгам на фондовом рынке "stockAccessModeName": "Допущен"
stockMarketCategory integer нет да Категория участника на фондовом рынке "stockMarketCategory": 7  
stockMarketCategoryName string нет да Наименование категории участника на фондовом рынке "stockMarketCategoryName": "К"
depositAccessMode integer нет да Допуск к торгам на рынке депозитов "depositAccessMode": 2
depositAccessModeName string нет да Наименование статуса допуска к торгам на рынке депозитов "depositAccessModeName": "Допущен"
depositMarketCategory integer нет да Категория участника на рынке депозитов  "depositMarketCategory": 4 
depositMarketCategoryName string нет да Наименование категории участника на рынке депозитов  "depositMarketCategoryName": "Л"
creditAccessMode integer нет да Допуск к торгам на рынке кредитов  "creditAccessMode": 2
creditAccessModeName string нет да Наименование статуса допуска к торгам на рынке кредитов "creditAccessModeName": "Допущен"
creditMarketCategory integer нет да Категория участника на рынке кредитов "creditMarketCategory": 3
creditMarketCategoryName string нет да Наименование категории участника на рынке кредитов "creditMarketCategoryName": "Л"
stockMainClearingAcc integer нет да Допуск к клирингу на ФР, РД, РК "stockMainClearingAcc": 2
stockMainClearingAccName string нет да Наименование статуса допуска к клирингу "stockMainClearingAccName": "Приостановлен"
clearingCategory integer нет да Категория участника клиринга "clearingCategory": 3
clearingCategoryName string нет да Наименование категории участника клиринга "clearingCategoryName": "Индивидуальный Клиринговый Участник"
currencyAccessMode integer нет да Допуск к торгам на валютном рынке "currencyAccessMode": 2
currencyAccessModeName string нет да Наименование статуса допуска к торгам на валютном рынке  "currencyAccessModeName": "Допущен"
currencyMarketCategory integer нет да Категория участника на валютном рынке  "currencyMarketCategory": 2
currencyMarketCategoryName string нет да Наименование категории участника на валютном рынке "currencyMarketCategoryName": "Б"
currencyClearingAcc integer нет да Допуск к клирингу на ВР  "currencyClearingAcc": 3
currencyClearingAccName string нет да Наименование статуса допуска к клирингу ВР  "currencyClearingAccName": "Возобновлен"
currencyTradeAdmitDate string(date) нет да Дата допуска организации к торгам на валютный рынок "currencyTradeAdmitDate": "2013-08-01"
fortsAccessMode integer нет да Допуск к торгам на срочном рынке "fortsAccessMode": 2
fortsAccessModeName string нет да Наименование допуска на срочном рынке "fortsAccessModeName": "Допущен"
fortsClearingAcc integer нет да Допуск к клирингу на СР  "fortsClearingAcc": 1
fortsClearingAccName string нет да Наименование статуса допуска к клирингу СР "fortsClearingAccName": "Допущен"
moneyCbrDepositAdmitDate string(date) нет да Дата допуска к торгам  на Депозиты Банка России "moneyCbrDepositAdmitDate": "2010-02-11"
moneyCbrDepositAccessMode integer нет да Допуск к торгам на Депозиты Банка России "moneyCbrDepositAccessMode": 3
moneyCbrDepositAccessModeName string нет да Статус торгов на рынке Депозитов Банка России "moneyCbrDepositAccessModeName": "Допущен"
ftDepositAdmitDate string(date) нет да Дата допуска к торгам на Депозиты ФК "ftDepositAdmitDate": "2012-07-25"
ftDepositAccessMode integer нет да Допуск к торгам на Депозиты ФК "ftDepositAccessMode": 3
ftDepositAccessModeName string нет да Статус торгов на рынке Депозитов ФК "ftDepositAccessModeName": "Допущен"
mDepositAdmitDate string(date) нет да Дата допуска к торгам на М-Депозиты "mDepositAdmitDate": "2015-09-08"
mDepositAccessMode integer нет да Допуск к торгам на М-Депозиты "mDepositAccessMode": 3
mDepositAccessModeName string нет да Статус торгов на рынке М-Депозитов "mDepositAccessModeName": "Допущен"
ftRepoAdmitDate string(date) нет да Дата допуска к торгам на РЕПО с ФК "ftRepoAdmitDate": "2019-10-17"
ftRepoAccessMode integer нет да Допуск к торгам на РЕПО с ФК  "ftRepoAccessMode": 1
ftRepoAccessModeName string нет да Статус торгов на рынке РЕПО с ФК  "ftRepoAccessModeName": "Кандидат"

8. Метод GET /lk/lku/{orgId}/login/management/external/organizations/orders-linked/{loginId}

Получение списка заявок по конкретному идентификатору для просмотра краткой информацию по заявкам на собственном ПО с использованием API Биржи.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
loginId path string(uuid) да Уникальный идентификатор  Значение loginId из ответа метода /lk/lku/{orgId}/login/management/external/organizations/agents
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 нет да Массив данных
orderId string(uuid) нет нет Ид заявки "orderId": "f3f1e497-e8c5-4c65-9a63-77040d858018"
orderTypeName string нет да Тип заявки "orderTypeName": "ORDER_CANCEL_SM_LOGIN"
orderNumber string нет да Номер заявки  "orderNumber": "34232"
startDate string нет да Дата создания "startDate": "23.10.2024"
state string нет да Статус "state": "ORDER_SERVISE_ERROR_TCS"
stateName string нет да Статус заявки  "stateName": "В работе"
commentPs string нет да Комментарий к заявке "commentPs": "Заявка не удовлетворяет следующим условиям: Указанные адреса не принадлежат Участнику: [10.10.10.10]\n"

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

  {
    "data": [
      {
        "orderId": "67458570-f677-4de7-85bc-8871baa7acca",
        "orderTypeName": "ORDER_ASSIGNING_FO_LOGIN",
        "orderNumber": "5_CREATE_ITD_SR_Autotest_318",
        "startDate": "13.12.2024",
        "state": "ORDER_FULFILLED",
        "stateName": "Исполнено",
        "commentPs": ""Заявка не удовлетворяет следующим условиям: Указанные адреса не принадлежат Участнику: [10.10.10.10]\n""
      }
    }

9. Метод GET /lk/lku/{orgId}/login/management/external/organizations/agents/{agentId}/export

Экспорт параметров идентификатора в формате .xlsx.

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
agentId path string(uuid) да Уникальный идентификатор Значение agentId из ответа метода /lk/lku/{orgId}/login/management/external/organizations/agents
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 

Выходные параметры: в ответе приходит файл в формате .xlsx.

10. Метод GET /lk/lku/{orgId}/login/management/external/organizations/packages/limits

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

Параметр Принадлежность Тип данных Обязательность Наименование Комментарий
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": "10611"
    code string нет да Уникальный публичный идентификатор Пакета услуг, UUID  "code": "62f1e62b-a925-4d55-a384296ee7279891"
    servicePackageType string нет да Название типа пакета  "servicePackageType": "Премиум"
    name string нет да Наименование пакета "name": "Пакет 7 Премиум"
    number integer нет да Номер пакета "number": 7
    startDate string нет да Дата начала действия пакета "startDate": "2024-11-02"
    endDate string нет да Дата окончания действия пакета "endDate": "2024 -11- 04"
    status string нет да Статус пакета "status": "АКТИВНЫЙ"
    rsLimit integer нет да Лимит услуг "ИТД для удаленного Рабочего места "rsLimit": 6
    rsAmount integer нет да Количество услуг "ИТД для удаленного Рабочего места" "rsAmount": 10
    astsLimit integer нет да Лимит услуг "ИТД для шлюзового ПО ASTSBridge" "astsLimit": 3
    astsAmount integer нет да Количество услуг "ИТД для шлюзового ПО ASTSBridge "astsAmount": 1

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

  {
    "data": [
        {
            "id": 10891,
            "code": "ff4621cb-6784-4161-94be-dd05dee2d197",
            "servicePackageType": "Премиум",
            "name": "Пакет 16 Премиум",
            "number": 16,
            "startDate": "2024-11-27",
            "endDate": null,
            "status": "АКТИВНЫЙ",
            "rsLimit": 6,
            "rsAmount": 6,
            "astsLimit": 3,
            "astsAmount": 3
        }
    ]
}