Region Data GAMS - Implan-Group/api GitHub Wiki

Regional Data - General Algebraic Modeling System (GAMS)

These endpoints provide the GAMS data for a particular Region.

Note

All GAMS data is also available for Canadian and International Regions.


GET /api/v1/regions/export/{aggregationSchemeId}/RegionGeneralAlgebraicModeling

This endpoint provides a zip file containing several GAMS .dat files for use with GAMS systems.

Parameter Spec Type Details
aggregationSchemeId route int The Aggregation Schemes to filter by.
hashId query str❔ The Glossary#HashId of the Region to filter by.
urid query int❔ The Glossary#URID of the Region to filter by.
userModelId query int❔ The Glossary#UserModelId of the Region to filter by.

Caution

Exactly one of hashId, urid, or userModelId must be specified.


GET /api/v1/regions/export/{aggregationSchemeId}/region-general-algebraic-modeling-single-file

This endpoint provides a single .gms file for use with GAMS systems.

Parameter Spec Type Details
aggregationSchemeId route int The Aggregation Schemes to filter by.
hashId query str❔ The Glossary#HashId of the Region to filter by.
urid query int❔ The Glossary#URID of the Region to filter by.
userModelId query int❔ The Glossary#UserModelId of the Region to filter by.

Caution

Exactly one of hashId, urid, or userModelId must be specified.


🧾Example

📤 Request

GET /api/v1/regions/export/14/region-general-algebraic-modeling-single-file?hashId=9pbP1nM0VN

📥 Response

1.3001.25001	1992071.2058610576
1.3001.28001	2019773.1524813138
1.3019.25001	69.99222399402058
⚠️ **GitHub.com Fallback** ⚠️