Class OneZeroScraper

OneZero bank scraper — fetches transactions via GraphQL.

Hierarchy

default<IScraperSpecificCredentials>
- OneZeroScraper

Index

Constructors

Properties

Methods

fetchData getLongTermTwoFactorToken initialize login onProgress scrape triggerTwoFactorAuth

Constructors

constructor

new OneZeroScraper(options: ScraperOptions): OneZeroScraper
Create a new BaseScraper with the given options.
Parameters
- options: ScraperOptions
  Scraper configuration options.
Returns OneZeroScraper
Inherited from BaseScraper<IScraperSpecificCredentials>.constructor
- Defined in Scrapers/Base/BaseScraper.ts:93

Properties

options

options: ScraperOptions

Scraper configuration options.

Methods

fetchData

fetchData(): Promise<IScraperScrapingResult>
Fetch transaction data for all portfolios.

Returns Promise<IScraperScrapingResult>
The scraping result with accounts.
Overrides BaseScraper.fetchData
- Defined in Scrapers/OneZero/OneZeroScraper.ts:166

getLongTermTwoFactorToken

getLongTermTwoFactorToken(
otpCode: string,
): Promise<ScraperGetLongTermTwoFactorTokenResult>
Verify OTP code and return a long-term token.
Parameters
- otpCode: string
  The OTP code from the user.
Returns Promise<ScraperGetLongTermTwoFactorTokenResult>
The long-term token result.
Overrides BaseScraper.getLongTermTwoFactorToken
- Defined in Scrapers/OneZero/OneZeroScraper.ts:129

initialize

initialize(): Promise<boolean>
Initialize the scraper and set the default timezone.

Returns Promise<boolean>
True when initialization completes.
Inherited from BaseScraper.initialize
- Defined in Scrapers/Base/BaseScraper.ts:101

login(credentials: IScraperSpecificCredentials): Promise<IScraperLoginResult>
Login using email, password, and OTP.
Parameters
- credentials: IScraperSpecificCredentials
  The user credentials.
Returns Promise<IScraperLoginResult>
The login result.
Overrides BaseScraper.login
- Defined in Scrapers/OneZero/OneZeroScraper.ts:151

onProgress

onProgress(
func: (companyId: CompanyTypes, payload: IProgressPayload) => void,
): void
Register a listener for scrape progress events.
Parameters
- func: (companyId: CompanyTypes, payload: IProgressPayload) => void
  Callback receiving company ID and progress payload.
Returns void
Inherited from BaseScraper.onProgress
- Defined in Scrapers/Base/BaseScraper.ts:144

scrape

scrape(
credentials: IScraperSpecificCredentials,
): Promise<IScraperScrapingResult>
Run the full scrape lifecycle: init, login, fetch, terminate.
Parameters
- credentials: IScraperSpecificCredentials
  The user's bank credentials.
Returns Promise<IScraperScrapingResult>
The scraping result with accounts or error details.
Inherited from BaseScraper.scrape
- Defined in Scrapers/Base/BaseScraper.ts:112

triggerTwoFactorAuth

triggerTwoFactorAuth(
phoneNumber: string,
): Promise<ScraperTwoFactorAuthTriggerResult>
Trigger two-factor auth by sending an OTP.
Parameters
- phoneNumber: string
  Full international phone number.
Returns Promise<ScraperTwoFactorAuthTriggerResult>
The trigger result.
Overrides BaseScraper.triggerTwoFactorAuth
- Defined in Scrapers/OneZero/OneZeroScraper.ts:111