# Up API API

> Up API API on Apizie: 18 endpoints (List accounts, List transactions by account, Retrieve account, List categories, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:up-com-au/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:up-com-au`
- Category: Finance
- Status: byok
- Source: https://github.com/up-banking/api
- Page: https://www.apizie.tech/api/finance/up-com-au
- OpenAPI: https://www.apizie.tech/api/finance/up-com-au/openapi.json

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…

## Endpoints

### List accounts
`GET https://www.apizie.tech/v1/finance:up-com-au/get-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[size] | integer | no | The number of records to return in each page. |
| filter[accountType] | string | no | The type of account for which to return records. This can be used to filter Savers from spending accounts. |
| filter[ownershipType] | string | no | The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts. |

### List transactions by account
`GET https://www.apizie.tech/v1/finance:up-com-au/get-accounts-account-id-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The unique identifier for the account. |
| page[size] | integer | no | The number of records to return in each page. |
| filter[status] | string | no | The transaction status for which to return records. This can be used to filter `HELD` transactions from those that are `SETTLED`. |
| filter[since] | string | no | The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. |
| filter[until] | string | no | The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. |
| filter[category] | string | no | The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter.… |
| filter[tag] | string | no | A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is… |

### Retrieve account
`GET https://www.apizie.tech/v1/finance:up-com-au/get-accounts-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier for the account. |

### List categories
`GET https://www.apizie.tech/v1/finance:up-com-au/get-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter[parent] | string | no | The unique identifier of a parent category for which to return only its children. Providing an invalid category identifier results in a… |

### Retrieve category
`GET https://www.apizie.tech/v1/finance:up-com-au/get-categories-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier for the category. |

### List tags
`GET https://www.apizie.tech/v1/finance:up-com-au/get-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[size] | integer | no | The number of records to return in each page. |

### List transactions
`GET https://www.apizie.tech/v1/finance:up-com-au/get-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[size] | integer | no | The number of records to return in each page. |
| filter[status] | string | no | The transaction status for which to return records. This can be used to filter `HELD` transactions from those that are `SETTLED`. |
| filter[since] | string | no | The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. |
| filter[until] | string | no | The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes. |
| filter[category] | string | no | The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter.… |
| filter[tag] | string | no | A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is… |

### Retrieve transaction
`GET https://www.apizie.tech/v1/finance:up-com-au/get-transactions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier for the transaction. |

### Categorize transaction
`POST https://www.apizie.tech/v1/finance:up-com-au/patch-transactions-transaction-id-relationships-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transactionId | string | yes | The unique identifier for the transaction. |
| body | object | no | JSON request body |

### Add tags to transaction
`POST https://www.apizie.tech/v1/finance:up-com-au/post-transactions-transaction-id-relationships-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transactionId | string | yes | The unique identifier for the transaction. |
| body | object | no | JSON request body |

### Remove tags from transaction
`POST https://www.apizie.tech/v1/finance:up-com-au/delete-transactions-transaction-id-relationships-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transactionId | string | yes | The unique identifier for the transaction. |
| body | object | no | JSON request body |

### Ping
`GET https://www.apizie.tech/v1/finance:up-com-au/get-util-ping` (byok)

### List webhooks
`GET https://www.apizie.tech/v1/finance:up-com-au/get-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page[size] | integer | no | The number of records to return in each page. |

### Create webhook
`POST https://www.apizie.tech/v1/finance:up-com-au/post-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve webhook
`GET https://www.apizie.tech/v1/finance:up-com-au/get-webhooks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier for the webhook. |

### Delete webhook
`POST https://www.apizie.tech/v1/finance:up-com-au/delete-webhooks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The unique identifier for the webhook. |

### List webhook logs
`GET https://www.apizie.tech/v1/finance:up-com-au/get-webhooks-webhook-id-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | The unique identifier for the webhook. |
| page[size] | integer | no | The number of records to return in each page. |

### Ping webhook
`POST https://www.apizie.tech/v1/finance:up-com-au/post-webhooks-webhook-id-ping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | The unique identifier for the webhook. |

## Example
```
curl "https://www.apizie.tech/v1/finance:up-com-au/get-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Up API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/finance:up-com-au/get-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Up API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Up API itself also needs your own key from up.com.au.

### Can AI agents use the Up API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:up-com-au.

### What is the status of the Up API API?
Needs your own provider key (bring your own key)