YNAB API .NET Core Library

Please read the YNAB API documentation for an overview of using the API and a complete list of available resources.

This client is generated using the OpenAPI Code Generator

Include the Package

First, include the nuget package YNAB.SDK:

dotnet add package YNAB.SDK

Usage

To use this client, you must obtain an access token from the My Account area of the YNAB web application.

var accessToken = "NOT_A_REAL_TOKEN";
var ynabApi = new YNAB.SDK.API(accessToken);

public async Task ListBudgets() {
  var budgetsResponse = await ynabApi.Budgets.GetBudgetsAsync();
  budgetsResponse.Data.Budgets.ForEach(budget => {
    Console.WriteLine($"Budget Name: {budget.Name}");
  });
}

Error Handling

If a response is returned with a code >= 300, instead of returning the response, the response will be thrown as an error to be caught.

var accessToken = "invalid_token";
var ynabApi = new YNAB.SDK.API(accessToken);

public async Task ListBudgets() {
  try {
    var budgetsResponse = await ynabAPI.Budgets.GetBudgets();
    // Won't get here because an error will be thrown
  } catch (YNAB.SDK.Client.ApiException ex) {
    Console.WriteLine(ex.ErrorCode); // 401
  }
}

Examples

See the examples folder for example usage scenarios.

Methods

The following methods are available in this library from the YNAB.SDK.API class. See the Open API generated docs for more details on lower level objects.

License

Copyright (c) 2019 Jake Moening

Licensed under the Apache-2.0 license