{"message":"Rates retrieved successfully","data":[{"id":"a5e5553c-ea50-4f6b-ba7a-4b6c00eab637","country":"Australia","timestamp":1768322898,"rate":"5.51"}],"success":true}
curl --location --request GET 'https://zylalabs.com/api/11705/australia+mortgage+data+extractor+api/22116/get+rates' --header 'Authorization: Bearer YOUR_API_KEY'
{"message":"Rates retrieved successfully","data":[{"id":"a5e5553c-ea50-4f6b-ba7a-4b6c00eab637","country":"Australia","timestamp":1768322898,"rate":"5.51"}],"success":true}
curl --location --request GET 'https://zylalabs.com/api/11705/australia+mortgage+data+extractor+api/22118/historical?date=2026-01-13' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Australia Mortgage Data Extractor API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
This API provides structured and reliable access to current mortgage rates in Australia, allowing developers, financial analysts, and digital applications to obtain up-to-date information in a simple and standardized manner. The service response is designed in JSON format, which facilitates its integration with web systems, mobile applications, analytics dashboards, and financial platforms.
The response object includes a descriptive message confirming the result of the operation, as well as a Boolean success indicator that allows you to quickly validate whether the request was processed correctly. This is especially useful for error handling and data flow automation in production environments.
Within the data field, the API returns an array of records containing detailed information about mortgage rates. Each record includes a unique identifier (UUID), which allows each piece of data to be tracked and referenced unambiguously. The country field specifies the country to which the rate corresponds, in this case Australia, making it possible to scale the service to multiple regions in the future.
The timestamp field represents a timestamp in Unix format, indicating the exact time the rate was recorded or updated. This is essential for historical analysis, temporal comparisons, and validation of the validity of the information. The rate field shows the mortgage rate expressed as a numerical value in text format, which provides flexibility for conversion, display, or further processing according to the needs of the API consumer.
This API is ideal for mortgage comparison applications, financial planning tools, credit risk models, and financial advisory systems. By centralizing access to up-to-date mortgage rates, it reduces reliance on manual sources and improves the accuracy of financial calculations. Overall, the API provides a solid, clear, and extensible foundation for working with key Australian mortgage market information efficiently and securely.
The "Get Rates" endpoint returns current mortgage rates in Australia, including a unique identifier, country, timestamp, and rate value. The "Historical" endpoint provides similar data but focuses on past mortgage rates, allowing for temporal analysis.
Key fields in the response data include "id" (UUID), "country" (specifying Australia), "timestamp" (in Unix format), and "rate" (the mortgage rate as a numerical value). These fields facilitate tracking and analysis.
The API returns data in JSON format. Each response includes a "message" confirming the operation's success, a "success" Boolean indicator, and a "data" array containing records with detailed mortgage rate information.
The "Get Rates" endpoint provides the latest mortgage rates, while the "Historical" endpoint offers past rates. Both endpoints include identifiers, country context, timestamps, and rate values for comprehensive analysis.
The response data is organized into a JSON object containing a "message," a "success" indicator, and a "data" array. Each entry in the "data" array represents a mortgage rate record with its respective fields.
The API sources its mortgage rate data from reliable financial institutions and market reports in Australia. Data accuracy is maintained through regular updates and validation processes to ensure reliability.
Typical use cases include mortgage comparison applications, financial planning tools, credit risk models, and financial advisory systems. The API centralizes access to mortgage rates, enhancing accuracy in financial calculations.
Users can utilize the returned data by parsing the JSON response to extract relevant fields like "rate" for display or analysis. The "timestamp" allows for historical comparisons, while the "id" can be used for tracking specific rates.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund