ynab

README

YNAB API Go Library

This is an UNOFFICIAL Go client for the YNAB API. It covers 100% of the resources made available by the YNAB API.

Installation

go get go.bmvs.io/ynab

Usage

To use this client you must obtain an access token from your My Account page of the YNAB web app.

package main

import (
	"fmt"

	"go.bmvs.io/ynab"
)

const accessToken = "bf0cbb14b4330-not-real-3de12e66a389eaafe2"

func main() {
	c := ynab.NewClient(accessToken)
	budgets, err := c.Budget().GetBudgets()
	if err != nil {
		panic(err)
	}
	
	for _, budget := range budgets {
		fmt.Println(budget.Name)
		// ...
	}
}

See the godoc to see all the available methods with example usage.

Development

• Make sure you have Go 1.11 or later installed
• Make sure you have exported GO111MODULE=on in your environment to be able do handle dependencies
• Run tests with go test -race ./...

License

BSD-2-Clause

Documentation

Overview

Package ynab implements the client API

Index

• type ClientServicer
  • func NewClient(accessToken string) ClientServicer

Examples

• NewClient

Types

type ClientServicer

type ClientServicer interface {
	User() *user.Service
	Budget() *budget.Service
	Account() *account.Service
	Category() *category.Service
	Payee() *payee.Service
	Month() *month.Service
	Transaction() *transaction.Service

	RateLimit() *api.RateLimit
}

ClientServicer contract for a client service API

func NewClient

func NewClient(accessToken string) ClientServicer

NewClient facilitates the creation of a new client instance

Example

package main

import (
	"go.bmvs.io/ynab"
)

func main() {
	c := ynab.NewClient("<valid_ynab_access_token>")
	c.User().GetUser()
}