Skip to content
Developers
Get an API token

Describe the economics deck

A deck POST /economics prices with (the default unless deck_id names another): each value with its unit, source, a note on where it comes from and the range an override may take.

Describe the economics deck

GET/economics/deck

A deck POST /economics prices with (the default unless deck_id names another): each value with its unit, source, a note on where it comes from and the range an override may take. deck_id and version name it; the version changes whenever a value does.

Send a Novi API token as a bearer token on every request. Authentication
Fields

source is assumption, fit, market, or prototype for a value a deck lacks and takes from the illustrative Midland deck. groups and caption are the lines the app's Economics modal and Economics line show; conventions are the two POST /economics can price under, one line each.

Default decks

The illustrative Midland flat-price deck, not a Novi price deck: flat prices and opex, Texas royalty and taxes, and an illustrative capex of a fixed cost per well plus costs per lateral foot. On a Haynesville model set, the illustrative Haynesville gas deck: flat public-benchmark prices, gas-weighted costs and Louisiana taxes (applied to East Texas wells too; override severance_gas for Texas), each note naming its public source.

Parameters

Query parameters

  • deck_idstringOptional

    The deck to describe, one GET /economics/decks lists for the set; the set's default deck when left out (prototype-midland-flat; illustrative-haynesville-gas on a Haynesville set).

    "prototype-midland-flat""house-70-3""illustrative-haynesville-gas"
  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches 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 once default is 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's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

The deck.

  • deck_idstringRequired

    The deck's id.

  • versionintegerRequired

    ≥ 1

    Changes whenever a value does.

  • namestringRequired

    Display name.

  • notestringRequired

    What the deck is.

  • tax_notestringRequired

    The tax regime wording used in the modal.

  • valuesobjectRequired

    Every value, by field.

    ShowHide 20 child fields
    • oil_priceobjectRequired

      WTI, flat for the well's life.

      ShowHide 6 child fields
      • valuenumberRequired

        The value.

      • unitstringRequired

        Its unit: $, $/bbl, $/mcf, $/ft, $/lb, bbl/MMcf, fraction or fraction per year.

      • sourcestringRequired

        assumption: chosen for the deck; fit: from a fitted formula; market: from market data; prototype: a value the deck lacks, from the illustrative Midland deck.

        "assumption""fit""market""prototype"
      • notestringRequired

        Where it comes from.

      • minnumberRequired

        The lowest an override may set.

      • maxnumberRequired

        The highest an override may set.

    • oil_differentialobjectRequired

      Taken off WTI.

      Same fields as DeckValue.

    • gas_priceobjectRequired

      Henry Hub, flat, no BTU adjustment.

      Same fields as DeckValue.

    • gas_differentialobjectRequired

      Taken off Henry Hub.

      Same fields as DeckValue.

    • ngl_priceobjectRequired

      NGL barrel, flat.

      Same fields as DeckValue.

    • ngl_yield_bbl_per_mmcfobjectRequired

      NGL barrels recovered per MMcf of wellhead gas.

      Same fields as DeckValue.

    • shrinkobjectRequired

      Share of wellhead gas sold as residue after NGLs come out.

      Same fields as DeckValue.

    • opex_oilobjectRequired

      Operating cost per barrel of oil, flat.

      Same fields as DeckValue.

    • opex_gasobjectRequired

      Operating cost per mcf of wellhead gas, flat.

      Same fields as DeckValue.

    • opex_waterobjectRequired

      Water handling per barrel.

      Same fields as DeckValue.

    • royaltyobjectRequired

      Royalty, a share of revenue.

      Same fields as DeckValue.

    • severance_oilobjectRequired

      Severance on oil revenue.

      Same fields as DeckValue.

    Show all 20 fields
    • severance_gasobjectRequired

      Severance on residue gas and NGL revenue.

      Same fields as DeckValue.

    • ad_valoremobjectRequired

      Ad valorem (property) tax, on revenue.

      Same fields as DeckValue.

    • capex_per_wellobjectRequired

      Fixed capital cost per well.

      Same fields as DeckValue.

    • capex_drilling_per_ftobjectRequired

      Drilling per foot of lateral.

      Same fields as DeckValue.

    • capex_stimulation_per_ftobjectRequired

      Stimulation per foot of lateral.

      Same fields as DeckValue.

    • capex_proppant_per_lbobjectRequired

      Proppant per pound pumped (lb/ft × lateral).

      Same fields as DeckValue.

    • capex_fluid_per_bblobjectRequired

      Fluid per barrel pumped (bbl/ft × lateral).

      Same fields as DeckValue.

    • discount_rateobjectRequired

      The annual rate NPV discounts at.

      Same fields as DeckValue.

  • groupsarray of objectsRequired

    The values as the app's Economics modal lists them.

    ShowHide 2 child fields in each item
    • titlestringRequired

      Group.

      "Prices""Costs""Taxes""Discounting"
    • linesarray of stringsRequired

      Its lines.

  • captionstringRequired

    The deck in one line, as the app's Economics line shows it.

  • conventionsobjectRequired

    How NPV, IRR and payback are counted under each of POST /economics' conventions.

    ShowHide 2 child fields
    • prototypestringRequired

      Yearly discounting, the default: NPV leaves year 1 (months 0 to 12) undiscounted and discounts each later year one more year at the annual rate; payback is in fractional months; IRR is the monthly rate annualized as (1+m)^12 − 1; capex is all at month 0.

    • festringRequired

      Monthly discounting. Matches Novi's earlier Forecast Engine: the monthly rate m = (1+r)^(1/12) − 1, the cash flow of month n (0 is capex, 1 the first production month) discounted by (1+m)^n; payback in whole months from turn-on; IRR as under yearly discounting. Capex stays all at month 0, since a scenario has no spud or completion dates.

Conditional requests 304 Unchanged since the ETag in If-None-Match.

Errors

Shared errors400401403500503What they mean