halifax share dealing sdk

Halifax-share-reading-sdk

SDK غير الرسمي لـ Halifax Share Depling و IWEB أسهم معالجة Bank of Scotland Share وخدمة Lloyds Bank Direct Directments Service

تدوير الخدمات المصرفية عبر الإنترنت ، لذلك قد يتم كسرها من خلال التحديثات إلى الواجهة الأمامية

الاستخدام

يثبت

 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' } } ]

احصل على حساب افتراضي

يحصل على الحساب للحساب الافتراضي من صفحة "Set Default Account".

إرجاع كائن المحاسبة مع الحساب الافتراضي

 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 : أي ما يعادل ما أعتقد أن هاليفاكس استدعاء PortCode . عادةً ما يكون رمز الحساب مع بعض الحروف بعد ذلك. قد تشارك الحسابات ذات accountId المختلفة في رمز الحساب نفسه. أعتقد أن هذه فريدة من نوعها عبر تسجيل الدخول.
• statementId : معرف البيان ، أعتقد أنه رقم متزايد يبدأ من 1 - ليس فريدًا عبر تسجيلات الدخول. يتم إرفاق البيانات بتسجيل الدخول (على عكس الحساب) ، و statementId S فريدة من نوعها داخل تسجيل الدخول.
• accounty object : كائن به خاصية accountId

المساهمة

يتم الترحيب بطلبات السحب على جيثب! للبدء:

1. تثبيت git و node.js
2. استنساخ المستودع
3. تثبيت التبعيات مع npm install
4. قم بتشغيل npm run test لتشغيل الاختبارات مع Jest
5. بناء مع npm run build

خطاف مفيد قبل الالتزام (حفظ كـ .git/hooks/pre-commit ) لضمان تمرير الاختبارات ، يتم تنسيق الكود بشكل صحيح ولم تترك تفاصيلك الشخصية عن طريق الخطأ (تغيير 000123456 إلى رمز حسابك أو غيره البيانات الشخصية التي تريد البحث عنها):

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

تحذير: لا يزال من الممكن ارتكاب بياناتك إذا قمت بتنظيمها وحذفها ثم الالتزام. من فضلك كن حذرا!

الإصدارات

تتبع الإصدارات مواصفات الإصدار الدلالي.

للإفراج:

1. استخدم npm version <major | minor | patch> لتصوير الإصدار
2. قم بتشغيل git push --follow-tags للدفع بالعلامات
3. انتظر إجراءات GitHub للنشر إلى سجل NPM.