Run a bulk scenario

post

https://api.lightcast.io/io/us/{datarun}/{year}/bulk

Runs many independent single-account shocks against one region in a
single request and returns a summary row per change, identified by the
change's id. Single-region only: supplying more than one region, or
more than one key in changes, is rejected with 400. Each change may
use either the long field names (id, account, amount, unit) or
their single-letter forms (i, a, m, u). Duplicate id values
are rejected with 400.

POST-only: changes is mandatory and can only be sent in a request
body — see Inputs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

datarun

string

required

SAM datarun version, as listed by GET /io/us.

year

string

required

Data year, as listed by GET /io/us/{datarun}.

Query Params

areas

string

Comma-separated area IDs, as an alternative to supplying region in the
body. Builds a single unnamed region. Supplying this key more than once
is rejected with 400.

type

string

enum

Defaults to county

Area type for areas. Defaults to county.

Allowed:

closuretype

string

enum

Defaults to TypeEMSI

Closure method, as an alternative to supplying it in the body.

Allowed:

Body Params

Inputs common to every data-producing endpoint. Validation is strict:
any property not listed here (or added by the endpoint's own schema) is
rejected with 400. Query-string parameters are validated as part of
this same object, so an unrecognised query parameter fails the same way.

region

array of objects

required

length ≥ 1

One region for a single-region model, more than one to run
multi-regionally. Multi-regional runs require every region to be
named and are only supported by services that report HasMR(true)
from GET /io/us/{datarun}/{year}. The array must not be empty.

region*

closuretype

string

enum

Defaults to TypeEMSI

Closure method for the model.

TypeI / Type1 / 1 / I — direct and indirect effects
TypeII / Type2 / 2 / II — direct, indirect, and limited induced effects
TypeEMSI — Lightcast's custom closure, used by Analyst

Matching is case-insensitive.

Allowed:

limit_sectors

array of strings

Restrict the output rows to these sectors. Codes may be given fully
qualified (z|111000) or bare (111000), in which case the
industry prefix is inferred.

limit_sectors

logging

boolean

Accepted for backwards compatibility. Has no effect on the response.

changes

object

required

Exactly one keyed, non-empty array of changes; the key is
conventionally the empty string.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/csv

text/plain

200One summary row per change. Each row carries the change's id as a field; every value is rendered as a string.

401Kong rejected a missing, invalid, or expired OAuth token.

403Kong rejected a token lacking a required scope. Some application operational conditions also return 403 with a text/plain body.

500The request could not be completed. The body carries a diagnostic message and is served as text/plain. This is also the response to a multi-regional request to a service that does not support multi-regional models.