plaid / plaid-node

Node bindings for Plaid
https://plaid.com/docs
MIT License
519 stars 173 forks source link

Healthcheck endpoint for Plaid API #594

Closed vinitshahdeo closed 1 year ago

vinitshahdeo commented 1 year ago

Issue Summary

I'm seeking assistance in finding a reliable method to assess the health status of the Plaid API.

Workaround

One potential workaround involves retrieving the account ID, but I'm concerned about the associated API usage costs and pricing implications. I'm interested in discovering the optimal approach for evaluating the operational health of the Plaid API.

const response = await plaidClient.accountsGet({
  access_token,
  options: {
    account_ids: ['123456790'],
  },
});
phoenixy1 commented 1 year ago

The correct answer to this is going to depend on what you mean by the operational health of the API, since there are a number of different dimensions to that.

Plaid has a couple of existing methods for assessing health, including

API status reporting Item Health Data, accessible via the API or the Dashboard Institution Health Data, accessible via the API or Dashboard.

More details in the docs: https://plaid.com/docs/account/activity/