For the complete documentation index, see llms.txt. This page is also available as Markdown.

Financial Impact Analytics API

This endpoint provides data for real estate cashflow modelling. The metrics translate climate risk and resilience features into various cashflow items such as rate of increase in insurance, projected utility costs, and discount rates.

Endpoint

GET https://app.alphageo.ai/api/public/v1/analytics

Parameters

Parameters
Required
Type
Description

asset_id

string (UUID)

The unique identifier of an asset uploaded to your institution's account.

address

string

Full address of the location

scenario

string

Identifier for CMIP6 Emission Scenarios.

Available values : SSP245, SSP370, SSP585

longitude

number

Longitude of the location that being queried.

latitude

number

Latitude of the location that being queried.

Query Validation Priority

When calling these endpoints, you must provide at least one way to identify the location. If multiple parameters are supplied, the API resolves the query using the following precedence:

  1. asset_id: If provided, the API looks up the asset under your institution's profile.

  2. latitude & longitude: If asset_id is not provided, the API looks up data by coordinates.

  3. address: If neither of the above are provided, the API performs geocoding to resolve coordinates.

If none of these parameters are supplied, the API returns a 400 Bad Request with an error message.

Example requests

cURL

Python

Example response

A successful response containing analytics of the given location.

Last updated

Was this helpful?