# Adatree ADR Platform Data API API

> Adatree ADR Platform Data API API on Apizie: 13 endpoints (Get Banking Accounts, Get Banking Transactions, Get Banking Payees, Get Banking Direct Debits, …) 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://apizie.tech/v1/finance:adatree-data/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:adatree-data`
- Category: Finance
- Status: byok
- Source: https://adatree.com.au
- Page: https://apizie.tech/api/finance/adatree-data
- OpenAPI: https://apizie.tech/api/finance/adatree-data/openapi.json

Adatree's Accredited Data Recipient (ADR) Platform Data API definition. Includes Banking and Energy.

## Endpoints

### Get Banking Accounts
`GET https://apizie.tech/v1/finance:adatree-data/banking-get-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| isOwned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| openStatus | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED |
| productCategories | array | 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… |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |
| Adatree-Consumer-Auth-Date | string | no | The time when the customer last logged in. Mandatory for consumer present calls using a Machine token. |
| Adatree-Consumer-Ip-Address | string | no | The consumer's original IP address. Mandatory for consumer present calls using a Machine token. |
| Adatree-Consumer-User-Agent | string | no | User Agent header of the consumer facing application. Mandatory for consumer present calls using a Machine token. |

### Get Banking Transactions
`GET https://apizie.tech/v1/finance:adatree-data/banking-get-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| types | array | no | Used to filter results on the type field. |
| statuses | array | no | Used to filter results by status. |
| minimumAmount | number | no | Used to filter results on the amount field |
| maximumAmount | number | no | Used to filter results on the amount field |
| oldestRetrievalTime | string | no | Constrain the transaction history request to transactions with retrieval time at or after this date/time. Format is aligned to… |
| newestRetrievalTime | string | no | Constrain the transaction history request to transactions with retrieval time at or before this date/time. Format is aligned to… |
| oldestTime | string | no | Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to… |
| newestTime | string | no | Constrain the transaction history request to transactions with effective time at or before this date/time. Format is aligned to… |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Banking Payees
`GET https://apizie.tech/v1/finance:adatree-data/banking-get-payee-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| types | array | no | Used to filter results on the payee type field. |
| payeeIds | array | no | Used to filter results on the payeeId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Banking Direct Debits
`GET https://apizie.tech/v1/finance:adatree-data/banking-get-direct-debits-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| isOwned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| openStatus | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED |
| productCategories | array | 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… |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Scheduled Payments
`GET https://apizie.tech/v1/finance:adatree-data/banking-list-scheduled-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| isOwned | boolean | no | Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and… |
| openStatus | string | no | Used to filter results according to open/closed status. Values can be OPEN, CLOSED |
| productCategories | array | 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… |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Banking Products
`GET https://apizie.tech/v1/finance:adatree-data/banking-get-banking-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| productCategories | array | 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… |
| productIds | array | no | IDs of the specific products |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Customers
`GET https://apizie.tech/v1/finance:adatree-data/common-get-consumer-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| customerUTypes | array | no | Used to filter results on the customerUType field applicable to customers. Any one of the valid values for this field can be supplied. |

### Get Energy Plans
`GET https://apizie.tech/v1/finance:adatree-data/energy-get-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| planIds | array | no | Used to filter results on the planId field. |
| planTypes | array | no | Used to filter results on the type field. |
| fuelTypes | array | no | Used to filter results on the fuel type field. |
| effective | string | no | Used to filter results on the effective field. |
| updatedSince | string | no | Used to filter results on the updatedSince field |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Energy Accounts
`GET https://apizie.tech/v1/finance:adatree-data/energy-get-consumer-energy-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Energy Invoices
`GET https://apizie.tech/v1/finance:adatree-data/energy-get-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| invoiceIds | array | no | Used to filter results on the invoiceId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Energy Bills
`GET https://apizie.tech/v1/finance:adatree-data/energy-get-bills` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| accountIds | array | no | Used to filter results on the accountId field. |
| billingIds | array | no | Used to filter results on the billingId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Electricity Service Points
`GET https://apizie.tech/v1/finance:adatree-data/energy-get-service-points` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| servicePointIds | array | no | Used to filter results on the servicePointId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |

### Get Electricity Usage
`GET https://apizie.tech/v1/finance:adatree-data/energy-get-consumer-electricity-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| useCaseIds | array | no | Used to filter results on the useCaseId field. |
| cdrArrangementIds | array | no | Used to filter results on the cdrArrangementId field. |
| consentIds | array | no | Used to filter results on the consentId field. |
| consumerIds | array | no | Used to filter results on the consumerId field. |
| servicePointIds | array | no | Used to filter results on the servicePointId field. |
| dataHolderBrandIds | array | no | Used to filter results on the dataHolderBrandId field. |
| page | integer | no | Page of results to request (standard pagination) |
| pageSize | integer | no | Page size to request |
| oldestDate | string | no | Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. |
| newestDate | string | no | Constrain the request to records with effective date at or before this date. If absent defaults to current date. |
| Adatree-Consumer-Auth-Date | string | no | The time when the customer last logged in. Mandatory for consumer present calls using a Machine token. |
| Adatree-Consumer-Ip-Address | string | no | The consumer's original IP address. Mandatory for consumer present calls using a Machine token. |
| Adatree-Consumer-User-Agent | string | no | User Agent header of the consumer facing application. Mandatory for consumer present calls using a Machine token. |

## Example
```
curl "https://apizie.tech/v1/finance:adatree-data/banking-get-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

### Is the Adatree ADR Platform Data 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 Data API itself also needs your own key from cdr-insights-prod.api.adatree.com.au.

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

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