Regional Children - Implan-Group/api GitHub Wiki

Regional Children

This endpoint returns all Child Regions (sub-regions under the Regions - Top Level) that are available for a given Aggregation Schemes and Datasets.

Note

There is an optional Get Region Types filter that can limit the returned Region Types. This applies to the returned child regions, not a specified top-level region. e.g. If a State's HashId is provided and regionType=zipcode is specified, what is returned will be all the zip Regions that belong to that State.

GET /api/v1/region/{aggregationSchemeId}/{datasetId}/children

Parameter Spec Type Details
aggregationSchemeId route int The Aggregation Schemes to filter by.
datasetId route int The Datasets to filter by.
regionType query str❔ An optional filter to limit the Get Region Types returned.

🧾Example

This retrieves a list of all MSAs in the US for Agg Scheme 1, Dataset 119.

📤 Request

GET /api/v1/region/1/119/children?regionTypeFilter=MSA

📥 Response

[
    {
        "hashId": "ZvbmjQedV5",
        "urid": 1799003,
        "userModelId": null,
        "description": "Sacramento-Roseville-Folsom, CA MSA",
        "modelId": null,
        "modelBuildStatus": "NotBuilt",
        "employment": 1388879.2678120749,
        "output": 226051177324.2555,
        "valueAdded": 145530246894.56323,
        "aggregationSchemeId": 1,
        "datasetId": 119,
        "datasetDescription": "2019",
        "fipsCode": null,
        "provinceCode": null,
        "m49Code": null,
        "regionType": "Msa",
        "hasAccessibleChildren": true,
        "regionTypeDescription": "MSA",
        "geoId": null,
        "isMrioAllowed": true
    },

GET /api/v1/region/{aggregationSchemeId}/{datasetId}/{regionId}/children

Parameter Spec Type Details
aggregationSchemeId route int The Aggregation Schemes to filter by.
datasetId route int The Datasets to filter by.
regionId route str The Glossary#Regional Identifiers of the Region to get the children of.
regionType query str❔ An optional filter to limit the Get Region Types returned.

🧾Example

This retrieves a list of all counties (regionTypeFilter) in Oregon (yDxXX13pxJ is the HashId for Oregon in Agg Scheme 1, Dataset 119).

📤 Request

GET /api/v1/region/1/119/yDxXX13pxJ/children?regionTypeFilter=county

📥 Response

[
    {
        "hashId": "BzxjKk66aN",
        "urid": 1459068,
        "userModelId": null,
        "description": "Grant County, OR",
        "modelId": 6894,
        "modelBuildStatus": "Complete",
        "employment": 3721.6898730218522,
        "output": 424214119.5694142,
        "valueAdded": 229078232.46002346,
        "aggregationSchemeId": 1,
        "datasetId": 49,
        "datasetDescription": "2017",
        "fipsCode": "41023",
        "provinceCode": null,
        "m49Code": null,
        "regionType": "County",
        "hasAccessibleChildren": true,
        "regionTypeDescription": "County",
        "geoId": "41023",
        "isMrioAllowed": true
    },

© 2025 - IMPLAN

⚠️ **GitHub.com Fallback** ⚠️