https://github.com/jmpa-io/up-go
📚 A Go abstraction over the Up Bank API: https://developer.up.com.au/docs.
https://github.com/jmpa-io/up-go
finance personal-finance sdk up up-bank
Last synced: 3 months ago
JSON representation
📚 A Go abstraction over the Up Bank API: https://developer.up.com.au/docs.
- Host: GitHub
- URL: https://github.com/jmpa-io/up-go
- Owner: jmpa-io
- License: mit
- Created: 2021-07-07T11:14:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-22T01:15:20.000Z (5 months ago)
- Last Synced: 2025-06-16T23:05:30.443Z (4 months ago)
- Topics: finance, personal-finance, sdk, up, up-bank
- Language: Go
- Homepage:
- Size: 7.78 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## `up-go`
```diff
+ 📚 A Go abstraction over the Up Bank API: https://developer.up.com.au/docs.
- This is a WORK-IN-PROGRESS. Use at your own risk!
! This repository has no ties to Up.
```
[](https://github.com/jmpa-io/up-go/actions/workflows/cicd.yml)
[](https://codecov.io/github/jmpa-io/up-go)
## `API Coverage`
The following API endpoints are currently covered by this package:
- [x] [List accounts](https://developer.up.com.au/#get_accounts).
- [ ] [Get an account by id](https://developer.up.com.au/#get_accounts_id).
- [ ] [List attachments](https://developer.up.com.au/#get_attachments).
- [ ] [Get an attachment by id](https://developer.up.com.au/#get_attachments_id).
- [ ] [List categories](https://developer.up.com.au/#get_categories).
- [ ] [Get a category by id](https://developer.up.com.au/#get_categories).
- [ ] [Add a category to a transaction](https://developer.up.com.au/#patch_transactions_transactionId_relationships_category).
- [x] [List tags](https://developer.up.com.au/#get_tags).
- [x] [Add tags to a transaction](https://developer.up.com.au/#post_transactions_transactionId_relationships_tags).
- [x] [Remote tags from a transaction](https://developer.up.com.au/#delete_transactions_transactionId_relationships_tags).
- [x] [List transactions](https://developer.up.com.au/#get_transactions).
- [ ] [Get a transaction by id](https://developer.up.com.au/#get_transactions_id).
- [ ] [List transactions by account](https://developer.up.com.au/#get_accounts_accountId_transactions).
- [x] [Utility - Ping](https://developer.up.com.au/#get_util_ping).
- [ ] [List webhooks](https://developer.up.com.au/#get_webhooks).
- [ ] [Create a webhook](https://developer.up.com.au/#post_webhooks).
- [ ] [Get a webhook by id](https://developer.up.com.au/#get_webhooks_id).
- [ ] [Delete webhook](https://developer.up.com.au/#delete_webhooks_id).
- [ ] [Ping a webhook](https://developer.up.com.au/#post_webhooks_webhookId_ping).
- [ ] [List webhook logs](https://developer.up.com.au/#get_webhooks_webhookId_logs).
## `Usage`
Below is a basic example of how to get started with this package:
```go
package main
import (
"context"
"fmt"
"log/slog"
"os"
"github.com/jmpa-io/up-go"
)
func main() {
// setup tracing.
ctx := context.TODO()
// retrieve token.
token := os.Getenv("UP_TOKEN")
// setup client.
c, err := up.New(ctx, token, up.WithLogLevel(slog.LevelWarn))
if err != nil {
fmt.Printf("failed to setup client: %v\n", err)
os.Exit(1)
}
// ping!
p, err := c.Ping(ctx)
if err != nil {
fmt.Printf("failed to ping: %v\n", err)
os.Exit(1)
}
fmt.Printf("%s\n", p.Meta.StatusEmoji)
}
```
For more explicit examples, see the `cmd/*/main.go` files for details.
## `License`
This work is published under the MIT license.
Please see the [`LICENSE`](./LICENSE) file for details.