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
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.up.com.au/api/v1/accounts" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"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);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
| Method | Path | What it does |
|---|---|---|
| GET | /accounts | List accounts |
| GET | /accounts/{accountId}/transactions | List transactions by account |
| GET | /accounts/{id} | Retrieve account |
| GET | /categories | List categories |
| GET | /categories/{id} | Retrieve category |
| GET | /tags | List tags |
| GET | /transactions | List transactions |
| GET | /transactions/{id} | Retrieve transaction |
| PATCH | /transactions/{transactionId}/relationships/category | Categorize transaction |
| POST | /transactions/{transactionId}/relationships/tags | Add tags to transaction |
| DELETE | /transactions/{transactionId}/relationships/tags | Remove tags from transaction |
| GET | /util/ping | Ping |
| GET | /webhooks | List webhooks |
| POST | /webhooks | Create webhook |
| GET | /webhooks/{id} | Retrieve webhook |
| DELETE | /webhooks/{id} | Delete webhook |
| GET | /webhooks/{webhookId}/logs | List webhook logs |
| POST | /webhooks/{webhookId}/ping | Ping 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.
Similar finance APIs
Compare alternatives →Stripe
FinancePayment processing, subscriptions, and financial management
SEC EDGAR Data
FinanceAPI to access annual reports of public US companies
Plaid
FinanceConnect with user's bank accounts and access transaction data
Fed Treasury
FinanceU.S. Department of the Treasury Data
Razorpay IFSC
FinanceIndian Financial Systems Code (Bank Branch Codes)
Klarna
FinanceKlarna payment and shopping service
Listed from APIs.guru (CC0).