Skip to content
Developers
Get an API token

List forecast sources

The forecast sources the caller can read, newest first: each one's listing record, without its curves, read report or pairs (GET one for those).

List forecast sources

GET/forecast-sources

The forecast sources the caller can read, newest first: each one's listing record, without its curves, read report or pairs (GET one for those). A private source lists only for its creator. Invalid limit or cursor is 400. A server without a state store answers 409 "Forecast sources need a state store; this server keeps plans in memory".

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

Parameters

Query parameters

  • limitintegerOptional

    Default 50≥ 1, ≤ 100

    Page size, 1-100.

  • cursorstringOptional

    Page to read: next_cursor from the previous page.

Responses

200 OK

Forecast sources and next cursor.

  • itemsarray of objectsRequired

    Newest first.

    ShowHide 16 child fields in each item
    • idstringRequired

      Format uuid

      Source id.

    • namestringRequired

      Name.

    • formatstringRequired

      The file's format.

      "valnav_decline""valnav_constants""novi_arps""combocurve_parameters""mosaic_decline""aries"
    • unitsstringRequired

      The file's unit system; curves are stored in bbl/d and mcf/d.

      "imperial""metric"
    • conventionsstringRequired

      The decline conventions its curves run under.

      "valnav""mosaic""combocurve""novi""aries"
    • gas_basisstringRequired

      raw or sales gas.

      "raw""sales"
    • curve_countintegerRequired

      ≥ 0

      Curves.

    • well_countintegerRequired

      ≥ 0

      Distinct Well IDs.

    • fileobjectRequired

      The file read; the file itself isn't kept.

      ShowHide 3 child fields
      • namestring or nullRequired

        The uploaded file's name, or JSON file_name; null without one.

      • bytesintegerRequired

        ≥ 0

        Its size.

      • sha256stringRequired

        Its SHA-256, hex.

    • visibilitystringRequired

      private answers only its creator; tenant every user of the tenant.

      "private""tenant"
    • created_bystring or nullRequired

      The signed-in creator's email; null for a server's configured user.

    • created_atstringRequired

      Format date-time

      Creation time.

    Show all 16 fields
    • updated_atstringRequired

      Format date-time

      Last change.

    • plan_idstring or nullRequired

      Format uuid

      The linked plan, or null when none is linked. A plan that is gone or that the caller can't read stays here with plan_linked: false.

    • plan_linkedbooleanRequired

      Whether plan_id names a plan the caller can read: false with a plan_id when that plan is gone or hidden from the caller.

    • etagstringRequired

      Current ETag including quotes; send as If-Match.

  • next_cursorstring or nullRequired

    Next page, null at end.

Errors

StatusWhen
409

A server without a state store answers 409 "Forecast sources need a state store; this server keeps plans in memory".

Shared errors400401403500What they mean