An aggregate allocation and its aggregation dimensions. A null or absent dimension includes the accounting points of all values.
aggregator
enum<string>
required
Available aggregator roles
grid_operator — Indicates the source of the aggregation is a grid operator.
transmission_operator — Indicates the source of the aggregation is a transmission system operator.
Available options:
grid_operator,
transmission_operator
Example:
"grid_operator"
allocation_basis
enum<string>
required
The basis tells you where the energy data for an aggregation is coming from: Is it directly metered values from smart meters, or is it something calculated from some standard profile?
Available allocation bases
metered — Indicates this aggregation's data comes from directly metered energy, like from smart meters.
profiled — Indicates this aggregation's data is coming from a 'profile' of some kind, a pre-determined shape of consumption or production, usually coupled with some adjustment calculations, like adjusting for daily temperature or past annual metered consumption.
Available options:
metered,
profiled
Example:
"metered"
area_code
string
required
Examples:
"10YDE-RWENET---I"
"871664139537672423"
area_kind
enum<string>
required
Available area kinds
metering_grid_area — The area of one grid operator.
control_area — The area of one transmission system operator.
The balance group of the accounting points in the aggregate allocation. If the value is null, the aggregate allocation includes all balance groups.
Example:
"11XBILANZKREIS-X"
external_id
string
required
A stable identifier for the aggregate allocations. In most markets this is a unique identifier assigned by that market, but in markets that don't provide a stable identity (like NL), it's assigned by Engrate
flow_direction
enum<string>
required
Available options:
consumption,
production
market_dimensions
Market Dimensions · object
required
Market-specific additional dimensions, used in markets that sub-divide aggregate allocations beyond what the common dimensions can represent. See Market dimensions and metadata in each market for the keys of each market.
Market-specific additional metadata, for instance in markets where datasets with the exact same dimensions are sent at different cadences (daily, monthly), this metadata tells them apart. See Market dimensions and metadata in each market for the keys of each market.
The supplier of the accounting points in the aggregate allocation. If the value is null, the aggregate allocation includes all suppliers.
Example:
"9900000000001"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Engrate Developer Documentation","description":"Engrate is the building blocks for your energy management and optimization applications. Without the complexity of traditional integration platforms our developer-first approach gets you from concept to production in days, not months.","colors":{"primary":"#FFBB00","light":"#FFBB00","dark":"#FFBB00"},"logo":{"light":"https://mintcdn.com/engrate/zV_tsIFvjMafIhqO/images/logo-light.svg?fit=max\u0026auto=format\u0026n=zV_tsIFvjMafIhqO\u0026q=85\u0026s=0a166849b56cc0dbfbb1584afda2d0ba","dark":"https://mintcdn.com/engrate/zV_tsIFvjMafIhqO/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=zV_tsIFvjMafIhqO\u0026q=85\u0026s=79fb04f9456ebd05ae69f107341c5d81"},"favicon":"https://mintcdn.com/engrate/0gbHzEYX3GoHU0wy/favicon.ico?fit=max\u0026auto=format\u0026n=0gbHzEYX3GoHU0wy\u0026q=85\u0026s=498b7c6e50fdffeb3edaab1e0272101b","navbar":{"links":[{"href":"mailto:hello@engrate.io","label":"Support"}],"primary":{"type":"button","label":"Contact us","href":"mailto:hello@engrate.io"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/engrate"}},"fonts":{"family":"Work Sans","format":"woff2"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"engrate","hasAudioNarration":false,"actualSubdomain":"engrate","customDomains":["docs.engrate.io"],"gitSource":{"type":"github","owner":"engrate","repo":"eg-core","deployBranch":"main","contentDirectory":"docs/public/mintlify","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afea7d841f10949724e9759","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":123},{"language":"default","tag":"Market Communication","count":73},{"language":"default","tag":"Cost of Energy","count":43},{"language":"default","tag":"Tariffs","count":43},{"language":"default","tag":"Models","count":41},{"language":"default","tag":"Documentation","count":21},{"language":"default","tag":"Core","count":19},{"language":"default","tag":"Market reference data","count":19},{"language":"default","tag":"Structuring","count":18},{"language":"default","tag":"Schedules","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"global.css","content":".eg-dataset>rect{fill:#dbeafe!important;stroke:#0080FF!important}.eg-dataset .nodeLabel{color:#002FA7!important}.eg-fn>rect{fill:#f5f5f5!important;stroke:#e5e5e5!important}.eg-fn .nodeLabel{color:#4a4a4a!important}.eg-output>rect{fill:#d1fae5!important;stroke:#10b981!important}.eg-output .nodeLabel{color:#064e3b!important}.edgeLabel{font-size:0.75rem;background-color:transparent!important}.edgeLabel p{background-color:transparent!important}.edgeLabel .labelBkg{background:#dbeafe!important;border:1px solid #0080FF;color:#002FA7;padding:2px 10px;border-radius:999px}.labelBkg:has(>span.edgeLabel:empty){background:transparent!important;border:none!important;padding:0!important}html.dark .eg-dataset>rect{fill:#1e3a5f!important;stroke:#60a5fa!important}html.dark .eg-dataset .nodeLabel{color:#dbeafe!important}html.dark .eg-fn>rect{fill:#374151!important;stroke:#4b5563!important}html.dark .eg-fn .nodeLabel{color:#e5e7eb!important}html.dark .eg-output>rect{fill:#064e3b!important;stroke:#34d399!important}html.dark .eg-output .nodeLabel{color:#d1fae5!important}html.dark .edgePath path,html.dark path.flowchart-link,html.dark .flowchart-link{stroke:#9ca3af!important}html.dark marker path{fill:#9ca3af!important;stroke:#9ca3af!important}html.dark .edgeLabel .labelBkg{background:#1e3a5f!important;border-color:#60a5fa}html.dark .edgeLabel .labelBkg,html.dark .edgeLabel .labelBkg span,html.dark .edgeLabel span{color:#dbeafe!important}"}]}
{"page":{"pagePath":"api-reference/allocations/models/aggregate-allocation","slug":"/api-reference/allocations/models/aggregate-allocation","pageMetadata":{"title":"Aggregate allocation","openapi-schema":"AggregateAllocation","description":null,"href":"/api-reference/allocations/models/aggregate-allocation"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Aggregate allocation","openapi-schema":"AggregateAllocation","description":null,"href":"/api-reference/allocations/models/aggregate-allocation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"description":"An aggregate allocation and its aggregation dimensions. A null or absent dimension includes the accounting points of all values.","properties":{"aggregator":{"description":"### Available aggregator roles\n\n- **grid_operator** — Indicates the source of the aggregation is a grid operator.\n\n- **transmission_operator** — Indicates the source of the aggregation is a transmission system operator.","enum":["grid_operator","transmission_operator"],"examples":["grid_operator"],"title":"AggregatorRole","type":"string","isRequired":true,"uniqueKey":"aggregator","typeLabel":"enum\u003cstring>"},"allocation_basis":{"description":"The basis tells you where the energy data for an aggregation is coming from: Is it directly metered values from smart meters, or is it something calculated from some standard profile?\n\n### Available allocation bases\n\n- **metered** — Indicates this aggregation's data comes from directly metered energy, like from smart meters.\n\n- **profiled** — Indicates this aggregation's data is coming from a 'profile' of some kind, a pre-determined shape of consumption or production, usually coupled with some adjustment calculations, like adjusting for daily temperature or past annual metered consumption.","enum":["metered","profiled"],"examples":["metered"],"title":"AllocationBasis","type":"string","isRequired":true,"uniqueKey":"allocation_basis","typeLabel":"enum\u003cstring>"},"area_code":{"examples":["10YDE-RWENET---I","871664139537672423"],"title":"Area Code","type":"string","isRequired":true,"uniqueKey":"area_code","typeLabel":"string"},"area_kind":{"description":"### Available area kinds\n\n- **metering_grid_area** — The area of one grid operator.\n\n- **control_area** — The area of one transmission system operator.\n\n- **scheduling_area** — See [Scheduling Area](/api-reference/core/models/scheduling-area).","enum":["metering_grid_area","control_area","scheduling_area"],"examples":["metering_grid_area"],"title":"AreaKind","type":"string","isRequired":true,"uniqueKey":"area_kind","typeLabel":"enum\u003cstring>"},"balance_group":{"oneOf":[{"type":"string","title":"Balance Group","description":"The balance group of the accounting points in the aggregate allocation. If the value is null, the aggregate allocation includes all balance groups.","example":"11XBILANZKREIS-X","isRequired":true,"uniqueKey":"balance_group.oneOf.0","typeLabel":"string"},{"type":"null","title":"Balance Group","description":"The balance group of the accounting points in the aggregate allocation. If the value is null, the aggregate allocation includes all balance groups.","example":"11XBILANZKREIS-X","isRequired":true,"uniqueKey":"balance_group.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"balance_group","typeLabel":"string | null"},"external_id":{"description":"A stable identifier for the aggregate allocations. In most markets this is a unique identifier assigned by that market, but in markets that don't provide a stable identity (like NL), it's assigned by Engrate","title":"External Id","type":"string","isRequired":true,"uniqueKey":"external_id","typeLabel":"string"},"flow_direction":{"enum":["consumption","production"],"title":"Flow Direction","type":"string","isRequired":true,"uniqueKey":"flow_direction","typeLabel":"enum\u003cstring>"},"market_dimensions":{"additionalProperties":{"type":"string","uniqueKey":"market_dimensions.additionalProperties","typeLabel":"string"},"description":"Market-specific additional dimensions, used in markets that sub-divide aggregate allocations beyond what the common dimensions can represent. See [Market dimensions and metadata in each market](/market-communication/allocations/aggregate-allocations#market-dimensions-and-metadata-in-each-market) for the keys of each market.","examples":[{"series_type":"SLS"},{"allocation_group":"PRF","offtake_type":"AMI","profile_category":"E1A"}],"title":"Market Dimensions","type":"object","isRequired":true,"uniqueKey":"market_dimensions","typeLabel":"Market Dimensions · object"},"market_meta":{"additionalProperties":{"type":"string","uniqueKey":"market_meta.additionalProperties","typeLabel":"string"},"description":"Market-specific additional metadata, for instance in markets where datasets with the exact same dimensions are sent at different cadences (daily, monthly), this metadata tells them apart. See [Market dimensions and metadata in each market](/market-communication/allocations/aggregate-allocations#market-dimensions-and-metadata-in-each-market) for the keys of each market.","examples":[{"control_area":"10YDE-RWENET---I","summed_series":"Z97"}],"title":"Market Meta","type":"object","isRequired":true,"uniqueKey":"market_meta","typeLabel":"Market Meta · object"},"supplier":{"oneOf":[{"type":"string","title":"Supplier","description":"The supplier of the accounting points in the aggregate allocation. If the value is null, the aggregate allocation includes all suppliers.","example":"9900000000001","isRequired":true,"uniqueKey":"supplier.oneOf.0","typeLabel":"string"},{"type":"null","title":"Supplier","description":"The supplier of the accounting points in the aggregate allocation. If the value is null, the aggregate allocation includes all suppliers.","example":"9900000000001","isRequired":true,"uniqueKey":"supplier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"supplier","typeLabel":"string | null"}},"required":["aggregator","allocation_basis","area_code","area_kind","balance_group","external_id","flow_direction","market_dimensions","market_meta","supplier"],"title":"AggregateAllocation","type":"object","uniqueKey":"","typeLabel":"AggregateAllocation · object","example":{"title":"Example","value":{"aggregator":"grid_operator","allocation_basis":"metered","area_code":"10YDE-RWENET---I","area_kind":"metering_grid_area","balance_group":"11XBILANZKREIS-X","external_id":"\u003cstring>","market_dimensions":{"series_type":"SLS"},"market_meta":{"control_area":"10YDE-RWENET---I","summed_series":"Z97"},"supplier":"9900000000001"}}},"originalFileLocation":"openapi.json"},"subdomain":"engrate","siteName":"Engrate Developer Documentation","title":"Aggregate allocation - Engrate Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T08:11:21.443Z","originalFileLocation":"api-reference/allocations/models/aggregate-allocation.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Engrate Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Aggregate allocation - Engrate Developer Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Engrate Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://engrate.mintlify.site/_mintlify/api/og/v2?division=Models\u0026amp;title=Aggregate+allocation\u0026amp;theme=4dd3af680c68ddfe67d6e1f3\u0026amp;signature=bf681516d8d6b36ed2fc4ec74c6bbdc56a684dd2b462f5cf212088493e696b10\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Aggregate allocation - Engrate Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://engrate.mintlify.site/_mintlify/api/og/v2?division=Models\u0026amp;title=Aggregate+allocation\u0026amp;theme=4dd3af680c68ddfe67d6e1f3\u0026amp;signature=bf681516d8d6b36ed2fc4ec74c6bbdc56a684dd2b462f5cf212088493e696b10\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/engrate/z3Ru6D-2hQC1EDPe/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Engrate Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFBB00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/allocations/models/aggregate-allocation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.engrate.io/#organization\",\"name\":\"Engrate Developer Documentation\",\"url\":\"https://docs.engrate.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/engrate/zV_tsIFvjMafIhqO/images/logo-light.svg?fit=max\u0026auto=format\u0026n=zV_tsIFvjMafIhqO\u0026q=85\u0026s=0a166849b56cc0dbfbb1584afda2d0ba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.engrate.io#website\",\"name\":\"Engrate Developer Documentation\",\"url\":\"https://docs.engrate.io\",\"publisher\":{\"@id\":\"https://docs.engrate.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation#webpage\",\"url\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation\",\"name\":\"Aggregate allocation\",\"dateModified\":\"2026-11-10T08:11:21.443Z\",\"isPartOf\":{\"@id\":\"https://docs.engrate.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Market Communication\",\"item\":\"https://docs.engrate.io/api-reference/market-communication/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Allocations\",\"item\":\"https://docs.engrate.io/api-reference/allocations/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Models\",\"item\":\"https://docs.engrate.io/api-reference/allocations/models/allocation-record\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Aggregate allocation\",\"item\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation#apireference\",\"headline\":\"Aggregate allocation\",\"name\":\"Aggregate allocation\",\"url\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.engrate.io/api-reference/allocations/models/aggregate-allocation#webpage\"},\"dateModified\":\"2026-11-10T08:11:21.443Z\",\"publisher\":{\"@id\":\"https://docs.engrate.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.engrate.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Engrate Developer Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Engrate Developer Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/allocations/models/aggregate-allocation.md","siteName":"Engrate Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/guides/welcome"}]},{"tab":"API reference","groups":[{"group":"Market Communication","pages":[{"title":"Market Communication API","sidebarTitle":"Overview","href":"/api-reference/market-communication/overview"},{"group":"Schedules","pages":[{"group":"Models","icon":"cube","pages":[{"title":"Schedule","href":"/api-reference/schedule-management/models/schedule"},{"title":"Schedule Version","href":"/api-reference/schedule-management/models/schedule-version"},{"title":"Schedule Series","href":"/api-reference/schedule-management/models/schedule-series"},{"title":"Audit Log","href":"/api-reference/schedule-management/models/audit-log"},{"title":"Exchange Priority","href":"/api-reference/schedule-management/models/exchange-priority"}]},{"title":"List Schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/schedules","href":"/api-reference/schedules/list-schedules"},{"title":"Create Schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /schedule-management/v1/schedules","href":"/api-reference/schedules/create-schedule"},{"title":"Get Schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/schedules/{uid}","href":"/api-reference/schedules/get-schedule"},{"title":"List Schedule Versions","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/schedules/{uid}/versions","href":"/api-reference/schedules/list-schedule-versions"},{"title":"Get Schedule Series","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/schedule-series/{version_uid}","href":"/api-reference/schedules/get-schedule-series"},{"title":"Get Series State","deprecated":null,"version":null,"tag":"ALPHA","openapi":"/openapi.json get /schedule-management/v1/schedules/{uid}/series-state","href":"/api-reference/schedules/get-series-state"},{"title":"List Schedule Match Reports","deprecated":null,"version":null,"tag":"ALPHA","openapi":"/openapi.json get /schedule-management/v1/schedules/{uid}/reports","href":"/api-reference/schedules/list-schedule-match-reports"},{"title":"List Match Reports","deprecated":null,"version":null,"tag":"ALPHA","openapi":"/openapi.json get /schedule-management/v1/schedule-versions/{version_uid}/reports","href":"/api-reference/schedules/list-match-reports"},{"title":"List Incoming Messages","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/schedules/{uid}/incoming-messages","href":"/api-reference/schedules/list-incoming-messages"},{"title":"Get Incoming Message","deprecated":null,"version":null,"tag":"ALPHA","openapi":"/openapi.json get /schedule-management/v1/schedules/{uid}/incoming-messages/{message_uid}","href":"/api-reference/schedules/get-incoming-message"},{"title":"List Audit Logs","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/audit-logs","href":"/api-reference/audit-logs/list-audit-logs"},{"title":"Send Status Request","deprecated":null,"version":null,"openapi":"/openapi.json post /schedule-management/v1/send_status_request","href":"/api-reference/status-request/send-status-request"}]},{"group":"Confirmations","pages":[{"title":"Confirmations API Overview","tag":"ALPHA","href":"/api-reference/confirmations/overview"},{"title":"List Confirmed Schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/confirmed-schedules","href":"/api-reference/timeseries/list-confirmed-schedules"},{"title":"List Confirmed Schedule Series","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/series/confirmed-schedules","href":"/api-reference/timeseries/list-confirmed-schedule-series"}]},{"group":"Allocations","pages":[{"title":"Allocations API Overview","tag":"ALPHA","href":"/api-reference/allocations/overview"},{"group":"Models","icon":"cube","pages":[{"title":"Allocation record","href":"/api-reference/allocations/models/allocation-record"},{"title":"Allocation quality","href":"/api-reference/allocations/models/allocation-quality"},{"title":"Allocation series","href":"/api-reference/allocations/models/allocation-series-item"},{"title":"Aggregate allocation record","description":null,"href":"/api-reference/allocations/models/aggregate-allocation-record"},{"title":"Aggregate allocation","href":"/api-reference/allocations/models/aggregate-allocation"},{"title":"Finality","description":null,"href":"/api-reference/allocations/models/finality"},{"title":"Aggregator role","href":"/api-reference/allocations/models/aggregator-role"},{"title":"Allocation basis","href":"/api-reference/allocations/models/allocation-basis"}]},{"title":"List Allocations","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/allocations","href":"/api-reference/timeseries/list-allocations"},{"title":"List Allocation Series","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/series/allocations","href":"/api-reference/timeseries/list-allocation-series"},{"title":"List Aggregate Allocations","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/aggregate-allocations","href":"/api-reference/timeseries/list-aggregate-allocations"},{"title":"List Aggregate Allocation Series","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/series/aggregate-allocations","href":"/api-reference/timeseries/list-aggregate-allocation-series"}]},{"group":"Imbalances","pages":[{"title":"Imbalances API Overview","tag":"ALPHA","href":"/api-reference/imbalances/overview"},{"group":"Models","icon":"cube","pages":[{"title":"Imbalance record","href":"/api-reference/imbalances/models/imbalance-record"},{"title":"Imbalance series","href":"/api-reference/imbalances/models/imbalance-series"}]},{"title":"List Imbalances","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/imbalance","href":"/api-reference/timeseries/list-imbalances"},{"title":"List Imbalance Series","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/series/imbalance","href":"/api-reference/timeseries/list-imbalance-series"}]},{"group":"Structuring","pages":[{"group":"Supplier switches","pages":[{"title":"Supplier switches API","sidebarTitle":"Overview","tag":"ALPHA","href":"/api-reference/structuring/overview"},{"group":"Models","icon":"cube","pages":[{"title":"Structure Batch","href":"/api-reference/structuring/models/structure-batch"},{"title":"Structure Conflict","href":"/api-reference/structuring/models/structure-conflict"},{"title":"Supplier Switch","href":"/api-reference/structuring/models/supplier-switch"}]},{"title":"Submit Structure Batch","deprecated":null,"version":null,"openapi":"/openapi.json post /market-access/v1alpha1/structure","href":"/api-reference/structuring/submit-structure-batch"},{"title":"List Supplier Switches","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/supplier-switches","href":"/api-reference/structuring/list-supplier-switches"},{"title":"List EnFG Privilege Reasons","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/markets/DE/enfg-privilege-reasons","href":"/api-reference/structuring/list-enfg-privilege-reasons"}]},{"group":"Accounting points","pages":[{"title":"Accounting points API","sidebarTitle":"Overview","tag":"ALPHA","href":"/api-reference/accounting-points/overview"},{"group":"Models","icon":"cube","pages":[{"title":"Accounting Point","href":"/api-reference/accounting-points/models/accounting-point"},{"title":"Master Data","href":"/api-reference/accounting-points/models/master-data"},{"title":"Supply Period","href":"/api-reference/accounting-points/models/supply-period"},{"title":"Connection Status","href":"/api-reference/accounting-points/models/connection-status"},{"title":"Settlement Method","href":"/api-reference/accounting-points/models/settlement-method"}]},{"title":"List Accounting Points","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/accounting-points","href":"/api-reference/accounting-points/list-accounting-points"},{"title":"Get Accounting Point","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/accounting-points/{id}","href":"/api-reference/accounting-points/get-accounting-point"},{"title":"List Accounting Point Observations","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/accounting-points/{id}/observations","href":"/api-reference/accounting-points/list-accounting-point-observations"}]}]},{"group":"Reference data","pages":[{"title":"List Exchange Priority Balance Groups","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/reference/exchange-priority-balance-groups","href":"/api-reference/reference/list-exchange-priority-balance-groups"},{"title":"Check Exchange Priority","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule-management/v1/reference/exchange-priority-check/{eic_code}","href":"/api-reference/reference/check-exchange-priority"}]}]},{"group":"Portfolio Forecasts","pages":[{"group":"Submissions","pages":[{"title":"Portfolio Forecasts API Overview","tag":"ALPHA","href":"/api-reference/portfolio-forecasts/overview"},{"title":"Submit portfolio forecast","deprecated":null,"version":null,"openapi":"/portfolio-forecasts-openapi.json post /portfolio-forecasts/v1alpha1/submissions","href":"/api-reference/submit-portfolio-forecast"},{"title":"List stored delivery days","deprecated":null,"version":null,"openapi":"/portfolio-forecasts-openapi.json get /portfolio-forecasts/v1alpha1/submissions","href":"/api-reference/list-stored-delivery-days"},{"title":"Read back stored forecast","deprecated":null,"version":null,"openapi":"/portfolio-forecasts-openapi.json get /portfolio-forecasts/v1alpha1/submissions/{delivery_day}","href":"/api-reference/read-back-stored-forecast"}]}]},{"group":"Core","pages":[{"group":"Market reference data","pages":[{"title":"Core API Overview","href":"/api-reference/core/overview"},{"group":"Models","icon":"cube","pages":[{"title":"Party","href":"/api-reference/core/models/party"},{"title":"Bidding Zone","href":"/api-reference/core/models/bidding-zone"},{"title":"Scheduling Area","href":"/api-reference/core/models/scheduling-area"},{"title":"Control Area","href":"/api-reference/core/models/control-area"},{"title":"Metering Grid Area","href":"/api-reference/core/models/metering-grid-area"},{"title":"Metering Point","href":"/api-reference/core/models/metering-point"},{"title":"Accounting Point","href":"/api-reference/core/models/accounting-point"},{"title":"Meter","href":"/api-reference/core/models/meter"},{"title":"Register","href":"/api-reference/core/models/register"},{"title":"Resource","href":"/api-reference/core/models/resource"},{"title":"Extra Identifier","href":"/api-reference/core/models/extra-identifier"}]},{"title":"List Parties","deprecated":null,"version":null,"openapi":"/openapi.json get /core/v1/parties","href":"/api-reference/list-parties"},{"title":"List Bidding Zones","deprecated":null,"version":null,"openapi":"/openapi.json get /core/v1/bidding-zones","href":"/api-reference/list-bidding-zones"},{"title":"List Scheduling Areas","deprecated":null,"version":null,"openapi":"/openapi.json get /core/v1/scheduling-areas","href":"/api-reference/list-scheduling-areas"},{"title":"List Control Areas","deprecated":null,"version":null,"openapi":"/openapi.json get /core/v1/control-areas","href":"/api-reference/list-control-areas"},{"title":"List Metering Grid Areas","deprecated":null,"version":null,"openapi":"/openapi.json get /core/v1/metering-grid-areas","href":"/api-reference/list-metering-grid-areas"},{"title":"Get Geodata","deprecated":null,"version":null,"openapi":"/openapi.json get /core/v1/geo","href":"/api-reference/geo/get-geodata"},{"title":"List holidays","openapi":"GET /core/v1/holidays","href":"/api-reference/core/holidays"}]}]},{"group":"Cost of Energy","pages":[{"group":"Tariffs","pages":[{"title":"Cost of Energy API Overview","href":"/api-reference/cost-of-energy/overview"},{"title":"Python SDK","tag":"BETA","href":"/api-reference/cost-of-energy/engratepy"},{"title":"Calculation Pipeline","href":"/api-reference/cost-of-energy/calculation-pipeline"},{"title":"In Optimisation","href":"/api-reference/cost-of-energy/optimisation"},{"group":"Models","icon":"cube","pages":[{"title":"Tariff","href":"/api-reference/cost-of-energy/models/tariff"},{"title":"Tariff Component","href":"/api-reference/cost-of-energy/models/tariff-component"},{"title":"Dataset","href":"/api-reference/cost-of-energy/models/dataset"},{"title":"Unit","href":"/api-reference/cost-of-energy/models/unit"},{"title":"Level","href":"/api-reference/cost-of-energy/models/level"},{"title":"Periodic Amount","href":"/api-reference/cost-of-energy/models/periodic-amount"},{"title":"Resolution","href":"/api-reference/cost-of-energy/models/resolution"}]},{"group":"Functions","icon":"cube","pages":[{"title":"Function","href":"/api-reference/cost-of-energy/functions/overview"},{"title":"Function: Constant","href":"/api-reference/cost-of-energy/functions/constant"},{"title":"Function: Add","href":"/api-reference/cost-of-energy/functions/add"},{"title":"Function: Subtract","href":"/api-reference/cost-of-energy/functions/subtract"},{"title":"Function: Divide","href":"/api-reference/cost-of-energy/functions/divide"},{"title":"Function: Multiply","href":"/api-reference/cost-of-energy/functions/multiply"},{"title":"Function: Aggregate","href":"/api-reference/cost-of-energy/functions/aggregate"},{"title":"Function: Resample","href":"/api-reference/cost-of-energy/functions/resample"},{"title":"Function: Select","href":"/api-reference/cost-of-energy/functions/select"},{"title":"Function: Mask","href":"/api-reference/cost-of-energy/functions/mask"},{"title":"Function: Clip","href":"/api-reference/cost-of-energy/functions/clip"},{"title":"Function: Lookup","href":"/api-reference/cost-of-energy/functions/lookup"}]},{"group":"Conditions","icon":"cube","pages":[{"title":"Conditions","href":"/api-reference/cost-of-energy/conditions/overview"},{"title":"Condition: Month","href":"/api-reference/cost-of-energy/conditions/month"},{"title":"Condition: DayOfWeek","href":"/api-reference/cost-of-energy/conditions/day-of-week"},{"title":"Condition: TimeOfDay","href":"/api-reference/cost-of-energy/conditions/time-of-day"},{"title":"Condition: ExcludeHolidays","href":"/api-reference/cost-of-energy/conditions/exclude-holidays"},{"title":"Condition: And","href":"/api-reference/cost-of-energy/conditions/and"},{"title":"Condition: Or","href":"/api-reference/cost-of-energy/conditions/or"},{"title":"Condition: Not","href":"/api-reference/cost-of-energy/conditions/not"},{"title":"Condition: Highest","href":"/api-reference/cost-of-energy/conditions/highest"},{"title":"Condition: Lowest","href":"/api-reference/cost-of-energy/conditions/lowest"}]},{"title":"List profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /cost-of-energy/v1/profiles","href":"/api-reference/profiles/list-profiles"},{"title":"Get a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /cost-of-energy/v1/profiles/{profile_id}","href":"/api-reference/profiles/get-a-profile"},{"title":"Create a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /cost-of-energy/v1/profiles","href":"/api-reference/profiles/create-a-profile"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/openapi.json put /cost-of-energy/v1/profiles/{profile_id}","href":"/api-reference/profiles/update-a-profile"},{"title":"Delete a profile","deprecated":null,"version":null,"openapi":"/openapi.json delete /cost-of-energy/v1/profiles/{profile_id}","href":"/api-reference/profiles/delete-a-profile"},{"title":"List Datasets","deprecated":null,"version":null,"openapi":"/openapi.json get /cost-of-energy/v1/datasets","href":"/api-reference/list-datasets"},{"title":"List Tariffs","deprecated":null,"version":null,"openapi":"/openapi.json get /cost-of-energy/v1/tariffs","href":"/api-reference/list-tariffs"},{"title":"Get Tariff","deprecated":null,"version":null,"openapi":"/openapi.json get /cost-of-energy/v1/tariffs/{tariff_id}","href":"/api-reference/get-tariff"},{"title":"Calculate Tariff","deprecated":null,"version":null,"openapi":"/openapi.json post /cost-of-energy/v1/calculate","href":"/api-reference/calculate-tariff"},{"title":"Get Simplified Tariff","openapi":"GET /cost-of-energy/v1/tariffs/{tariff_id}/simplified","href":"/api-reference/cost-of-energy/get-simplified-tariff"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product-updates"}]}]},"basePath":"","title":"Aggregate allocation - Engrate Developer Documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}