halifax share dealing sdk Скачать - halifax share dealing sdk Source Code Скачать

Halifax-Share-Dealing-SDK

Неофициальный SDK для сделки с акциями Halifax, IWEB Share Dealling, Банк Шотландии.

Скрещивает интернет -банкинг, поэтому может быть нарушена обновлениями до их фронта

Использование

Настраивать

 import halifaxShareDealingSdk from 'halifax-share-dealing-sdk'
// Alternatively:
// const halifaxShareDealingSdk = require('halifax-share-dealing-sdk').default

const sd = halifaxShareDealingSdk ( {
  site : 'halifax' , // one of 'halifax', 'iweb', 'bos', 'lloyds'
  USERNAME : 'username' ,
  PASSWORD : 'password' ,
  MEMORABLE_INFORMATION : {
    "Your mother's FIRST name" : 'Jane' ,
    "Your father's FIRST name" : 'John' ,
    'Your place/town of birth' : 'Anytown' ,
    'The name of your first school' : 'Anyschool'
  }
} )

Авторизоваться

Это требуется, прежде чем делать какие -либо другие звонки

Возвращает объект Accounty с учетной записью по умолчанию

 sd . login ( )
  . then ( console . dir )

// { accountId: '000123456ABCD' }

Получите учетные записи

Списки все учетные записи

Возвращает множество объектов учетной записи с именами учетных записей и балансами

 sd . login ( )
  . then ( sd . getAccounts )
  . then ( console . dir )

// [ { accountId: '000123456',
//     name: 'Share Dealing Account',
//     availableToInvest: { asFloat: 1.23, asText: '£1.23', asRawText: '£1.23' },
//     totalSecurities: { asFloat: 4.56, asText: '£4.56', asRawText: '£4.56' },
//     totalValue: { asFloat: 5.79, asText: '£5.79', asRawText: '£5.79' } },
//   { accountId: '000123456ABCD',
//     name: 'Stocks and Shares ISA',
//     availableToInvest: { asFloat: 1.23, asText: '£1.23', asRawText: '£1.23' },
//     totalSecurities: { asFloat: 4.56, asText: '£4.56', asRawText: '£4.56' },
//     totalValue: { asFloat: 5.79, asText: '£5.79', asRawText: '£5.79' } } ]

Получить учетную запись по умолчанию

Получает AccountID для учетной записи по умолчанию со страницы «Установить учетную запись по умолчанию».

Возвращает объект Accounty с учетной записью по умолчанию

 sd . login ( )
  . then ( sd . getDefaultAccount )
  . then ( console . dir )

// { accountId: '000123456ABCD' }

Установить учетную запись по умолчанию

Устанавливает учетную запись по умолчанию

Требуется объект Accounty для учетной записи, которую вы хотите установить по умолчанию

Возвращает объект Accounty с новой учетной записью по умолчанию

 sd . login ( )
  . then ( ( ) => sd . setDefaultAccount ( { accountId : '000123456' } ) )
  . then ( console . dir )

// { accountId: '000123456' }

 sd . login ( )
  . then ( sd . getAccounts )
  . then ( accounts => accounts . find ( account => account . name == 'Share Dealing Account' ) )
  . then ( sd . setDefaultAccount )
  . then ( console . dir )

// { accountId: '000123456' }

Получите варианты дивидендов

Возвращает варианты дивидендов для всех учетных записей

Возвращает массив объектов Accounty с данными опции дивидендов

 sd . login ( )
  . then ( sd . getDividendOptions )
  . then ( console . dir )

// [ { accountId: '000123456',
//     dividendOptionCode: 'H',
//     dividendOptionName: 'Hold In Account' },
//   { accountId: '000123456ABCD',
//     dividendOptionCode: 'R',
//     dividendOptionName: 'Automatic Dividend Reinvestment' } ]

Установите параметры дивидендов

Устанавливает параметры дивидендов для всех учетных записей

Требуется массив объектов аккаунта с dividendOptionCode s. Требуются только данные для учетных записей, которые вы хотите изменить. dividendOptionName s необязательны, но если при условии, что запрос не будет выполнена, если dividendOptionCode S и dividendOptionName S не совпадают. accountId S должен быть уникальным в массиве ввода.

Возвращает массив объектов Accounty с обновленными данными опции дивидендов

 sd . login ( )
  . then ( ( ) => [
      {
        accountId : '000123456ABCD' ,
        dividendOptionCode : 'P6'
      }
    ] )
  . then ( sd . setDividendOptions )
  . then ( console . dir )

