Skip to content
Developers
Get an API token

List economics decks

The decks POST /economics can price with (its deck_id), the default first.

List economics decks

GET/economics/decks

The decks POST /economics can price with (its deck_id), the default first. GET /economics/deck describes one in full.

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

The Illustrative Midland flat-price deck (prototype-midland-flat), which the app uses, and the Novi house deck, $70 oil and $3 gas (house-70-3). On a model set whose basin is Haynesville, the Illustrative Haynesville gas deck (illustrative-haynesville-gas), drafted from public benchmarks and not a Novi default, comes first and is the default.

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.

Responses

200 OK

The decks, the default first.

  • decksarray of objectsRequired

    The decks, the default first.

    ShowHide 4 child fields in each item
    • deck_idstringRequired

      The deck's id, as deck_id takes it.

    • versionintegerRequired

      ≥ 1

      Its version.

    • namestringRequired

      Display name.

    • notestringRequired

      What the deck is.

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

Errors

Shared errors400401403500503What they mean