Exports API Reference

The Exports API lets you generate secure, time-limited download links for economic and forecast data in Parquet format. All requests are sent to a single endpoint:

POST /v1/exports

The information sent in the request body determines which type of export is generated.

Request Body

Each request is a JSON object that must contain an exportType discriminator. All other properties are validated based on the value of that field.

Field	Type	Description	Required
exportType	string	One of the values in the table above	Yes
expirationHours	integer	How long (in hours) the generated links remain valid. Defaults to 24.	No
fileType	string	Currently only "parquet" is supported	See table
projectId	string	ID of the project	See table
scenarioId	string	ID of the scenario (econ exports)	See table
econRunId	string	ID of the econ run (econ exports)	See table
forecastId	string	ID of the forecast (forecast-volume exports)	See table

---

Valid exportType Values

exportType value	Description	Extra fields you must supply
econMonthlyExport	Monthly economic results for a scenario	projectId, scenarioId, econRunId, fileType
dailyForecastVolumeExport	Daily forecast volumes for a forecast	projectId, forecastId, fileType
monthlyForecastVolumeExport	Monthly forecast volumes for a forecast	projectId, forecastId, fileType

All export types inherit the common fields shown in the Request Body section below.

---

Example Requests

Econ Monthly Export

POST /v1/exports
{
  "exportType": "econMonthlyExport",
  "fileType":   "parquet",
  "projectId":  "5e5981b9e23dae0012624d72",
  "scenarioId": "6494d5049a4f6b0a3491c309",
  "econRunId":  "ecf8763db8ac41efb9bbf311",
  "expirationHours": 24
}

Daily Forecast Volume Export

POST /v1/exports
{
  "exportType": "dailyForecastVolumeExport",
  "fileType":   "parquet",
  "projectId":  "5e5981b9e23dae0012624d72",
  "forecastId": "61a4d175f1da1800136c4b21"
}

Monthly Forecast Volume Export

POST /v1/exports
{
  "exportType": "monthlyForecastVolumeExport",
  "fileType":   "parquet",
  "projectId":  "5e5981b9e23dae0012624d72",
  "forecastId": "61a4d175f1da1800136c4b21"
}