Run one or more basic metrics

get

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

Runs the named service, or — when the path segment is basics — every
metric listed in the request's metrics array, each keyed in the
response by its altName.

A, B, BJobs, and Z return full matrices and can produce very
large responses; use limit_sectors to constrain them.

Only ratios, rpcs, eis, requirements, spending, and scenario
support multi-regional models. Supplying more than one region to any
other service is an error. eis supports multi-regional models even
though it is not included in the listing at
GET /io/us/{datarun}/{year}.

On GET, inputs must come from the query string — see Inputs. Use
POST for the basics segment, whose metrics array can only be
supplied in a body.

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

service

string

enum

required

The data service to run. basics bundles several services in one
request via the metrics array; every other value runs that single
service. Matching is case-insensitive.

Note that scenario, bulk, requirements, spending, econbase,
and batch_requirements are documented as their own paths below
because they take additional inputs.

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:

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

200Model results.

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.