Regions - Implan-Group/api GitHub Wiki
Not all economic models are built by default. Sometimes you may want to create a customized region, or combine several non-overlapping regions together to emulate a single economic region.
Most Regional endpoints return a single Region or list of Regions in json
format.
Property | Type | Details |
---|---|---|
hashId | str | The Region's HashId . |
urid | int | The Region's Urid . |
userModelId | int❔ | If this Region was specified by a user (and not IMPLAN), this is the Region's user + model identifier. |
description | str | A description of the Region. |
modelId | int | The Region's Model Id, unique only to this Region in a specific Dataset . |
modelBuildStatus | str | The current status of the Region's build progress. If this is "Complete" , the Region is ready for inclusion in impacts. |
employment | float | |
output | float | |
valueAdded | float | |
aggregationSchemeId | int | The Aggregation Scheme that this Region belongs to. |
datasetId | int | The Dataset that this Region belongs to. |
datasetDescription | str | A description of the dataset this Region belongs to. |
fipsCode | int❔ | The FIPS code for this Region, if it has one. |
provinceCode | int❔ | The Canadian Province code for this Region, if it has one. |
m49Code | int❔ | The M49code for this Region, if it has one. |
regionType | str | This Region's [Region Type](Regions#📋Region Types) |
hasAccessibleChildren | bool | Whether or not there are any child Regions under this Region. |
regionTypeDescription | str | A description of the [Region Type](Regions#📋Region Types) this Region belongs to. |
geoId | str❔ | The GeoIdfor this Region, if it has one. |
isMrioAllowed | bool | Is this Region allowed to be included in MRIO impacts? |
A Region Type defines a particular geographic area, from small local regions to entire countries.
-
Country
- A country, such as
The United States
,Canada
, orJapan
- A country, such as
- **State **
- A US State such as
Oregon
orWisconsin
- A US Territory such as
Guam
orPuerto Rico
- A Canadian Province such as
Alberta
orBritish Columbia
- A US State such as
-
County
- A county inside of a US State such as
Mecklenburg County, NC
- A Candian Economic Region.
- A county inside of a US State such as
-
Zipcode
- A US 5-digit zip code such as
54742
- A US 5-digit zip code such as
-
MSA -- https://en.wikipedia.org/wiki/Metropolitan_statistical_area
- A US metropolitan statistical area such as
Eau Claire WI MSA
- A US metropolitan statistical area such as
-
CD -- https://en.wikipedia.org/wiki/Congressional_district
- A US congressional district such as
OR-03
(Oregon's 3rd Congressional District)
- A US congressional district such as
There are several different identifiers used to refer to a particular Region.
Caution
Any endpoint that can accept a HashId
, Urid
, or UserModelId
as part of a query parameter will only accept one of those identifiers. Attempting to specify more than one will result in an error.
Warning
Urid
, UserModelId
, and ModelId
are actively being phased out in support of only HashId
.
Future endpoints will only support HashId
.
A Hash Identifier (hashid
) is associated with a specific Regions, which may be a country, state, metropolitan statistical area (MSA), county, congressional district (CD), zip code, combined, or customized region. This is a way to identify a geography before economic modeling data (such as multipliers) has been created.
A HashId is a sequence of letters and numbers, such as Bzxjpp2YbN
or rDalqKB8bq
[!INFO]
HashId
may be referred to asHashId
,hashId
, orhashid
interchangeably.
A Universal Region Identifier (urid
) is the former way to refer to a unique Region.
A Urid is a number, such as 1742924
and 1738375
Note
The proper term is Urid
or urid
, not UrId
nor urId
.
A User Model Identifier (UserModelId
) refers to a Region created by a user (customized and/or combined). This was the old way to refer to a non-IMPLAN region and has mostly been deprectiated.
A Model Identifier (ModelId)
is an old way to refer to a regional model. It is no longer used.