Skip to content
Developers
Get an API token

Fit EUR to curves you have

EUR for up to 500 cumulative curves (one stream each, as a forecast returned them), with the same fit and settings as eur: true on POST /forecasts, so nothing is re-forecast.

Fit EUR to curves you have

POST/declines

EUR for up to 500 cumulative curves (one stream each, as a forecast returned them), with the same fit and settings as eur: true on POST /forecasts, so nothing is re-forecast.

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

Each curve gets {value, days, arps} or {error}, in request order. When decline sets per-stream settings (oil or gas), every series names its stream and is fit with that stream's settings.

Queue and errors

Interactive work: it doesn't queue behind plans' EUR. It answers 503 when GET /dataset eur.available is false.

Parameters

Query parameters

  • 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.

Request bodyRequired

application/json

Curves, 1 to 500, and optional settings.

  • seriesarray of objectsRequired

    1 to 500 items

    Curves to fit, 1 to 500.

    ShowHide 4 child fields in each item
    • keystringRequired

      1 to 200 characters

      Your key for the curve; results come back in request order with it.

    • ip_daysarray of integersRequired

      3 to 400 itemsItems ≥ 1, ≤ 18250

      ip_days, ascending, as a forecast returns them (send every ip_day: the fit uses the whole curve).

    • valuesarray of numbersRequired

      3 to 400 items

      Cumulative volumes, one per ip_day.

    • streamstringOptional

      The curve's stream, fit with its settings; required when decline sets per-stream settings.

      "oil""gas"
  • declineobjectOptional

    Decline fit settings; any left out take the defaults. oil or gas (even empty) sets per-stream settings: each stream takes its own value, else the one here, else the default. These must be a valid set on their own, even when oil and gas override them. eur_years is shared.

    ShowHide 7 child fields
    • eur_yearsintegerOptional

      ≥ 10, ≤ 50

      Years to EUR: the extension runs to the last 30-day step within eur_years × 365 days.

    • terminal_declinenumberOptional

      ≥ 0.01, ≤ 0.2

      Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.

    • b_minnumberOptional

      ≥ 0, ≤ 2.5

      Lowest hyperbolic b the fit may use; below b_max.

    • b_maxnumberOptional

      ≥ 0, ≤ 2.5

      Highest hyperbolic b the fit may use; above b_min.

    • oilobjectOptional

      Oil's own settings over these.

      ShowHide 3 child fields
      • terminal_declinenumberOptional

        ≥ 0.01, ≤ 0.2

        Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.

      • b_minnumberOptional

        ≥ 0, ≤ 2.5

        Lowest hyperbolic b the fit may use; below b_max.

      • b_maxnumberOptional

        ≥ 0, ≤ 2.5

        Highest hyperbolic b the fit may use; above b_min.

    • gasobjectOptional

      Gas's own settings over these.

      Same fields as StreamDeclineSettings.

    • waterobjectOptional

      Water's own settings over these, only with eur_water: true, else a 400. Unlike oil and gas it doesn't set per-stream settings: oil and gas keep theirs and their calls.

      Same fields as StreamDeclineSettings.

Responses

200 OK

One EUR per curve, in request order.

  • declineobjectRequired

    Decline fit settings used. oil and gas, when present, are the settings each stream was fit with; without them, both were fit with these. water, when present, is the echo of eur_water.

    ShowHide 8 child fields
    • eur_yearsintegerRequired

      ≥ 10, ≤ 50

      Years to EUR: the extension runs to the last 30-day step within eur_years × 365 days.

    • terminal_declinenumberRequired

      ≥ 0.01, ≤ 0.2

      Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.

    • b_minnumberRequired

      ≥ 0, ≤ 2.5

      Lowest hyperbolic b the fit may use; below b_max.

    • b_maxnumberRequired

      ≥ 0, ≤ 2.5

      Highest hyperbolic b the fit may use; above b_min.

    • oilobjectOptional

      With per-stream settings, the settings oil was fit with.

      ShowHide 3 child fields
      • terminal_declinenumberRequired

        ≥ 0.01, ≤ 0.2

        Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.

      • b_minnumberRequired

        ≥ 0, ≤ 2.5

        Lowest hyperbolic b the fit may use; below b_max.

      • b_maxnumberRequired

        ≥ 0, ≤ 2.5

        Highest hyperbolic b the fit may use; above b_min.

    • gasobjectOptional

      With per-stream settings, the settings gas was fit with.

      Same fields as StreamDecline.

    • waterobjectOptional

      Only with eur_water: true: the settings water was fit with. Its presence is the echo of the flag.

      Same fields as StreamDecline.

    • per_wellbooleanOptional

      Only when a well has its own settings: these are the request's or plan's, not every well's; inputs.resolved.decline gives each well's.

      true
  • resultsarray of objectsRequired

    One per series, in request order.

    ShowHide 2 child fields in each item
    • keystringRequired

      The series key.

    • eurobjectRequired

      One stream's EUR: the forecast's cumulative extended by the decline fit, or why it couldn't be fit.

      ShowHide 2 variants

      One of

      • An EUR object

        An EUR.

        • valuenumberRequired

          Cumulative volume at days: the forecast to its last ip_day, then the decline curve (bbl for oil, mcf for gas).

        • daysintegerRequired

          ip_day the EUR is at: the last 30-day step within eur_years.

        • arpsobjectRequired

          The modified Arps curve fitted to the extension, not to the 3-year forecast itself.

          ShowHide 4 child fields
          • q_inumber or nullRequired

            Initial rate of the extension fit, per day (0 for a dry well).

          • dnumber or nullRequired

            Nominal decline of the extension fit, per day.

          • bnumber or nullRequired

            Hyperbolic exponent of the extension fit.

          • terminal_yearnumber or nullRequired

            Year the curve switches to terminal (exponential) decline.

        • curveobjectOptional

          With eur_curve: the cumulative from the forecast's last ip_day to days.

          ShowHide 2 variants

          One of

          • The curve object

            The curve.

            • step_daysintegerRequired

              30 for month, 360 for year.

              30360
            • ip_daysarray of integersRequired

              From the forecast's last ip_day plus one step to the EUR's days, ascending: every 30 days (month), or every 360 days and the EUR's days last (year).

            • valuesarray of numbersRequired

              Cumulative volumes to 0.01, one per ip_day, continuing the forecast's values; the last is the EUR's value to 0.01.

          • No curve object

            No curve.

            • errorstringRequired

              Why there is no curve: the decline fit returned no extension, the forecast worker failed to fit one again (POST /forecasts), or the extension doesn't end on this EUR at its day on the forecast's month grid.

      • No EUR object

        No EUR.

        • errorstringRequired

          Why there is no EUR, as the decline fit reports it.

Errors

StatusWhen
413

The request body is over 10 MB.

502

A model worker returned an error.

Shared errors400401403500503What they mean