Provenance
Freshness & coverage
Methods (21)
listWells
readList wells by geography, operator, status, identifiers, or date filters.
EntitieswellInput schema
{ "type": "object", "properties": { "wellName": { "type": "string" }, "operator": { "type": "string", "description": "Filter by operator name." }, "state": { "type": "string", "description": "Filter by state." }, "county": { "type": "string", "description": "Filter by county." }, "sort": { "type": "string" }, "country": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number", "description": "Maximum records to return (1-200)." }, "cursor": { "type": "string" }, "well": { "type": "string" }, "api10": { "type": "string", "description": "Filter by API10." }, "api14": { "type": "string", "description": "Filter by API14." }, "chosenID": { "type": "string" }, "wellNumber": { "type": "string" }, "wellStatus": { "type": "string" }, "wellType": { "type": "string" }, "basin": { "type": "string", "description": "Filter by basin name." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": true }getWell
readFetch one well by ComboCurve ID.
Required paramsidEntitieswellInput schema
{ "type": "object", "properties": { "id": { "type": "string", "description": "ComboCurve well ID." } }, "additionalProperties": true, "required": [ "id" ] }listProjects
readList ComboCurve projects that group wells, forecasts, scenarios, and economics.
EntitiesprojectInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }getProject
readFetch a specific project by ID.
EntitiesprojectInput schema
{ "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false, "required": [ "id" ] }listDailyProductions
readList daily production records with optional well and date filters.
EntitiesproductionInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "well": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "date": { "type": "string" } }, "additionalProperties": false }listMonthlyProductions
readList monthly production records with optional well and date filters.
EntitiesproductionInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "well": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "date": { "type": "string" } }, "additionalProperties": false }listForecasts
readList forecasts within a project.
Required paramsprojectIdEntitiesproductionInput schema
{ "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID." }, "sort": { "type": "string" }, "skip": { "type": "number", "description": "Records to skip." }, "take": { "type": "number", "description": "Maximum records to return (1-200)." }, "cursor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": true, "required": [ "projectId" ] }getForecast
readFetch a specific forecast within a project.
EntitiesproductionInput schema
{ "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" } }, "additionalProperties": false, "required": [ "id", "projectId" ] }listForecastParameters
readList decline-curve parameters for a forecast.
Entitiesproduction, facilityInput schema
{ "type": "object", "properties": { "projectId": { "type": "string" }, "forecastId": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" } }, "additionalProperties": false, "required": [ "projectId", "forecastId" ] }listForecastOutputs
readList forecast output rows for a forecast.
EntitiesproductionInput schema
{ "type": "object", "properties": { "projectId": { "type": "string" }, "forecastId": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" } }, "additionalProperties": false, "required": [ "projectId", "forecastId" ] }listForecastVolumes
readList daily or monthly forecast volumes for project, forecast, or well scope.
EntitiesproductionInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number", "description": "Maximum records to return (1-200)." }, "cursor": { "type": "string" }, "well": { "type": "string", "description": "Optional well ID filter." }, "projectId": { "type": "string", "description": "Optional project ID filter." }, "forecastId": { "type": "string", "description": "Optional forecast ID filter." }, "resolution": { "oneOf": [ { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "daily" ] } ], "type": "string", "enum": [ "daily", "monthly" ], "description": "Volume resolution." } }, "additionalProperties": true }listScenarios
readList scenarios within a project.
EntitiesprojectInput schema
{ "type": "object", "properties": { "projectId": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false, "required": [ "projectId" ] }listEconRuns
readList economic runs globally or within a project scenario.
EntitiesprojectInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number", "description": "Maximum records to return (1-200)." }, "cursor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "projectId": { "type": "string", "description": "Optional project ID." }, "scenarioId": { "type": "string", "description": "Optional scenario ID." } }, "additionalProperties": true }listOneLiners
readList one-line economic summaries for an economic run.
EntitiesrecordInput schema
{ "type": "object", "properties": { "projectId": { "type": "string" }, "scenarioId": { "type": "string" }, "econRunId": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" } }, "additionalProperties": false, "required": [ "projectId", "scenarioId", "econRunId" ] }listTypeCurves
readList type curves inside a project.
Required paramsprojectIdEntitiesprojectInput schema
{ "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID." }, "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number", "description": "Maximum records to return (1-200)." }, "cursor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": true, "required": [ "projectId" ] }listTypeCurveFits
readList daily or monthly fit rows for a type curve.
EntitiesprojectInput schema
{ "type": "object", "properties": { "projectId": { "type": "string" }, "typeCurveId": { "type": "string" }, "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "resolution": { "oneOf": [ { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "daily" ] } ] } }, "additionalProperties": false, "required": [ "projectId", "typeCurveId" ] }listDirectionalSurveys
readList directional survey rows for wells.
Entitiestrajectory, well, surveyInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "well": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }listTags
readList ComboCurve tags.
EntitiesrecordInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" } }, "additionalProperties": false }listWellComments
readList well comments and annotations.
EntitieswellInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "well": { "type": "string" }, "updatedAt": { "type": "string" }, "commentedAt": { "type": "string" } }, "additionalProperties": false }listWellIdentifiers
readList well identifier mappings such as API10, API14, and chosen ID.
EntitieswellInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "well": { "type": "string" }, "api10": { "type": "string" }, "api14": { "type": "string" }, "chosenID": { "type": "string" } }, "additionalProperties": false }listEconModels
readList company-level or project-level economic models.
EntitiesrecordInput schema
{ "type": "object", "properties": { "sort": { "type": "string" }, "skip": { "type": "number" }, "take": { "type": "number" }, "cursor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "projectId": { "type": "string" } }, "additionalProperties": false }
