哈利法克斯共享交易,IWEB共享交易,苏格兰银行股份交易和劳埃德银行直接投资服务的非官方SDK
刮擦互联网银行业务,因此可能会因其前端的更新而破坏
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'
}
} )
这是在拨打任何其他电话之前需要的
返回带有默认帐户的帐户对象
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' } } ]
从“集合默认帐户”页面获取默认帐户的帐户。
返回带有默认帐户的帐户对象
sd . login ( )
. then ( sd . getDefaultAccount )
. then ( console . dir )
// { accountId: '000123456ABCD' }
设置默认帐户
需要您要设置为默认的帐户的帐户对象
返回带有新默认帐户的帐户对象
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' }
返回所有帐户的股息选项
返回带有股息选项数据的帐户对象数组
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在输入数组中必须是唯一的。
返回具有更新的股息选项数据的帐户对象数组
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' } ]
获得帐户的估值
需要一个您希望获得估值的帐户的帐户对象
返回带有估值数据的帐户对象
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
帐户可能会共享相同的帐户代码。我认为这些都是在跨登录中独一无二的。statementId
:语句ID,我认为这是一个从1
开始的增量数字 - 跨登录不是唯一的。语句连接到登录名(与帐户相对),而statementId
s在登录内是唯一的。accounty object
:具有accountId
属性的对象拉力请求在Github上受到欢迎!开始:
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