ynab-ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage ynab-ts API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

YNAB API Endpoints: Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.ynab.com

Table of Contents

• ynab-ts
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • React hooks with TanStack Query
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add ynab-ts
# Install optional peer dependencies if you plan to use React hooks
npm add @tanstack/react-query react react-dom

PNPM

pnpm add ynab-ts
# Install optional peer dependencies if you plan to use React hooks
pnpm add @tanstack/react-query react react-dom

Bun

bun add ynab-ts
# Install optional peer dependencies if you plan to use React hooks
bun add @tanstack/react-query react react-dom

Yarn

yarn add ynab-ts zod
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Ynab } from "ynab-ts";

const ynab = new Ynab({
  bearer: process.env["YNAB_BEARER"] ?? "",
});

async function run() {
  const result = await ynab.user.get();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ---- | ----------- | -------------------- | | bearer | http | HTTP Bearer | YNAB_BEARER |

To authenticate with the API the bearer parameter must be set when initializing the SDK client instance. For example:

import { Ynab } from "ynab-ts";

const ynab = new Ynab({
  bearer: process.env["YNAB_BEARER"] ?? "",
});

async function run() {
  const result = await ynab.user.get();

  console.log(result);
}

run();

Available Resources and Operations

accounts

• list - Account list
• create - Create a new account
• get - Single account

budgets

• list - List budgets
• get - Single budget
• getSettings - Budget Settings

categories

• list - List categories
• get - Single category
• update - Update a category
• getByMonth - Single category for a specific budget month
• updateMonth - Update a category for a specific month

months

• list - List budget months
• get - Single budget month

payeeLocations

• list - List payee locations
• get - Single payee location
• listByPayee - List locations for a payee

payees

• list - List payees
• get - Single payee
• update - Update a payee

scheduledTransactions

• list - List scheduled transactions
• create - Create a single scheduled transaction
• get - Single scheduled transaction
• update - Updates an existing scheduled transaction
• delete - Deletes an existing scheduled transaction

transactions

• list - List transactions
• create - Create a single transaction or multiple transactions
• updateMany - Update multiple transactions
• import - Import transactions
• get - Single transaction
• updateOne - Updates an existing transaction
• delete - Deletes an existing transaction
• listByAccount - List account transactions
• listByCategory - List category transactions, excluding any pending transactions
• listByPayee - List payee transactions, excluding any pending transactions
• listByMonth - List transactions in month, excluding any pending transactions

user

• get - User info

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• accountsCreate - Create a new account
• accountsGet - Single account
• accountsList - Account list
• budgetsGet - Single budget
• budgetsGetSettings - Budget Settings
• budgetsList - List budgets
• categoriesGet - Single category
• categoriesGetByMonth - Single category for a specific budget month
• categoriesList - List categories
• categoriesUpdate - Update a category
• categoriesUpdateMonth - Update a category for a specific month
• monthsGet - Single budget month
• monthsList - List budget months
• payeeLocationsGet - Single payee location
• payeeLocationsList - List payee locations
• payeeLocationsListByPayee - List locations for a payee
• payeesGet - Single payee
• payeesList - List payees
• payeesUpdate - Update a payee
• scheduledTransactionsCreate - Create a single scheduled transaction
• scheduledTransactionsDelete - Deletes an existing scheduled transaction
• scheduledTransactionsGet - Single scheduled transaction
• scheduledTransactionsList - List scheduled transactions
• scheduledTransactionsUpdate - Updates an existing scheduled transaction
• transactionsCreate - Create a single transaction or multiple transactions
• transactionsDelete - Deletes an existing transaction
• transactionsGet - Single transaction
• transactionsImport - Import transactions
• transactionsList - List transactions
• transactionsListByAccount - List account transactions
• transactionsListByCategory - List category transactions, excluding any pending transactions
• transactionsListByMonth - List transactions in month, excluding any pending transactions
• transactionsListByPayee - List payee transactions, excluding any pending transactions
• transactionsUpdateMany - Update multiple transactions
• transactionsUpdateOne - Updates an existing transaction
• userGet - User info

React hooks with TanStack Query

React hooks built on TanStack Query are included in this SDK. These hooks and the utility functions provided alongside them can be used to build rich applications that pull data from the API using one of the most popular asynchronous state management library.

To learn about this feature and how to get started, check REACT_QUERY.md.

[!WARNING]

This feature is currently in preview and is subject to breaking changes within the current major version of the SDK as we gather user feedback on it.

• useAccountsCreateMutation - Create a new account
• useAccountsGet - Single account
• useAccountsList - Account list
• useBudgetsGet - Single budget
• useBudgetsGetSettings - Budget Settings
• useBudgetsList - List budgets
• useCategoriesGet - Single category
• useCategoriesGetByMonth - Single category for a specific budget month
• useCategoriesList - List categories
• useCategoriesUpdateMonthMutation - Update a category for a specific month
• useCategoriesUpdateMutation - Update a category
• useMonthsGet - Single budget month
• useMonthsList - List budget months
• usePayeeLocationsGet - Single payee location
• usePayeeLocationsList - List payee locations
• usePayeeLocationsListByPayee - List locations for a payee
• usePayeesGet - Single payee
• usePayeesList - List payees
• usePayeesUpdateMutation - Update a payee
• useScheduledTransactionsCreateMutation - Create a single scheduled transaction
• useScheduledTransactionsDeleteMutation - Deletes an existing scheduled transaction
• useScheduledTransactionsGet - Single scheduled transaction
• useScheduledTransactionsList - List scheduled transactions
• useScheduledTransactionsUpdateMutation - Updates an existing scheduled transaction
• useTransactionsCreateMutation - Create a single transaction or multiple transactions
• useTransactionsDeleteMutation - Deletes an existing transaction
• useTransactionsGet - Single transaction
• useTransactionsImportMutation - Import transactions
• useTransactionsList - List transactions
• useTransactionsListByAccount - List account transactions
• useTransactionsListByCategory - List category transactions, excluding any pending transactions
• useTransactionsListByMonth - List transactions in month, excluding any pending transactions
• useTransactionsListByPayee - List payee transactions, excluding any pending transactions
• useTransactionsUpdateManyMutation - Update multiple transactions
• useTransactionsUpdateOneMutation - Updates an existing transaction
• useUserGet - User info

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Ynab } from "ynab-ts";

const ynab = new Ynab({
  bearer: process.env["YNAB_BEARER"] ?? "",
});

async function run() {
  const result = await ynab.user.get({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Ynab } from "ynab-ts";

const ynab = new Ynab({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: process.env["YNAB_BEARER"] ?? "",
});

async function run() {
  const result = await ynab.user.get();

  console.log(result);
}

run();

Error Handling

YnabError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Ynab } from "ynab-ts";
import * as errors from "ynab-ts/models/errors";

const ynab = new Ynab({
  bearer: process.env["YNAB_BEARER"] ?? "",
});

async function run() {
  try {
    const result = await ynab.user.get();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.YnabError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.error); // models.ErrorDetail
      }
    }
  }
}

run();

Error Classes

Primary errors:

• YnabError: The base class for HTTP error responses.
  • ErrorResponse: Generic error.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from YnabError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Ynab } from "ynab-ts";

const ynab = new Ynab({
  serverURL: "https://api.ynab.com/v1",
  bearer: process.env["YNAB_BEARER"] ?? "",
});

async function run() {
  const result = await ynab.user.get();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Ynab } from "ynab-ts";
import { HTTPClient } from "ynab-ts/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Ynab({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Ynab } from "ynab-ts";

const sdk = new Ynab({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable YNAB_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy