# Adatree ADR Platform Open Banking API API

> Adatree ADR Platform Open Banking API API on Apizie: 17 endpoints (Get Accounts under cdr arrangement id, Get Bulk Balances, Get Account Balance, Get Account Detail, …) 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://zieapi.vercel.app/v1/finance:adatree-banking/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:adatree-banking`
- Category: Finance
- Status: byok
- Source: https://adatree.com.au
- Page: https://zieapi.vercel.app/api/finance/adatree-banking
- OpenAPI: https://zieapi.vercel.app/api/finance/adatree-banking/openapi.json

Adatree's Accredited Data Recipient (ADR) Platform Open Banking API definition. API payloads conform to the Consumer Data Right Data Standard 1.5.1. Payloads are sample payloads to represent the types of data to which…

## Endpoints

### Get Accounts under cdr arrangement id
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-get-cdr-arrangement-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| product-category | string | no | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If… |
| open-status | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed |
| is-owned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Bulk Balances
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-balances-get-filtered-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountIds | array | no | Adatree's extension to support account ids for GET /accounts/balances |
| product-category | string | no | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If… |
| open-status | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed |
| is-owned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Account Balance
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-balance-obtain-single-account-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountId | string | yes | A tokenised identifier for the account which is unique but not shareable |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Account Detail
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-obtain-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountId | string | yes | A tokenised identifier for the account which is unique but not shareable |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Transactions For Account
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/account-transactions-get-by-account-id-and-cdr-arrangement-i` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountId | string | yes | ID of the account to get transactions for. Must have previously been returned by one of the account list end points. |
| oldest-time | string | no | Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to… |
| newest-time | string | no | Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today.… |
| min-amount | string | no | Filter transactions to only transactions with amounts higher or equal to than this amount |
| max-amount | string | no | Filter transactions to only transactions with amounts less than or equal to than this amount |
| text | string | no | Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields.… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Transaction Detail
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/account-transactions-obtain-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountId | string | yes | ID of the account to get transactions for. Must have previously been returned by one of the account list end points. |
| transactionId | string | yes | ID of the transaction obtained from a previous call to one of the other transaction end points |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Direct Debits For Account
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/account-direct-debits-obtain-for-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountId | string | yes | ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points. |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Bulk Direct Debits
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-direct-debits-get-bulk-direct-debits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountIds | array | no | Adatree's extension to support account ids for GET /accounts/balances |
| product-category | string | no | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If… |
| open-status | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed |
| is-owned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Scheduled Payments for Account
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/account-payments-scheduled-get-scheduled-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountId | string | yes | ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Scheduled Payments Bulk
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/payments-scheduled-bulk-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| accountIds | array | no | Adatree's extension to support account ids for GET /accounts/balances |
| product-category | string | no | Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If… |
| open-status | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed |
| is-owned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Payees
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/payees-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| type | string | no | Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the… |
| page | integer | no | Page of results to request (standard pagination) |
| page-size | integer | no | Page size to request. Default is 25 (standard pagination) |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Payee Detail
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/payees-get-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| payeeId | string | yes | The ID used to locate the details of a particular payee |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get user info under cdr arrangement id
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/user-info-get-by-arrangement-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |

### Get Customer
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/customers-get-customer-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Customer Detail
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/customers-obtain-detailed-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cdrArrangementId | string | yes | Used to identify the consent arrangement from which to identify the bank and consumer information required to fetch the data. |
| x-fapi-auth-date | string | no | The time when the customer last logged in to the data recipient. Required for all resource calls from a machine client. Format is… |
| x-fapi-customer-ip-address | string | no | The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates… |
| x-cds-client-headers | string | no | The customer's original standard http headers [Base64](https://raw.githubusercontent.com) encoded, including the original User Agent… |

### Get Status
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/data-holder-discovery-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| data-holder-ids | array | no | Array of strings used to identify the data holder from which to fetch the product/outage/status data. |

### Get Outages
`GET https://zieapi.vercel.app/v1/finance:adatree-banking/data-holder-discovery-get-outages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| data-holder-ids | array | no | Array of strings used to identify the data holder from which to fetch the product/outage/status data. |

## Example
```
curl "https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-get-cdr-arrangement-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Adatree ADR Platform Open Banking API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/finance:adatree-banking/accounts-get-cdr-arrangement-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Adatree ADR Platform Open Banking API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Adatree ADR Platform Open Banking API itself also needs your own key from cdr-insights-prod.api.adatree.com.au.

### Can AI agents use the Adatree ADR Platform Open Banking API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:adatree-banking.

### What is the status of the Adatree ADR Platform Open Banking API API?
Needs your own provider key (bring your own key)