Aggregation Scheme Customization - Implan-Group/api GitHub Wiki

Aggregation Scheme - Customization

Use these endpoints to define your own customized Aggregation Schemes

Note

Just like in IMPLAN Cloud, not all IndustryCodes must be defined as part of a sector. Any unmapped industries will automatically be added as-is to the custom scheme.

🖽 The Custom Aggregation Scheme Object

Property Type Details
description str A description for the custom Aggregation Scheme.
industrySetId int The Industry Set for the Aggregation Scheme.
groups array A list of Custom Aggregation Grouping objects.

🖽 The Custom Aggregation Grouping Object

Property Type Details
description str A description for the custom Aggregation Grouping.
sectors array A list of Custom Aggregation Sectoring objects.

🖽 The Custom Aggregation Sectoring Object

Property Type Details
description str A description for the custom Aggregation Sector.
code int The Industry Code for this sector.

POST /api/v1/aggregationSchemes/create-custom-industry-aggregation-scheme

Returns the int identifier of the newly created custom aggregation scheme. Use Aggregation Scheme by Id to retrieve all the details of the new scheme.

Warning

Custom aggregation schemes take time to build and process. Until the scheme's status is Completed it cannot be used.

🧾Example

📤 Request

POST /api/v1/aggregationSchemes/create-custom-industry-aggregation-scheme

{
    "description": "Example Custom Aggregation Scheme",
    "industrysetid": 2,
    "groups": [
        {
            "description": "Agg Grouping No1",
            "sectors": [
                {
                    "description": "G01S01",
                    "code": 1
                },
                {
                    "description": "G01S02",
                    "code": 2
                }
            ]
        },
        {
            "description": "Agg Grouping No2",
            "sectors": [
                {
                    "description": "G02S01",
                    "code": 3
                },
                {
                    "description": "G02S02",
                    "code": 4
                }
            ]
        }
    ]
}

📥 Response

1429

© 2025 - IMPLAN

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