// [ { accountId: '000123456',
//     dividendOptionCode: 'H',
//     dividendOptionName: 'Hold In Account' },
//   { accountId: '000123456ABCD',
//     dividendOptionCode: 'P6',
//     dividendOptionName: 'Pay Away 6-Monthly' } ]

Получить заявления

Получает все заявления

Возвращает множество заявлений

 sd . login ( )
  . then ( sd . getStatements )
  . then ( console . dir )

// [ { statementId: '1', statementDate: '01 Jan 1970' } ]

Получите оценку

Получает оценку для учетной записи

Требуется объект аккаунта для учетной записи, которую вы хотите получить

Возвращает объект Accounty с данными оценки

 sd . login ( )
  . then ( sd . getValuation )
  . then ( console . dir )

// { accountId: '000123456ABCD',
//   stocks:
//      [ { TIDM: 'LLOY',
//        fullName: 'LLOYDS BANKING GP ORD GBP0.1',
//        holding: { asFloat: 100, asText: '100.000', asRawText: '100.000' },
//        avgCostPerShare: { asFloat: 0.495, asText: '49.50p', asRawText: '49.50p' },
//        bookCost: { asFloat: 49.5, asText: '£49.50', asRawText: '£49.50' },
//        latestPricePerShare: { asFloat: 0.555, asText: '55.50p', asRawText: '*55.50p' },
//        valuation: { asFloat: 55.5, asText: '£55.50', asRawText: '£55.50' },
//        change:
//         { absolute: { asFloat: 6, asText: '£6.00', asRawText: '£6.00' },
//           percentage: { asFloat: 0.1212, asText: '12.12%', asRawText: '12.12%' } } } ],
//   cash: { asFloat: 1000, asText: '£1000.00', asRawText: '£ 1,000.00' },
//   availableToInvest: { asFloat: 1000, asText: '£1000.00', asRawText: '£ 1,000.00' },
//   totalSecurities: { asFloat: 55.5, asText: '£55.50', asRawText: '£ 55.50' },
//   totalValue: { asFloat: 1055.5, asText: '£1055.50' } }

Получить историю дивидендов

Получает историю дивидендов для учетной записи

Требуется объект аккаунта для учетной записи, которую вы хотите получить для истории дивидендов

Возвращает множество исторических дивидендов, касающихся учетной записи

 sd . login ( )
  . then ( sd . getDividendHistory )
  . then ( console . dir )

// [ { issueDate: '09 Oct 2019',
//     fullName: 'VANGUARD FUNDS PLC FTSE 250 UCITS ETF GBP DIS',
//     exDividendDate: '26 Sep 2019',
//     sharesHeldOnExDividendDate: { asFloat: 1, asText: '1', asRawText: '1' },
//     amountPayable: { asFloat: 0.26, asText: '£0.26', asRawText: '£0.26' },
//     handlingOperation:
//      { dividendOptionCode: 'Hold In Account',
//        dividendOptionName: 'H' },
//     cashRef: 'ABCDXYZ123' } ]

Глоссарий

accountId : эквивалентно тому, что, я думаю, Halifax вызывает PortCode . Обычно код учетной записи с потенциально некоторыми буквами после этого. Учетные записи с различным accountId S может совместно использовать один и тот же код учетной записи. Я думаю, что они уникальны в разных логиках.
statementId : идентификатор оператора, я думаю, что это номер увеличения, начинающийся с 1 , не уникальный для входа в систему. Заявления прикреплены к входу в систему (в отличие от учетной записи), а statementId уникальны в рамках входа в систему.
accounty object : объект со свойством accountId

Внося

Запросы на тягу приветствуются на GitHub! Чтобы начать:

Установить git и node.js
Клонировать репозиторий
Установить зависимости с npm install
Запустите npm run test запустить тесты с Jest
Строить с помощью npm run build

Полезный крюк перед предварительным обменом (сохранение как .git/hooks/pre-commit ) для обеспечения прохождения тестов, код отформатируется правильно, и вы не случайно оставили свои личные данные IS (измените 000123456 в код своей учетной записи или другой Персональные данные, которые вы хотите найти):

 #! /bin/sh
npm run test && npm run lint && ! grep --exclude=pre-commit -r ' 000123456 ' .

ПРЕДУПРЕЖДЕНИЕ: По -прежнему можно совершить ваши данные, если вы их выставите, удалите их, а затем совершите. Пожалуйста, будьте осторожны!

Выпуски

Версии следуют спецификации семантической версии.

Чтобы выпустить:

Используйте npm version <major | minor | patch> чтобы установить версию
Запустите git push --follow-tags чтобы нажимать
Подождите, пока действия GitHub опубликуют в реестре NPM.

Расширять

halifax share dealing sdk