Vastu Report APIs Overview
Developers can leverage Vastu Report APIs to seamlessly integrate and display Vastuscore™ for properties. These APIs empower your application to provide valuable insights into the Vastu compliance of a property, enhancing the user experience with real-time information.
Key Features
Add Vastuscore™ Vastu Evaluation Report to your real estate listings.
Enable public access on customized reports and provide a direct link to this detailed Vastu Report of a property for users to access.
Getting Started
Purchasing credits automatically grants you permission to get Vastuscore™ Report for your properties and to make use of our API for those properties. To start using the API, you will need an API key. Request an API Key by contacting us
Available APIs with examples
1. Get Reports API
This API provides a list of meta data of all previously generated Vastuscore™ reports associated with the account.This API returns a JSON output
GET /v1/reports HTTP/1.1
Host: api.vastureport.com
Authorization: Bearer <<YOUR_API_KEY>>
X-Token-Type: API_KEY
Response JSON Data Types
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier for the report. |
| title | string | Title of the report. |
cURL example:
curl --location 'https://api.vastureport.com/v1/reports' --header "Authorization: Bearer {'<<YOUR_API_KEY>>'}" --header "X-Token-Type: API_KEY"
Sample Response:
[ { "id": "a8190ae6-87da-11ee-a207-b0390a868506", "title": "test 1" }, { "id": "3ba7902a-87db-11ee-a207-b0390a868506", "title": "test 2" } ]
2. Get Vastuscore™ evaluation report API
This API provides detailed information about the Vastu Analysis for a specific property. The Vastuscore™ evlauation report offers insights into the property's Vastu compliance. Users can access a detailed report through the provided link. If available, a custom report link is included, offering additional tailored information that can be utilized for property sales advertisements. It's important to note that the Detailed Report Link and Custom Report Link will be null if the reports are not shared. The response format is JSON.
GET /v1/reports/<<report id>> HTTP/1.1
Host: api.vastureport.com
Authorization: Bearer <<YOUR_API_KEY>>
X-Token-Type: API_KEY
Response JSON Data Types
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier for the report. |
| title | string | Title of the report. |
| detailedReportLink | string | Link to the detailed Vastuscore™ Vastu Evaluation Report. |
| customReportLink | string | Link to the customized Vastuscore™ Vastu Evaluation Report. |
cURL example:
curl --location 'https://api.vastureport.com/v1/reports/<<report id>>' --header "Authorization: Bearer {'<<YOUR_API_KEY>>'}" --header "X-Token-Type: API_KEY"
Sample Response:
[ { "id": "a8190ae6-87da-11ee-a207-b0390a868506", "title": "test 1", "detailedReportLink": "https://vastureport.com/getSharedReport?reportId=5461abc8-a1af-46e7-88df-b3ced8a50801", "customReportLink": "https://vastureport.com/getSharedReport?reportId=a8ee8fe7-0b66-40a7-8216-60630ed8a853" } ]