Skip to content

Up API API

by up.com.au

Bearer tokenHTTPSFinance
Open documentation ↗

Overview

The Up API gives you programmatic access to your balances and transaction data. You can request past transactions or set up webhooks to receive real-time events when new transactions hit your account. It’s new, it’s exciting and it’s just the beginning.

Up API is a finance API from up.com.au. Requests are authenticated with a bearer token. It is served over HTTPS. Its OpenAPI description documents 18 endpoints.

At a glance

Authentication
Bearer token
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://api.up.com.au/api/v1
Version
v1
Endpoints
18
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.up.com.au/api/v1/accounts" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://api.up.com.au/api/v1/accounts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.up.com.au/api/v1/accounts",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/accountsList accounts
GET/accounts/{accountId}/transactionsList transactions by account
GET/accounts/{id}Retrieve account
GET/categoriesList categories
GET/categories/{id}Retrieve category
GET/tagsList tags
GET/transactionsList transactions
GET/transactions/{id}Retrieve transaction
PATCH/transactions/{transactionId}/relationships/categoryCategorize transaction
POST/transactions/{transactionId}/relationships/tagsAdd tags to transaction
DELETE/transactions/{transactionId}/relationships/tagsRemove tags from transaction
GET/util/pingPing
GET/webhooksList webhooks
POST/webhooksCreate webhook
GET/webhooks/{id}Retrieve webhook
DELETE/webhooks/{id}Delete webhook
GET/webhooks/{webhookId}/logsList webhook logs
POST/webhooks/{webhookId}/pingPing webhook

Questions

Does the Up API API need an API key?

Yes. The Up API API uses Bearer token authentication; the documentation explains how to get credentials.

Does the Up API API support HTTPS?

Yes, the Up API API is served over HTTPS.

How many endpoints does the Up API API have?

Its OpenAPI description lists 18 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Up API API?

Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.

Compare alternatives →

Listed from APIs.guru (CC0).