Skip to main content

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.

Forecast exports

You must trigger the export from the Combocurve UI before you can get any data back from the API. This can be done by:

  • Navigating to the Forecast page
  • Clicking on the "Forecast Options" button in the menu bar
  • Selecting the forecast export type from the dropdown menu
  • In the Forecast Options panel, select "External Source" as the file type
  • Clicking on the "Export" button

Forecast export UI

Econ exports

You must trigger the export from the Combocurve UI before you can get any data back from the API. This can be done by:

  • Navigating to the Scenario page
  • Clicking on the "Show Economics" button in the menu bar
  • Clicking on the "External Source" button in the menu bar
  • Clicking the economics export type "Well Monthly" from the dropdown menu

Econ Monthly export UI

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.

FieldTypeDescriptionRequired
exportTypestringOne of the values in the table aboveYes
expirationHoursintegerHow long (in hours) the generated links remain valid. Defaults to 24.No
fileTypestringCurrently only "parquet" is supportedSee table
projectIdstringID of the projectSee table
scenarioIdstringID of the scenario (econ exports)See table
econRunIdstringID of the econ run (econ exports)See table
forecastIdstringID of the forecast (forecast-volume exports)See table

Valid exportType Values

exportType valueDescriptionExtra fields you must supply
econMonthlyExportMonthly economic results for a scenarioprojectId, scenarioId, econRunId, fileType
dailyForecastVolumeExportDaily forecast volumes for a forecastprojectId, forecastId, fileType
monthlyForecastVolumeExportMonthly forecast volumes for a forecastprojectId, 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"
}