Get a plan's economics job
A plan economics job: its status, then result (the plan priced) or error.
Get a plan's economics job
/plans/{id}/economics/{job_id}A plan economics job: its status, then result (the plan priced) or error. Running, it answers with Retry-After: 1: send wait instead of polling. Done or failed, it carries an ETag for If-None-Match (304). 404 for an unknown or expired id, another tenant's job, or one of another plan or model set.
Parameters
Path parameters
idstringRequiredFormat
uuidPlan id from POST /plans.
job_idstringRequiredFormat
uuidThe job id POST /plans/{id}/economics answered with.
Query parameters
waitintegerOptional≥ 1, ≤ 25
Use this instead of polling: on a running job, the answer is held until it finishes, or this many seconds pass.
Whole seconds, 1 to 25 (400 otherwise). The answer is what a GET without
waitwould get when the wait ends,Retry-Afterincluded; a finished job answers at once. A client that disconnects ends the wait.model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
The job.
idstringRequiredFormat
uuidJob id.
plan_idstringRequiredFormat
uuidThe plan priced.
statusstringRequiredrunning, then done or error.
"running""done""error"created_atstringRequiredFormat
date-timeWhen it was requested.
finished_atstring or nullRequiredFormat
date-timeWhen it finished or failed.
secondsnumberRequiredRun time so far, or in total once finished.
resultobject or nullRequiredOnce done, the plan priced; null otherwise.
ShowHide 8 child fields
plan_idstringRequiredFormat
uuidThe plan.
designintegerRequired≥ 0
The design priced.
scenariostring or nullRequiredThe scenario priced; null on a plan without scenarios.
deckobjectRequiredThe effective deck.
ShowHide 6 child fields
deck_idstringRequiredThe deck's id.
versionintegerRequired≥ 1
Its version.
namestringRequiredIts display name, as GET /economics/decks lists it; name results by it.
overridesarray of stringsRequiredThe fields this request overrode.
"oil_price""oil_differential""gas_price""gas_differential""ngl_price""ngl_yield_bbl_per_mmcf""shrink""opex_oil""opex_gas""opex_water""royalty""severance_oil""severance_gas""ad_valorem""capex_per_well""capex_drilling_per_ft""capex_stimulation_per_ft""capex_proppant_per_lb""capex_fluid_per_bbl""discount_rate"discount_ratenumberRequiredThe effective annual discount rate used for npv.
valuesobjectRequiredThe values priced with.
ShowHide 20 child fields
oil_pricenumberRequired$/bbl
oil_differentialnumberRequired$/bbl
gas_pricenumberRequired$/mcf
gas_differentialnumberRequired$/mcf
ngl_pricenumberRequired$/bbl
ngl_yield_bbl_per_mmcfnumberRequiredbbl/MMcf
shrinknumberRequiredfraction
opex_oilnumberRequired$/bbl
opex_gasnumberRequired$/mcf
opex_waternumberRequired$/bbl
royaltynumberRequiredfraction
severance_oilnumberRequiredfraction
Show all 20 fields
severance_gasnumberRequiredfraction
ad_valoremnumberRequiredfraction
capex_per_wellnumberRequired$
capex_drilling_per_ftnumberRequired$/ft
capex_stimulation_per_ftnumberRequired$/ft
capex_proppant_per_lbnumberRequired$/lb
capex_fluid_per_bblnumberRequired$/bbl
discount_ratenumberRequiredfraction per year
conventionsstringRequiredThe conventions priced under.
"prototype""fe"totalsobjectRequiredThe priced wells of a plan, a pad or a landing zone, summed month by month as if all came online together.
ShowHide 10 child fields
wellsintegerRequired≥ 0
Wells in it.
pricedintegerRequired≥ 0
Wells with a cash flow, summed.
capexnumber or nullRequiredCapex of the priced wells, $, all at month 0; null when none is priced.
npvnumber or nullRequiredNPV of the summed cash flow, $, at the deck discount_rate, as conventions says; null when none is priced.
irr_pctnumber or nullRequiredIRR of the summed cash flow, % a year; null when it never returns its capex or none is priced.
payback_monthsnumber or nullRequiredPayback of the summed cash flow, months; null when it never pays back or none is priced.
reasonstring or nullRequiredThe first unpriced well (by plan index) and why, as POST /economics names it; null when every well is priced.
keystring or nullOptionalOn a group: the pad key or formation; null for the wells without one. Absent on totals.
namestringOptionalOn a pad group, the pad's name when the plan gives one in
pads[].name; absent otherwise, and on totals and formation groups.keystays the pad key.breakevenobject or nullOptionalWith include breakeven: the flat oil and gas prices at which npv is 0, over the priced wells; null when none is priced.
ShowHide 3 child fields
oil_pricenumber or nullRequiredWTI, $/bbl: the flat oil price at which npv is 0, to within $0.000001; null when npv doesn't cross 0 between oil_price's min and max (GET /economics/deck).
gas_pricenumber or nullRequiredHenry Hub, $/mcf: the flat gas price at which npv is 0, to within $0.000001; null when npv doesn't cross 0 between gas_price's min and max.
discount_ratenumberRequiredThe effective annual discount rate npv was taken at, as deck.discount_rate.
groupsobjectOptionalWith group_by: the groups asked for.
ShowHide 2 child fields
padarray of objectsOptionalWith group_by pad: each pad key in plan order of its first well, no pad last; never folded.
Same fields as EconomicsRollup.
formationarray of objectsOptionalWith group_by formation: each formation in GET /formations order, none last.
Same fields as EconomicsRollup.
wellsarray of objectsOptionalWith include wells: every well priced, in plan order.
ShowHide 10 child fields in each item
indexintegerRequired≥ 0
The well's plan index.
labelstringRequiredThe well's name, else Plan well N.
padstring or nullRequiredIts pad key; null without one.
formationstring or nullRequiredIts target formation; null without one.
capexnumber or nullRequiredCapex, $; null when unpriced.
npvnumber or nullRequiredNPV, $; null when unpriced.
irr_pctnumber or nullRequiredIRR, % a year; null when unpriced or it never returns its capex.
payback_monthsnumber or nullRequiredPayback, months; null when unpriced or it never pays back.
reasonstring or nullRequiredWhy it has no cash flow, or null.
pad_namestringOptionalThe pad's name when the plan gives one in
pads[].name; absent otherwise.padstays the key.
errorobject or nullRequiredOnce failed, why; null otherwise.
ShowHide 3 child fields
codestringRequiredMachine-readable code.
"invalid_argument""not_found""conflict""unavailable""internal"messagestringRequiredWhat went wrong and how to fix it.
detailsobjectRequiredContext:
fieldnames the input at fault, as wells[3].tvd_ft.ShowHide 1 child field
fieldstringOptionalThe input at fault.
linksobjectRequiredRelated URLs.
ShowHide 1 child field
selfstringRequiredThis job.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean